v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB

Payouts

Create payout

Creates a payout to transfer funds from a paid order to the seller. Requires the order to not yet be released. The destination is either a wallet_id or a bankaccount_id.

post/payouts

Request body

order_idinteger required

ID of the order to pay out.

type'WALLET' | 'ACCOUNT' | 'BANKWIRE' required

Payout method type.

wallet_idinteger

Destination wallet ID. Required when type is WALLET.

bankaccount_idinteger

Destination bank account ID. Required for ACCOUNT type.

bankwire_refstring

Custom reference for bank wire payouts.

azupay_idstring

AzuPay destination ID. Required for AzuPay payouts.

azupay_typestring

AzuPay account type.

azupay_bsbstring

AzuPay BSB number (Australian bank routing number).

azupay_accountstring

AzuPay bank account number.

Example request

{
  "order_id": 25955,
  "type": "WALLET",
  "wallet_id": 28751
}

Response

Payout created

idinteger

selfstring

referencestring nullable

typestring

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

status'CREATED' | 'CONFIRMED' | 'DENIED' | 'CANCELLED'

providerobject nullable

created_atstring date-time nullable

confirmed_atstring date-time nullable

denied_atstring date-time nullable

connectionsConnections

Hypermedia links to related resources.

Example response

{
  "self": "/2.0/payouts/789"
}