Discover corridors

Discover a corridor before creating a payout. This confirms that the selected funding currency, destination country, and destination currency are available for the partnership.

List routes

curl \
  "https://partner-api.sandbox.axiym.io/api/v1/corridors?sourceCurrency=USD&destinationCountry=PH&destinationCurrency=PHP" \
  --header "Authorization: Bearer $AXIYM_ACCESS_TOKEN"

All filters are optional. Without filters, the response lists every corridor configured for your integration, including its current availability.

{
  "nodes": [
    {
      "sourceCurrency": "USD",
      "destinationCountry": "PH",
      "destinationCurrency": "PHP",
      "availability": "AVAILABLE"
    }
  ]
}

Get one route with requirements

Use query parameters rather than a corridor identifier:

curl \
  "https://partner-api.sandbox.axiym.io/api/v1/corridors/details?sourceCurrency=USD&destinationCountry=PH&destinationCurrency=PHP" \
  --header "Authorization: Bearer $AXIYM_ACCESS_TOKEN"

The response adds destination-currency amount limits and the destination-specific party, bank, identification, document, and compliance requirements for the route.

Before creating a payout

1. Confirm availability is AVAILABLE.
2. If fixing the amount to receive, check it against minimum and maximum. If fixing the amount to send, the recipient amount is calculated by the API. Payout creation checks the resulting destination amount against these limits in either case.
3. Apply the returned field requirements alongside the baseline payout schemas. Corridor requirements add constraints; they do not replace the schema or make fields omitted from the response optional.
4. Follow any field-specific formatting normalization before validation, such as removing whitespace. For controlled values, use exact Axiym codes or prepare a value map. Do not invent or correct factual identifiers or bank details to make them pass a format or regular-expression rule.
5. Recheck corridor details when creating a new payout rather than keeping an indefinitely cached rule set.

Use Country Playbook as reference material for published destination requirements. Use the corridor endpoints for current availability, limits, and requirements specific to your integration.