Skip to main content
PUT
Set a payment route’s client gate

What this endpoint does

Turns the client gate on or off for an AUD-to-stablecoin route. While it is on, each funding of the route waits at awaiting_client_action after screening, before anything converts, until you progress or refund it.

When to use it

Use it when you want to approve each payment on a route before it converts, or to return to automatic conversion. Send { "enabled": true } or { "enabled": false }.

Before you call

Use a secret API key with route write access and pass an AUD-to-stablecoin route owned by this tenant account. The capability must be enabled for your account by Wayex (403 onramp_client_gate_not_available otherwise, in either direction). A request made from a console session also needs a recent second-factor confirmation.

Money and balance effect

This changes the route only. Turning the gate off does not release or convert payments already waiting — progress or refund each of those.

States and completion

The response is the route. clientGate is present (true) only while the gate is on; clientGateActive shows whether it is in effect right now (false when Wayex has disabled the capability for your account, in which case new fundings convert automatically). An off-ramp route is refused with 409 route_direction_unsupported.

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

Path Parameters

id
string
required

Body

application/json
enabled
boolean
required

Response

The updated payment route.

id
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
status
enum<string>
required
Available options:
active,
inactive
instructions
object
required
createdAt
string<date-time>
required
limits
object
clientGate
boolean
clientGateActive
boolean
deactivatedAt
string<date-time>

When the route was deactivated. Present only on an inactive route.

deactivatedBy
string

Who deactivated the route: the console user id, or the API key id for an API call. Present only on an inactive route.

Minimum string length: 1
deactivationNote
string

The reason given when the route was deactivated.

Minimum string length: 1