Skip to main content

ListTransactions

nextPage object

Next page value in base-64

oneOf
null
transactions object[]required

Transactions

Possible values: <= 2147483647

  • Array [
  • categoryInternalTransactionCategory (string)required

    Transaction category

    Possible values: [CARD_PAYMENT, SAVINGS, INTERNAL_TRANSFER, ATM, EXTERNAL_TRANSFER, OTHER]

    counterparty objectrequired

    Info on entity to which funds are moving

    account object
    oneOf
    null
    acquiring object
    oneOf
    null
    amount objectrequired

    Total amount for this part

    amountstringrequired

    The amount of money. Example: 1000.12

    Possible values: non-empty and <= 2147483647 characters

    currencystringrequired

    The currency of the money. Example: 'USD'

    Possible values: non-empty and <= 10 characters

    amountWithoutFee object
    oneOf
    null
    atm object
    oneOf
    null
    beneficiary object
    oneOf
    null
    card object
    oneOf
    null
    company object
    oneOf
    null
    crypto object
    oneOf
    null
    customer object
    oneOf
    null
    fees object

    Applied fees

    oneOf
    null
    goal object
    oneOf
    null
    mcc object
    oneOf
    null
    merchant object
    oneOf
    null
    payer object
    oneOf
    null
    totalFee object
    oneOf
    null
    typeTransactionPartType (string)required

    Type of entity involved in transaction

    Possible values: [CUSTOMER, COMPANY, VAULT, MERCHANT, BENEFICIARY, ATM, ACQUIRING, PAYER]

    vault object
    oneOf
    null
    date objectrequired

    Time info on transaction states

    createdstring<Instant>required
    processed object
    oneOf
    null
    settled object
    oneOf
    null
    startedstring<Instant>required
    updatedstring<Instant>required
    description object

    Transaction reference

    oneOf
    null
    directionTransactionDirection (string)required

    Direction of funds moving

    Possible values: [IN, OUT]

    fx object
    oneOf
    null
    idstring<uuid>required

    Transaction id

    Possible values: <= 2147483647 characters

    origin objectrequired

    Info on entity from which funds are moving

    account object
    oneOf
    null
    acquiring object
    oneOf
    null
    amount objectrequired

    Total amount for this part

    amountstringrequired

    The amount of money. Example: 1000.12

    Possible values: non-empty and <= 2147483647 characters

    currencystringrequired

    The currency of the money. Example: 'USD'

    Possible values: non-empty and <= 10 characters

    amountWithoutFee object
    oneOf
    null
    atm object
    oneOf
    null
    beneficiary object
    oneOf
    null
    card object
    oneOf
    null
    company object
    oneOf
    null
    crypto object
    oneOf
    null
    customer object
    oneOf
    null
    fees object

    Applied fees

    oneOf
    null
    goal object
    oneOf
    null
    mcc object
    oneOf
    null
    merchant object
    oneOf
    null
    payer object
    oneOf
    null
    totalFee object
    oneOf
    null
    typeTransactionPartType (string)required

    Type of entity involved in transaction

    Possible values: [CUSTOMER, COMPANY, VAULT, MERCHANT, BENEFICIARY, ATM, ACQUIRING, PAYER]

    vault object
    oneOf
    null
    stateTransactionState (string)required

    Transaction status

    Possible values: [PENDING, COMPLETED, FAILED]

    statusReason object

    Transaction status explanation

    oneOf
    null
    subtype object

    Subtype of transaction type. E.g. CARD_REFUND, VAULT_WITHDRAWAL, etc

    oneOf
    null
    typeTransactionType (string)required

    Transaction type

    Possible values: [CARD_ATM_WITHDRAWAL, CARD_ATM_DEPOSIT, CARD_PAYMENT, CARD_DEPOSIT, CARD_ACQUIRING, OWN_TRANSFER, INTERNAL_TRANSFER, EXTERNAL_OUTGOING_TRANSFER, EXTERNAL_INCOMING_TRANSFER, INTERNAL_OUTGOING_TRANSFER, INTERNAL_INCOMING_TRANSFER, REWARD, CASHBACK, FEE, REFUND]

  • ]
  • ListTransactions
    {
    "nextPage": "null",
    "transactions": [
    {
    "category": "CARD_PAYMENT",
    "counterparty": {
    "account": "null",
    "acquiring": "null",
    "amount": {
    "amount": "string",
    "currency": "string"
    },
    "amountWithoutFee": "null",
    "atm": "null",
    "beneficiary": "null",
    "card": "null",
    "company": "null",
    "crypto": "null",
    "customer": "null",
    "fees": "null",
    "goal": "null",
    "mcc": "null",
    "merchant": "null",
    "payer": "null",
    "totalFee": "null",
    "type": "CUSTOMER",
    "vault": "null"
    },
    "date": {
    "created": "string",
    "processed": "null",
    "settled": "null",
    "started": "string",
    "updated": "string"
    },
    "description": "null",
    "direction": "IN",
    "fx": "null",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "origin": {
    "account": "null",
    "acquiring": "null",
    "amount": {
    "amount": "string",
    "currency": "string"
    },
    "amountWithoutFee": "null",
    "atm": "null",
    "beneficiary": "null",
    "card": "null",
    "company": "null",
    "crypto": "null",
    "customer": "null",
    "fees": "null",
    "goal": "null",
    "mcc": "null",
    "merchant": "null",
    "payer": "null",
    "totalFee": "null",
    "type": "CUSTOMER",
    "vault": "null"
    },
    "state": "PENDING",
    "statusReason": "null",
    "subtype": "null",
    "type": "CARD_ATM_WITHDRAWAL"
    }
    ]
    }