Axiym

List payout corridors

Lists the payment corridors configured for the partnership and reports whether each corridor is currently available. Axiym derives the origin country from the partner's onboarded location.

Use the optional filters to narrow the results by sell currency, destination country, buy currency, or payout method. Without filters, the endpoint returns every configured corridor.

Authorization

Default
AuthorizationBearer <token>

In: header

Query Parameters

sellCurrency?string

Filter by the currency sold from the funding account. Fiat and supported digital currencies are accepted.

destinationCountry?string

Filter by ISO 3166-1 alpha-2 destination country.

Match^[A-Z]{2}$
buyCurrency?string

Filter by the ISO 4217 fiat currency bought and delivered to the beneficiary. Digital currencies are not valid payout currencies.

Match^[A-Z]{3}$
payoutMethod?"BANK"

Filter by payout method. Currently, the only supported value is BANK.

Allowed values

  • "BANK"

Header Parameters

X-Request-Id?string

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json