POST /api/v1/payouts/getPayoutStatus

POST /api/v1/payouts/getPayoutStatus

Headers

{ "data": "<encrypted blob of the payload below>" }

Decrypted payload:

Field	Type	Required	Notes
`transaction_id`	string	yes	The `transaction_id` you received from `sendPayoutRequest`. Live IDs are UUIDs; sandbox IDs start with `sb_`.

All examples assume you’ve already encrypted the body and signed the request — see the Quickstart for the full helper in Node and Python.

const status = await call(
  '/api/v1/payouts/getPayoutStatus',
  { transaction_id: '029b2038-6166-4bea-80a9-f1a2425a85eb' },
  jwt,
)

{
  "ok": true,
  "data": {
    "transaction_id": "029b2038-6166-4bea-80a9-f1a2425a85eb",
    "status": "completed",
    "status_message": null
  }
}

status is one of:

Value	Meaning
`pending_approval`	Awaiting manual approval
`pending`	Approved and queued for processing
`processing`	Submitted to the payment network, awaiting settlement
`completed`	Payment was successfully delivered
`failed`	Payment could not be delivered
`rejected`	Transaction was rejected before processing
`reversed`	A previously delivered transaction was returned
`canceled`	Transaction was canceled before processing

status_message is non-null only on failed, rejected, reversed, canceled.

transaction_id missing or malformed (must be a UUID or start with sb_).

Bad/missing JWT.

Transaction doesn’t exist or belongs to a different account.

{
  "ok": false,
  "request_id": "01J9F5Z4X7Y3K2B1Q0M8N7V6T5",
  "error": { "code": "not_found", "message": "Transaction not found" }
}

Throttle your polling.

Polling works, but register a Callback URL to stop polling entirely. We POST to you as soon as the transaction reaches a final state.