Skip to main content
POST
Create payout

Authorizations

Authorization
string
header
required

Use your account's Secret Key as the Bearer token.

Body

application/json
order_id
integer
required

ID of the order to pay out.

Example:

25955

type
enum<string>
required

Payout method type.

Available options:
WALLET,
ACCOUNT,
BANKWIRE
Example:

"WALLET"

wallet_id
integer

Destination wallet ID. Required when type is WALLET.

bankaccount_id
integer

Destination bank account ID. Required for ACCOUNT type.

bankwire_ref
string

Custom reference for bank wire payouts.

Maximum string length: 140
azupay_id
string

AzuPay destination ID. Required for AzuPay payouts.

azupay_type
string

AzuPay account type.

azupay_bsb
string

AzuPay BSB number (Australian bank routing number).

azupay_account
string

AzuPay bank account number.

Response

Payout created

id
integer
self
string
Example:

"/2.0/payouts/789"

reference
string | null
type
string

Payout method type (e.g. WALLET, ACCOUNT, BANKWIRE).

status
enum<string>
Available options:
CREATED,
CONFIRMED,
DENIED,
CANCELLED
provider
object | null
created_at
string<date-time> | null
confirmed_at
string<date-time> | null
denied_at
string<date-time> | null
connections
object

Hypermedia links to related resources.