Create a payment route

curl --request POST \
  --url https://api.sandbox.wayex.com/v1/payment-routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "<string>",
  "direction": "aud_to_stablecoin",
  "destination": {
    "address": "<string>"
  },
  "limits": {
    "min": "<string>",
    "max": "<string>",
    "daily": "<string>"
  },
  "metadata": {}
}
'

import requests

url = "https://api.sandbox.wayex.com/v1/payment-routes"

payload = {
    "customerId": "<string>",
    "direction": "aud_to_stablecoin",
    "destination": { "address": "<string>" },
    "limits": {
        "min": "<string>",
        "max": "<string>",
        "daily": "<string>"
    },
    "metadata": {}
}
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({
    customerId: '<string>',
    direction: 'aud_to_stablecoin',
    destination: {address: '<string>'},
    limits: {min: '<string>', max: '<string>', daily: '<string>'},
    metadata: {}
  })
};

fetch('https://api.sandbox.wayex.com/v1/payment-routes', 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/payment-routes",
  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([
    'customerId' => '<string>',
    'direction' => 'aud_to_stablecoin',
    'destination' => [
        'address' => '<string>'
    ],
    'limits' => [
        'min' => '<string>',
        'max' => '<string>',
        'daily' => '<string>'
    ],
    'metadata' => [
        
    ]
  ]),
  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/payment-routes"

	payload := strings.NewReader("{\n  \"customerId\": \"<string>\",\n  \"direction\": \"aud_to_stablecoin\",\n  \"destination\": {\n    \"address\": \"<string>\"\n  },\n  \"limits\": {\n    \"min\": \"<string>\",\n    \"max\": \"<string>\",\n    \"daily\": \"<string>\"\n  },\n  \"metadata\": {}\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/payment-routes")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"<string>\",\n  \"direction\": \"aud_to_stablecoin\",\n  \"destination\": {\n    \"address\": \"<string>\"\n  },\n  \"limits\": {\n    \"min\": \"<string>\",\n    \"max\": \"<string>\",\n    \"daily\": \"<string>\"\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wayex.com/v1/payment-routes")

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  \"customerId\": \"<string>\",\n  \"direction\": \"aud_to_stablecoin\",\n  \"destination\": {\n    \"address\": \"<string>\"\n  },\n  \"limits\": {\n    \"min\": \"<string>\",\n    \"max\": \"<string>\",\n    \"daily\": \"<string>\"\n  },\n  \"metadata\": {}\n}"

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

{
  "id": "<string>",
  "counterpartyId": "<string>",
  "customerId": "<string>",
  "direction": "aud_to_stablecoin",
  "destination": {
    "address": "<string>"
  },
  "instructions": {
    "title": "<string>",
    "reference": "<string>",
    "deposit": {
      "kind": "aud",
      "bsb": "<string>",
      "accountNumber": "<string>",
      "reference": "<string>",
      "payId": {
        "value": "<string>"
      }
    },
    "destinationSummary": "<string>",
    "steps": [
      "<string>"
    ],
    "limits": {
      "min": "<string>",
      "max": "<string>",
      "daily": "<string>"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "limits": {
    "min": "<string>",
    "max": "<string>",
    "daily": "<string>"
  }
}

POST

payment-routes

Create a payment route

curl --request POST \
  --url https://api.sandbox.wayex.com/v1/payment-routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "<string>",
  "direction": "aud_to_stablecoin",
  "destination": {
    "address": "<string>"
  },
  "limits": {
    "min": "<string>",
    "max": "<string>",
    "daily": "<string>"
  },
  "metadata": {}
}
'

import requests

url = "https://api.sandbox.wayex.com/v1/payment-routes"

payload = {
    "customerId": "<string>",
    "direction": "aud_to_stablecoin",
    "destination": { "address": "<string>" },
    "limits": {
        "min": "<string>",
        "max": "<string>",
        "daily": "<string>"
    },
    "metadata": {}
}
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({
    customerId: '<string>',
    direction: 'aud_to_stablecoin',
    destination: {address: '<string>'},
    limits: {min: '<string>', max: '<string>', daily: '<string>'},
    metadata: {}
  })
};

