Retrieve a payout
Retrieve the details of a payout. Provide the unique payout ID, and the corresponding payout information is returned.
Request
The ID of the Payout object.
Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"
This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.
It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.
For more information, see: Authentication
Possible values: [2023-09-01, 2024-05-01, 2024-09-01]
Example: "2024-09-01"
The version of the Merchant API, specified in YYYY-MM-DD format.
If not specified, you will receive an error.
For more information about API versioning, see: API versions.
Response
Payout retrieved
Permanent payout ID used for payouts operations.
Possible values: [processing, completed, failed]
The state of the payout.
The date and time the payout was created.
Possible values: [current_pocket, external_beneficiary]
The destination of the payout funds when a merchant initiates a withdrawal from their merchant account.
| Destination type | Description |
|---|---|
current_pocket | The funds were moved from the merchant account to the business account within the platform. This indicates an internal transfer, allowing the merchant to access the funds within their own business account. |
external_beneficiary | The funds were transferred to an external bank account or beneficiary outside the platform. This indicates a transfer to an external account, enabling the merchant to withdraw funds to external financial institutions. |
Possible values: >= 1
The total amount of the payout in minor currency units. For example, 7034 represents €70.34.
Possible length: >= 3 characters and <= 3 characters
ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.