GET
/
payouts
/
{payout_id}

This endpoint requires the payouts.read scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payout_id
string
required

The ID for the payout to get the information for.

Response

200 - application/json
type
enum<string>

The type of this resource. Is always payout.

Available options:
payout
id
string

The ID of a payout.

merchant_account_id
string | null

The optional ID of the merchant account this payout should be assigned to.

Maximum length: 22
amount
integer

The monetary amount for this payout, in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99.

currency
string

A supported ISO-4217 currency code.

created_at
string

The date and time when this payout was created.

updated_at
string

The date and time when this payout was created.

payment_service
object

The payment service used for this payout.

payment_service_payout_id
string | null

The ID of the payout in the underlying payment service.

category
enum<string>

The type of payout to process.

Available options:
online_gambling
status
enum<string>

The status of the payout.

Available options:
pending,
failed,
declined,
succeeded
external_identifier
string | null

An external identifier that can be used to match the payout against your own records. This value needs to be unique for all buyers.

Required string length: 1 - 200
merchant
object

The merchant details associated to this payout.

buyer
object

The buyer used for this transaction.

payment_method
object

The payment method used for this payout.

Was this page helpful?

Create payoutList refunds