Skip to main content
GET
Get a master-wallet payout by ID
string
required
The active live API key belonging to the merchant that created the payout.
string
required
The data.payoutId returned when the payout was created. This is not the transactionId or providerReference.
The payout is accessible only to the merchant that created it.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

FossaPay payoutId returned by the create endpoint.

Response

Payout retrieved successfully

status
string
required
Allowed value: "success"
statusCode
enum<integer>
required
Available options:
200,
202
message
string
required
data
object
required