Skip to main content
POST
/
payouts
Create payout
curl --request POST \
  --url https://api.truust.io/2.0/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": 25955,
  "type": "WALLET",
  "wallet_id": 28751
}
'
{
  "id": 123,
  "self": "/2.0/payouts/789",
  "reference": "<string>",
  "type": "<string>",
  "status": "CREATED",
  "provider": {},
  "created_at": "2023-11-07T05:31:56Z",
  "confirmed_at": "2023-11-07T05:31:56Z",
  "denied_at": "2023-11-07T05:31:56Z",
  "connections": {}
}

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
​
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.