v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB

User

Transactions history

This GET endpoint is used to retrieve a list of all transactions, including payouts, loads, and spendbacks, for a provided user with the provided user token. <br> You can use this endpoint to obtain a comprehensive history of transactions for the provider user, allowing you to track and analyze their payment activities over time. <br> To use this endpoint, you need to provide the user_token as a parameter in the URL Path. <br> The response will contain a JSON array of transaction objects, each including transactions details.

get/payout/user/{user_token}/transactions

Query parameters

number_of_recordsnumber

Number of records to return. Defaults to 10 if no value is provided

start_datestring date

Example:2020-03-31

Starting date

end_datestring date

Example:2020-03-31

Ending date

pageinteger

Page number

type'payout' | 'load' | 'spendback' | 'payin'

Example:payout

Filter particular types of transactions. Comma separated to include multiple types

wallet_tokenstring uuid

Filter transactions to include only provided wallet token.

show_all_clientsboolean

Whether to show transactions from all clients

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

Succesful operation.

Example response

{
  "transactions": [
    {
      "token": "123e4567-e89b-12d3-a456-426614174000",
      "type": "payout",
      "source_amount": 50.1,
      "source_currency_code": "USD",
      "destination_amount": 44.99,
      "fee": 2.98,
      "status": "READY_FOR_PICKUP",
      "notes": "Purchase of Candles. Order #14930",
      "payer_name": "Elektra",
      "pickup_code": "343432",
      "source_token": "123e4567-e89b-12d3-a456-426614174000",
      "destination_token": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}