Skip to main content
GET
Get payment route funding instructions

What this endpoint does

Returns the reusable bank or blockchain instructions a payer uses to fund one route.

When to use it

Fetch it immediately before displaying or sharing instructions so you show the current values exactly as issued.

Before you call

Authenticate with route read access and pass a route ID owned by the same tenant account.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

Instructions do not prove a payment was received. A funding event creates a transfer that must be tracked separately.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Payment routes for the complete workflow.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Response

The payment route deposit instructions.

title
string
required
Minimum string length: 1
reference
string
required
Minimum string length: 1
deposit
object
required
destinationSummary
string
required
Minimum string length: 1
steps
string[]
required
limits
object