Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Load

Get history of loads by user token

This GET endpoint is used to retrieve a transaction history of all loads that were made to the provided user token, including scheduled loads. <br> You can use this endpoint to obtain a comprehensive history of loads for the user token, allowing you to track and analyze their incoming payments over time. <br> To use this endpoint, you need to provide the user_token as a parameter in the URL Path. <br> The endpoint will then return a JSON array of load transactions, each including transactions details.

get/payout/load/{user_token}

Path parameters

user_tokenstring required

The user token that needs to be fetched.

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

Successful operation.

load_tokenstring required

Token representing the load token

time_of_loadstring YYYY-MM-DDThh:mm:ss required

The timestamp the load was processed. If not processed yet, a future date will be returned. Using UTC timestamp.ISO 8601

client_load_idstring required

A client defined load identifier. This is the unique ID assigned to the load on your system. Max 50 characters.

source_tokenstring uuid required

Token that represents the funding source i.e. bank account, wallet. 36 characters long

wallet_tokenstring uuid required

Token that represents the wallet that received the funds. 36 characters long

amountnumber required

The amount to credit the user's wallet in source currency

source_currency_codestring required

The currency originating balance is stored in. Using ISO 4217 format. In most cases this value will be USD, and therefore the defaut value if none is provided

notesstring required

A description for the load. Will be visible to the user receiving the load

status'COMPLETED' | 'CANCELLED' | 'SCHEDULED' required

Status of the load

metadataobject

Optional JSON object with attributes that can later be searched to locate this load. Do not include PII as this object is not encrypted.

Example response

[
  {
    "load_token": "ld_ba4275f2-bae1-488d-9d6f-20af1cd83574",
    "time_of_load": "2019-07-07T23:03:05",
    "client_load_id": "aEjn345",
    "source_token": "123e4567-e89b-12d3-a456-426614174000",
    "wallet_token": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 100.5,
    "source_currency_code": "USD",
    "notes": "Commission payment for July",
    "status": "COMPLETED",
    "metadata": {
      "group_id": 541
    }
  }
]