PagedAccountTransactionResponse

meta objectrequired

meta data

skipnumber

number of skip records

Default value: 0

Example: 0

limitnumber

number of maximum return records

Default value: 10

Example: 10

totalCountnumberrequired

total number of records

Example: 100

timestampstring<date-time>required

the time of the query result

data object[]required

records

Array [

transactionTypestringrequired

Transaction type. Deprecated values: OPTION CLOSE OUT, DRAWDOWN REPAYMENT

Possible values: [PAYMENT, CONVERSION, DEPOSIT, OPTION CLOSE OUT, DRAWDOWN, DRAWDOWN REPAYMENT, ACCOUNT FEE, TRADE CLOSE OUT, TRANSFER]

Example: PAYMENT

currencyCodestringrequired

Three-letter currency code

Example: AUD

clientIdstring

Client ID that the queried transactions belongs to

Possible values: >= 36 characters and <= 36 characters

Example: 401f4647-8372-495f-8de0-aafb3e1eaf93

amountnumberrequired

Transaction Amount,can be positive or negative

Example: 100

balancenumberrequired

Balance after transaction

Example: 500

relatedTransactionIdstringrequired

Related transaction ID(CAPAY unique reference id)

Example: related-transaction-id

relatedTransactionReferenceNostringrequired

Reference number of the related transaction(CAPAY unique reference number)

Example: 20251212-PEDT4D

referenceIdobjectnullable

External reference ID provided by the API user for idempotency

Possible values: <= 36 characters

Example: trxid-12345

transactionTimestringrequired

Transaction time, ISO 8601 format, indicates when the balance was updated

Example: 2024-01-01T00:00:00Z

]

PagedAccountTransactionResponse

{
  "meta": {
    "skip": 0,
    "limit": 10,
    "totalCount": 100,
    "timestamp": "2024-07-29T15:51:28.071Z"
  },
  "data": [
    {
      "transactionType": "PAYMENT",
      "currencyCode": "AUD",
      "clientId": "401f4647-8372-495f-8de0-aafb3e1eaf93",
      "amount": 100,
      "balance": 500,
      "relatedTransactionId": "related-transaction-id",
      "relatedTransactionReferenceNo": "20251212-PEDT4D",
      "referenceId": "trxid-12345",
      "transactionTime": "2024-01-01T00:00:00Z"
    }
  ]
}