Get All Transactions

POST 
/api/v2/transactions/list

Get All Transactions

Request

application/json

Body

required

limit Limitrequired

Maximum number of records to return.

offset Offsetrequired

The offset from where to start fetching transactions.

filters object

textFilter Textfilter

Full text search.

types TransactionOperation[]

Possible values: [TOP_UP, WITHDRAWAL, TRANSFER, CARD_PAYMENT]

Filter by transaction type.

statuses TransactionStatus[]

Possible values: [PENDING, DECLINE, SUCCESS, REVERSAL, PARTIAL_REVERSAL, REFUND, INCOMING]

Filter by transaction statuses.

userIds uuid[]

Filter by user ids.

createdAtFrom date-time

Default value: 1970-01-01T00:00:00Z

Filter by the starting date (inclusive), filter is applied to createdAt field (Transaction scheme).

createdAtTo date-time

Default value: 2024-05-06T06:27:50Z

Filter by the ending date (inclusive), filter is applied to createdAt field (Transaction scheme).

sortBy object
Fields to sort the results by.
anyOf
MOD1
Array [
string
]
MOD2
Array [
string
]
orderBy SortOrder[]

Possible values: [ASC, DESC]

Order of sorting (ascending/descending).

Responses

200

Successful Response

application/json

Schema

Schema

items object[]required
Array of transaction objects.
Array [
id uuidrequired
The unique identifier of the transaction.
userId uuidrequired
The unique identifier of the user who initiated the transaction.
createdAt date-timerequired
Date and time when the transaction was created.
type object
An enumeration.
amount Amountrequired
The amount of the transaction, represented as a precise decimal value.
currencyCode Currencycoderequired
The currency code representing the currency of the transaction, such as USD, EUR, USDT, etc.
status object
An enumeration.
direction object
An enumeration.
details object
The direction of the transaction amount, indicating whether it's incoming, outgoing, or neutral.
anyOf
TopUpCryptoTransactionDetails
type object
An enumeration.
address Addressrequired
The crypto address to which the top-up was made.
transactionHash Transactionhashrequired
The transaction hash of the top-up.
currencyCode Currencycoderequired
The currency code of the cryptocurrency used in the transaction.
statusChangeReason Statuschangereasonrequired
The reason for any status changes in the transaction.
BankCardTransactionDetails
feeAmount Feeamountrequired
The fee amount charged for the transaction, if any.
merchantName Merchantnamerequired
The name of the merchant involved in the transaction.
bin object
code Coderequired
BIN code
countryCode Countrycoderequired
ISO country code
currencyCode Currencycoderequired
ISO currency code
provider PaymentSchemerequired
Possible values: [Visa, MasterCard]
Enum representing the provider type.
billingAddress Billingaddressrequired
Billing address of the bank card.
paymentServices PaymentService[]
Possible values: [APPLE_PAY, GOOGLE_PAY, SAMSUNG_PAY]
List of supported tokenized payment services. If the list is empty, the BIN doesn't support tokenization.
merchants string[]
purposes BinPurposeEnum[]
Possible values: [CARDS_VIRTUAL, SHARED_BALANCE_VIRTUAL_CARDS]
fees objectrequired
issue objectrequired
feeAmount Feeamountrequired
unit Unitrequired
authorization object[]
Array [
minAmount Minamountrequired
maxAmount Maxamount
feeAmount Feeamountrequired
unit Unit
Default value: USD
]
decline objectrequired
feeAmount Feeamountrequired
unit Unitrequired
zeroAuth objectrequired
feeAmount Feeamountrequired
unit Unitrequired
maskedPan Maskedpanrequired
The partially masked PAN (Primary Account Number) of the bank card.
cardName Cardnamerequired
The name or alias of the bank card used in the transaction.
]
totalCount Totalcountrequired

Total number of transactions corresponding to the filters.

Example (from schema)

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2024-05-09T10:22:47.724Z",
      "type": "TOP_UP",
      "amount": 0,
      "currencyCode": "string",
      "status": "PENDING",
      "direction": "OUTGOING",
      "details": {}
    }
  ],
  "totalCount": 0
}

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
MOD1
string
MOD2
integer
]
msg Messagerequired
type Error Typerequired
]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...