Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Payout

Commit payout transaction

This PUT endpoint is used to commit a previously created payout transaction. <br> Once a payout transaction is created, you can use this endpoint to commit the transaction and initiate the actual payout. <br> To use this endpoint, you need to provide the user_token and payout_token of the payout transaction you want to commit in the URL Path. <br> The response will include a JSON object containing details about the committed payout transaction, including the payout_token, payout_status, pickup_code and possible errors.

put/payout/{user_token}/{payout_token}

Path parameters

user_tokenstring required

Token representing the user to pay out

payout_tokenstring required

Token representing the trsanaction. Retrieved from /payout/{user_token}

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

successful operation

payout_tokenstring uuid required

Token that represents the transaction that was just created.

status'success' | 'failure' | 'addtl_attr_req' | 'ex_rate_expired' | 'nsf' required

Status that indicates whether the transaction was successfully processed. If success, everything was processed correctly. failure indicates a generic error. addtl_attr_req indicates that in order to process this transaction, additional attributes are required to be updated for this customer. ex_rate_expired indicates that the transaction exchange rate has expired and a new transaction has to be created.

pickup_codestring

Code/pin that is required when collecting the money. Should be provided to the recipient to present to payout location.

errorsstring

Description of errors preventing transfer from being injected.

Example response

{
  "payout_token": "123e4567-e89b-12d3-a456-426614174000",
  "pickup_code": "54238173",
  "errors": "Duplicate transfer"
}