Payout completeWebhook

Request
Security:
Request Body schema: application/json
payout_status_id
string <UUID4>

A UUID for the payout.

payout_status
string

The current status of the payout request. One of the following values:

Value Description
ESCROW-TRANSFER-FAILED The transfer of funds to escrow failed. The money is still in the user's USD wallet.
FUNDS-IN-ESCROW User's funds are now in escrow. The payout is in an executable state.
FAILED The payout has failed. The user's money is still in escrow.
SUCCESS The payout was successful.
USER-REVERSE-FAILED The transfer of funds from escrow to the user's USD wallet has failed. The user's money is still in escrow.
USER-REVERSED User's request to reverse the payout was successful. The user's money is returned to their USD wallet.
SUPPORT-REJECT-FAILED Support requested reversal failed. The user's money is still in escrow.
SUPPORT-REJECTED Support requested reversal succeeded. The user's money is returned to their USD wallet.
failure_reason
string

The reason why the payout failed

Responses
2XX

Return a 2XX status to indicate that the data was received successfully

Request samples
application/json
{
  • "payout_status_id": "65d6c272-d593-405d-986c-a70b587e281f",
  • "payout_status": "FAILED",
  • "failure_reason": "The wallet does not have enough funds to complete the transaction"
}