Create an AUD payout

curl --request POST \
  --url https://api.sandbox.wayex.com/v1/treasury/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "beneficiaryId": "<string>",
  "amount": "<string>",
  "currency": "AUD",
  "externalReference": "<string>",
  "purpose": "<string>",
  "walletProviderReference": "<string>",
  "downstreamMerchantReference": "<string>",
  "evidenceId": "<string>"
}
'

import requests

url = "https://api.sandbox.wayex.com/v1/treasury/payouts"

payload = {
    "beneficiaryId": "<string>",
    "amount": "<string>",
    "currency": "AUD",
    "externalReference": "<string>",
    "purpose": "<string>",
    "walletProviderReference": "<string>",
    "downstreamMerchantReference": "<string>",
    "evidenceId": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    beneficiaryId: '<string>',
    amount: '<string>',
    currency: 'AUD',
    externalReference: '<string>',
    purpose: '<string>',
    walletProviderReference: '<string>',
    downstreamMerchantReference: '<string>',
    evidenceId: '<string>'
  })
};

fetch('https://api.sandbox.wayex.com/v1/treasury/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.wayex.com/v1/treasury/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'beneficiaryId' => '<string>',
    'amount' => '<string>',
    'currency' => 'AUD',
    'externalReference' => '<string>',
    'purpose' => '<string>',
    'walletProviderReference' => '<string>',
    'downstreamMerchantReference' => '<string>',
    'evidenceId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.wayex.com/v1/treasury/payouts"

	payload := strings.NewReader("{\n  \"beneficiaryId\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"AUD\",\n  \"externalReference\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"walletProviderReference\": \"<string>\",\n  \"downstreamMerchantReference\": \"<string>\",\n  \"evidenceId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.wayex.com/v1/treasury/payouts")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"beneficiaryId\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"AUD\",\n  \"externalReference\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"walletProviderReference\": \"<string>\",\n  \"downstreamMerchantReference\": \"<string>\",\n  \"evidenceId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wayex.com/v1/treasury/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"beneficiaryId\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"AUD\",\n  \"externalReference\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"walletProviderReference\": \"<string>\",\n  \"downstreamMerchantReference\": \"<string>\",\n  \"evidenceId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "clientId": "<string>",
  "beneficiaryId": "<string>",
  "amount": {
    "amount": "<string>"
  },
  "fee": {
    "amount": "<string>"
  },
  "sourceDebit": {
    "amount": "<string>"
  },
  "configurationId": "<string>",
  "externalReference": "<string>",
  "purpose": "<string>",
  "reservation": {
    "amount": {
      "amount": "<string>"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "walletProviderReference": "<string>",
  "downstreamMerchantReference": "<string>",
  "evidenceId": "<string>",
  "providerReference": "<string>",
  "statusReason": "<string>"
}

POST

treasury

payouts

Create an AUD payout

curl --request POST \
  --url https://api.sandbox.wayex.com/v1/treasury/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "beneficiaryId": "<string>",
  "amount": "<string>",
  "currency": "AUD",
  "externalReference": "<string>",
  "purpose": "<string>",
  "walletProviderReference": "<string>",
  "downstreamMerchantReference": "<string>",
  "evidenceId": "<string>"
}
'

import requests

url = "https://api.sandbox.wayex.com/v1/treasury/payouts"

payload = {
    "beneficiaryId": "<string>",
    "amount": "<string>",
    "currency": "AUD",
    "externalReference": "<string>",
    "purpose": "<string>",
    "walletProviderReference": "<string>",
    "downstreamMerchantReference": "<string>",
    "evidenceId": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    beneficiaryId: '<string>',
    amount: '<string>',
    currency: 'AUD',
    externalReference: '<string>',
    purpose: '<string>',
    walletProviderReference: '<string>',
    downstreamMerchantReference: '<string>',
    evidenceId: '<string>'
  })
};

