Payout countries enabled

The Payout Destinations endpoint returns the list of countries available to receive payouts from a specified source country.

This is typically used to determine which destination countries are supported for a payout corridor (that are active for your installation) before proceeding with quote or transaction creation.

Parameter	Type	Required	Description
tenant	string	Yes	The tenant identifier for your organization.
sourceCountryIso2	string	Yes	ISO 3166-1 alpha-2 code of the source country (e.g., US, BR, MX).

Sample Request

Request

curl --request GET \
  --url {api_endpoint}/organizations/{tenant}/payout/{sourceCountryIso2}/destinations \
  --header 'content-type: application/json' \
  --header 'x-agent-api-key: {agentApiKey}' \
  --header 'x-agent-id: {agentId}'

Response

Response Details

• country — ISO 3166-1 alpha-2 code of the destination country.

• countryName — Full name of the destination country.

• currency — ISO 4217 code of the destination currency.

• currencyName — Full name of the currency.

• currencySymbol — Symbol for the destination currency (if available).

• emoji — (Optional) Flag emoji representation.

---

Usage Notes

• Use this endpoint to populate dropdown lists or validate corridors when the user selects a source country.

• Once a valid source–destination pair is chosen, you can proceed to request quotes and create payouts.

Documentation

GET /organizations/{tenant}/payout/{sourceCountryIso2}/destinations