v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB

Spend Back

Get history of spend backs by user token

This GET endpoint is used to retrieve the history of spendbacks for a specific user token. <br> You can use this endpoint to help manage your payment operations and track the usage of funds by your users. <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 list of all the historical spendbacks for the provided user token. The response will contain a JSON array with details for each spendback transaction.

get/payout/spendback/{user_token}

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

Succesful operation.

spendback_tokenstring required

Token representing the load token

time_of_spendbackstring YYYY-MM-DDThh:mm:ss required

The timestamp the spend back was created in the system. Using UTC timestamp.ISO 8601

client_spendback_idstring required

A client defined spend back identifier. This is the unique ID assigned to the spend back 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

metadataobject

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

Example response

[
  {
    "spendback_token": "spnd_bk_4275f2-bae1-488d-9d6f-20af1cd83574",
    "time_of_spendback": "2019-07-07T23:03:05",
    "client_spendback_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",
    "metadata": {
      "group_id": 541
    }
  }
]