Implementation guides
Discover corridors
Discover a corridor before requesting a quote. This confirms that the selected sell currency, destination country, buy currency, and payout method are available for the partnership.
The origin country is not a request filter. Axiym derives it from the onboarded location of the partner.
List routes
curl \
"https://partner-api.sandbox.axiym.io/api/v1/corridors?destinationCountry=PH&buyCurrency=PHP&payoutMethod=BANK" \
--header "Authorization: Bearer $AXIYM_ACCESS_TOKEN"All filters are optional. If no destination country or buy currency is supplied, the response lists all corridors available in the current scope.
{
"nodes": [
{
"originCountry": "SG",
"sellCurrency": "USD",
"destinationCountry": "PH",
"buyCurrency": "PHP",
"payoutMethod": "BANK",
"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?sellCurrency=USD&destinationCountry=PH&buyCurrency=PHP&payoutMethod=BANK" \
--header "Authorization: Bearer $AXIYM_ACCESS_TOKEN"The response adds buy-currency amount limits and the destination-specific party, bank, identification, document, and compliance requirements for the route.
Before requesting a quote
- Confirm
availabilityisAVAILABLE. - Confirm the buy amount falls between
minimumandmaximum. - Apply each returned field requirement to your payout form or validation.
- Preserve factual identifiers and bank values exactly as supplied. Axiym normalizes controlled vocabulary fields; it does not repair factual data that fails a format or regular-expression rule.
- Run Payout Test with representative data for the route.
- Recheck corridor details when creating a new payout rather than keeping an indefinitely cached rule set.
Use Country Playbook for an integrator-friendly view of the same country rules.