Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Load

Initiate a load transaction

This POST endpoint is used to initiate a load transaction, allowing you to add funds to a user token's wallet. <br> To use this endpoint, you need to provide the user_token as a parameter in the URL Path. You also need to provide the client_load_id, source_token, and amount as JSON parameters in the Request Body. The client_load_id is a unique identifier for the transaction that you can use to track it, while the source_token is the token or account from which the funds will be loaded. The amount parameter specifies the amount of funds to be loaded into the user's wallet. <br> The response will contain a JSON object indicating the status of the load transaction and any relevant details.

post/payout/load/{user_token}

Path parameters

user_tokenstring required

Token representing the user to load

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Request body

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

amountnumber required

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

source_currency_codestring

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. There is a special currency case for PNTS - learn more [here] (#Points)

notesstring

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

notify_userboolean

Should we notify the user via email that they've received a load? If the user has no existing account, they will receive instructions to establish such account.

time_to_processstring YYYY-MM-DDThh:mm:ss

Future date/time to process the load on. If none is provided, it is processed right away. Time to be provided in UTC ISO 8601

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. There are two special attributes that can be provided in the metadata field: batch_identifier and batch_name. Either of those values, would group transactions in the ledger under the same description.

Example request

{
  "client_load_id": "aEjn345",
  "source_token": "ba4275f2-bae1-488d-9d6f-20af1cd83574",
  "amount": 100.5,
  "source_currency_code": "USD",
  "notes": "Commission payment for July",
  "time_to_process": "The date/time to process the load. In UTC. 2021-02-25T23:00:00Z",
  "metadata": {
    "group_id": 541
  }
}

Response

Successfully created.

load_tokenstring required

Token that represents the load that was just created.

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

Status that indicates whether the transaction was successfully processed. If COMPLETED, the load was successfully processed. CANCELLED indicates a generic error. and SCHEDULED means the load was successfully scheduled

wallet_tokenstring required

The wallet token the load was deposited into

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",
  "wallet_token": "usr_wlt_3ec2d3e7-0aae-47bb-bdb9-d3413c5434d1",
  "metadata": {
    "group_id": 541
  }
}