Payouts

Payout Created

POST

Notifies the status of an outgoing payout.

Allowed Values: PAYOUT_FAILED, PAYOUT_CREATED, PAYOUT_PROCESSING ,PAYOUT_COMPLETED

Body

{
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "messageType": "PAYOUT_CREATED",
  "messageTime": "2023-12-14T01:24:03.102Z",
  "message": {
      "transactionType": "PAYOUT",
      "payoutId":"8657976e-c7ee-4db0-92c0-adb43e2cfde4",
      "status":"PENDING_AUTHORIZATION",
      "beneficiaryAddressId": "39b83120-a80f-4bd9-8469-7d5bcaa055af",
      "beneficiaryId": "bf22f3c9-c5f6-4815-a6a6-9b999612b713",
      "sourceAccountId": "635b8c14-c6a9-4838-b9a1-bc7ddc29a086",
      "sourceQuantity": "3.6725",
      "beneficiaryQuantity": "3.6725",
      "payoutFeeQuantity": "3.6725",
      "netBeneficiaryQuantity": "3.6725",
      "sourceCurrency": "USD",
      "feeCurrency": "USD",
      "beneficiaryCurrency": "USDT",
      "memo": "text",
      "feePaidBy": "MERCHANT",
      "payoutFeeRate": "1",
      "clientReference": "REF-123-E",
      "conversionRate": "1",
      "paymentReason": "Affiliate payout",
      "requestedAt": "2026-02-19T18:44:05Z",
      "expiresAt": "2026-02-19T18:44:05Z",
      "updatedAt": "2026-02-19T18:44:05Z",
      "authorizedAt": "2026-02-19T18:44:05Z",
}

Payout Processing

POST

Notifies that an authorized payout is now being processed for disbursement to the beneficiary.

Allowed Values: PROCESSING

Body

Payout Completed

POST

Notifies that an outgoing payout has successfully settled and been delivered to the beneficiary..

Allowed Values: COMPLETED

Body

Payout Failed

POST

Notifies that an outgoing payout attempt has failed and could not be completed.

Allowed Values: FAILED

Body