Create a payment route

View as Markdown
Opens a route in one of two directions. **`onramp`** opens a deposit account in `sourceCurrency`; whatever lands there is paid out as stablecoin to `destinationAddress`. **`offramp`** opens a deposit address on `sourcePaymentRail`; stablecoin sent there is paid out as fiat to the bank account described in the request. The required bank fields depend on `destinationCurrency` and `destinationPaymentRail` — see the guide. Off-ramp is enabled separately from on-ramp, and the company must have been activated by AlphaX before any route can be opened.

Authentication

X-API-Keystring
Your partner API key.

Headers

X-Company-IdstringRequired

The company you are acting for (a company ULID).

Request

This endpoint expects an object.

Response

Created
paymentRouteobjectOptional

Errors

400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error