Skip to main content
GET

Params

string
required
The payout ID returned when creating the payout

Response

boolean
Indicates whether the call was successful.
string
The unique payout identifier.
string
The identifier of the user or entity on whose behalf the payout is being made.
string
The company identifier associated with this payout.
string
The current status of the payout. Possible values: created, processing, completed, failed, cancelled.
number
The amount in the source currency.
object
Source payment details
object
Destination payment details. The structure depends on the destination type.
boolean
Whether the amount was deducted from the account balance.
string
The quote ID used for exchange rate calculation (if provided).
string
The ISO 8601 timestamp when the payout was created.
string
The ISO 8601 timestamp when the payout was completed (only present if status is completed).
string
The ISO 8601 timestamp when the payout failed (only present if status is failed).
string
The reason for failure (only present if status is failed).

Error Responses