SumUp · Schema

Transaction History

Transaction entry returned in history listing responses.

PaymentsPoint-of-SaleCard ReaderCheckoutFintechMobile PaymentsOnline Payments

Properties

Name Type Description
transaction_id object
client_transaction_id string Client-specific ID of the transaction.
user string Email address of the registered user (merchant) to whom the payment is made.
type string Type of the transaction for the registered user specified in the `user` property.
card_type object
payout_date string Payout date (if paid out at once).
payout_type string Payout type.
refunded_amount number Total refunded amount.
View JSON Schema on GitHub

JSON Schema

transactionhistory.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Transaction History",
  "description": "Transaction entry returned in history listing responses.",
  "allOf": [
    {
      "$ref": "#/components/schemas/TransactionBase"
    },
    {
      "$ref": "#/components/schemas/TransactionMixinHistory"
    },
    {
      "type": "object",
      "properties": {
        "transaction_id": {
          "$ref": "#/components/schemas/TransactionID"
        },
        "client_transaction_id": {
          "description": "Client-specific ID of the transaction.",
          "type": "string"
        },
        "user": {
          "description": "Email address of the registered user (merchant) to whom the payment is made.",
          "type": "string",
          "format": "email"
        },
        "type": {
          "description": "Type of the transaction for the registered user specified in the `user` property.",
          "type": "string",
          "enum": [
            "PAYMENT",
            "REFUND",
            "CHARGE_BACK"
          ]
        },
        "card_type": {
          "$ref": "#/components/schemas/CardType"
        },
        "payout_date": {
          "description": "Payout date (if paid out at once).",
          "type": "string",
          "format": "date",
          "example": "2019-08-28"
        },
        "payout_type": {
          "description": "Payout type.",
          "type": "string",
          "example": "BANK_ACCOUNT",
          "enum": [
            "BANK_ACCOUNT",
            "PREPAID_CARD"
          ]
        },
        "refunded_amount": {
          "description": "Total refunded amount.",
          "type": "number",
          "format": "decimal",
          "example": 0
        }
      }
    }
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/transactionhistory"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.