fetch('https://api.sandbox.wayex.com/v1/payment-routes', 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/payment-routes",
  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([
    'customerId' => '<string>',
    'direction' => 'aud_to_stablecoin',
    'destination' => [
        'address' => '<string>'
    ],
    'limits' => [
        'min' => '<string>',
        'max' => '<string>',
        'daily' => '<string>'
    ],
    'metadata' => [
        
    ]
  ]),
  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/payment-routes"

	payload := strings.NewReader("{\n  \"customerId\": \"<string>\",\n  \"direction\": \"aud_to_stablecoin\",\n  \"destination\": {\n    \"address\": \"<string>\"\n  },\n  \"limits\": {\n    \"min\": \"<string>\",\n    \"max\": \"<string>\",\n    \"daily\": \"<string>\"\n  },\n  \"metadata\": {}\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/payment-routes")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"<string>\",\n  \"direction\": \"aud_to_stablecoin\",\n  \"destination\": {\n    \"address\": \"<string>\"\n  },\n  \"limits\": {\n    \"min\": \"<string>\",\n    \"max\": \"<string>\",\n    \"daily\": \"<string>\"\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wayex.com/v1/payment-routes")

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  \"customerId\": \"<string>\",\n  \"direction\": \"aud_to_stablecoin\",\n  \"destination\": {\n    \"address\": \"<string>\"\n  },\n  \"limits\": {\n    \"min\": \"<string>\",\n    \"max\": \"<string>\",\n    \"daily\": \"<string>\"\n  },\n  \"metadata\": {}\n}"

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

{
  "id": "<string>",
  "counterpartyId": "<string>",
  "customerId": "<string>",
  "direction": "aud_to_stablecoin",
  "destination": {
    "address": "<string>"
  },
  "instructions": {
    "title": "<string>",
    "reference": "<string>",
    "deposit": {
      "kind": "aud",
      "bsb": "<string>",
      "accountNumber": "<string>",
      "reference": "<string>",
      "payId": {
        "value": "<string>"
      }
    },
    "destinationSummary": "<string>",
    "steps": [
      "<string>"
    ],
    "limits": {
      "min": "<string>",
      "max": "<string>",
      "daily": "<string>"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "limits": {
    "min": "<string>",
    "max": "<string>",
    "daily": "<string>"
  }
}

What this endpoint does

Creates a standing on-ramp or off-ramp route and provisions its reusable funding instructions.

When to use it

Use it after the customer has the required approved entitlement and you know the delivery destination and route limits.

Before you call

Use a secret API key with route write access. The customer must belong to this tenant account and be eligible for the requested route.

Money and balance effect

Creating the route does not move money. A later funding event starts a transfer and may convert and deliver funds.

States and completion

Creation returns the route, not a completed transfer. Monitor transfers created when the route receives funding.

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 Payment routes 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

Option 1
Option 2

customerId

string

required

The verified customer this route belongs to.

Minimum string length: 1

direction

enum<string>

required

The customer funds AUD and receives stablecoin at the destination address.

Available options:

aud_to_stablecoin

destination

object

required

Where the converted stablecoin is delivered.

Show child attributes

limits

object

Optional per-route min/max/daily limits; a deposit outside them is held, not converted.

Show child attributes

metadata

object

Show child attributes

Response

The created payment route with deposit instructions.

Option 1
Option 2

string

required

Minimum string length: 1

counterpartyId

string

required

The client account (counterparty) this route belongs to. For API callers this is always your own account id.

Minimum string length: 1

customerId

string

required

Minimum string length: 1

direction

enum<string>

required

Available options:

aud_to_stablecoin

destination

object

required

Show child attributes

status

enum<string>

required

Available options:

active,

inactive

instructions

object

required

Show child attributes

createdAt

string<date-time>

required

limits

object

Show child attributes

List recent activity List payment routes

​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