fetch('https://api.sandbox.wayex.com/v1/treasury/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.wayex.com/v1/treasury/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'beneficiaryId' => '<string>',
    'amount' => '<string>',
    'currency' => 'AUD',
    'externalReference' => '<string>',
    'purpose' => '<string>',
    'walletProviderReference' => '<string>',
    'downstreamMerchantReference' => '<string>',
    'evidenceId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.wayex.com/v1/treasury/payouts"

	payload := strings.NewReader("{\n  \"beneficiaryId\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"AUD\",\n  \"externalReference\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"walletProviderReference\": \"<string>\",\n  \"downstreamMerchantReference\": \"<string>\",\n  \"evidenceId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.wayex.com/v1/treasury/payouts")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"beneficiaryId\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"AUD\",\n  \"externalReference\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"walletProviderReference\": \"<string>\",\n  \"downstreamMerchantReference\": \"<string>\",\n  \"evidenceId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wayex.com/v1/treasury/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"beneficiaryId\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"AUD\",\n  \"externalReference\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"walletProviderReference\": \"<string>\",\n  \"downstreamMerchantReference\": \"<string>\",\n  \"evidenceId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "clientId": "<string>",
  "beneficiaryId": "<string>",
  "amount": {
    "amount": "<string>"
  },
  "fee": {
    "amount": "<string>"
  },
  "sourceDebit": {
    "amount": "<string>"
  },
  "configurationId": "<string>",
  "externalReference": "<string>",
  "purpose": "<string>",
  "reservation": {
    "amount": {
      "amount": "<string>"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "walletProviderReference": "<string>",
  "downstreamMerchantReference": "<string>",
  "evidenceId": "<string>",
  "providerReference": "<string>",
  "statusReason": "<string>"
}

What this endpoint does

Creates an AUD payout to a saved beneficiary and durably reserves its source debit from this tenant account’s AUD wallet.

When to use it

Submit it after choosing the beneficiary, confirming the amount and purpose, and reviewing the effective fee and available balance.

Before you call

Use a secret API key with treasury:write. The beneficiary, its accepted evidence when required, limits, BSB/account rail, and wallet balance must all be eligible. Sumsub share tokens are submitted with beneficiary creation, not here.

Money and balance effect

On acceptance, the payout source debit is reserved so it cannot be spent twice. Settlement captures the reservation; a proven pre-settlement failure releases it, while returns follow the configured return policy.

States and completion

accepted means policy passed and funds are reserved. held needs review; submitted reached the bank rail; settled, failed, and returned describe later outcomes.

Safe retries

Send a unique Idempotency-Key for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out. Read Beneficiaries and payouts for the complete workflow.

Authorizations

Authorization

string

header

required

Send the same Wayex API key as Authorization: Bearer <key>.

Headers

Idempotency-Key

string

required

A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.

Required string length: 8 - 255

Body

application/json

beneficiaryId

string

required

Minimum string length: 1

amount

string

required

Pattern: ^\d+(\.\d+)?$

currency

enum<string>

required

Available options:

AUD

externalReference

string

required

Minimum string length: 1

purpose

string

required

Required string length: 1 - 255

walletProviderReference

string

Minimum string length: 1

downstreamMerchantReference

string

Minimum string length: 1

evidenceId

string

Minimum string length: 1

Response

201 - application/json

string

required

Minimum string length: 1

clientId

string

required

Minimum string length: 1

beneficiaryId

string

required

Minimum string length: 1

amount

object

required

Show child attributes

fee

object

required

Show child attributes

sourceDebit

object

required

Show child attributes

status

enum<string>

required

Available options:

accepted,

held,

submitted,

settled,

failed,

returned

configurationId

string

required

Minimum string length: 1

externalReference

string

required

Minimum string length: 1

purpose

string

required

Required string length: 1 - 255

reservation

object

required

Show child attributes

nextAction

enum<string>

required

Available options:

none,

wait_for_settlement,

contact_support,

retry_new_request,

review_balance

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

walletProviderReference

string

Minimum string length: 1

downstreamMerchantReference

string

Minimum string length: 1

evidenceId

string

Minimum string length: 1

providerReference

string

Minimum string length: 1

statusReason

string

Minimum string length: 1

Preview a payout Create a conversion quote

​What this endpoint does

​When to use it

​Before you call

​Money and balance effect

​States and completion

​Safe retries

Authorizations

Headers

Body

Response

What this endpoint does

When to use it

Before you call

Money and balance effect

States and completion

Safe retries