Skip to main content
GET
Retrieve Payout by ID
This request enables you to retrieve details of a payout based on their id, which needs to be provided in the request path.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Path Parameters

payout_id
string
required

Response

200

id
string
Example:

"1c58426d-2c1b-4476-b3c0-447a8c683466"

account_id
string
Example:

"f7c5fe77-721b-49c2-84d3-957748df3c2c"

status
string
Example:

"SUCCEEDED"

merchant_reference
string
Example:

"MR-Test-123"

purpose
string
Example:

""

country
string
Example:

"US"

description
string
Example:

"Test"

amount
object
beneficiary
object
metadata
array
created_at
string
Example:

"2024-05-27T15:14:19.012803Z"

updated_at
string
Example:

"2024-05-27T15:14:20.577061Z"

transactions
object[]