Sign in

v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB
Payouts

Cancel a Payout Request

post/api/payouts/payout/{id}/cancel

Path parameters

idstring uuid required

Payout request ID

Headers

on-behalf-ofstring

Organization ID to act on behalf of

idempotency-keystring uuid

Optional UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an idempotency-replayed: true response header. Keys expire after 24 hours.

transfer-api-keystring required

Transfer API key required to execute this request.

Response

Canceled payout request.

createdAtstring date-time required
idstring uuid required
memostring
sourceAccountIdstring uuid required
status'AWAITING_EXECUTION' | 'CANCELED' | 'PENDING' | 'EXECUTED' | 'FAILED' required

DEPRECATED: use statusV2 instead. The status of the overall payout request. The initial status is AWAITING_EXECUTION, and the status will change to PENDING. EXECUTED, FAILED, and CANCELED are terminal statuses. EXECUTED indicates the blockchain transaction associated with the entire payout has been executed, but that does not mean your recipients have received funds. Check the individual recipientsPayoutDetails for the status of each recipient.

transactionHashstring

The transaction hash of the blockchain transaction. Present when the status is EXECUTED.

updatedAtstring date-time required

Example response

{
  "payouts": [
    {
      "amount": {
        "tokenSymbol": "USDC"
      },
      "details": {
        "feeTotal": {
          "tokenSymbol": "USDC"
        },
        "fiatAmount": {
          "fiatCurrencyCode": "USD"
        },
        "transactionFee": {
          "tokenSymbol": "USDC"
        }
      },
      "recipientInfo": {
        "details": {
          "details": {
            "truncatedBankAccountNumber": "****1234"
          }
        }
      }
    }
  ]
}