Países habilitados para payout
El endpoint Payout Destinations devuelve la lista de países disponibles para recibir payouts desde un país de origen especificado.
Se usa típicamente para determinar qué países de destino están soportados para un corredor de payout (que estén activos en tu instalación) antes de proceder con la creación de la cotización o la transacción.
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| tenant | string | Sí | El identificador de tenant de tu organización. |
| sourceCountryIso2 | string | Sí | Código ISO 3166-1 alpha-2 del país de origen (p. ej., US, BR, MX). |
Ejemplo de Solicitud
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}'
{
"countryDestinations": [
{
"country": "BR",
"countryName": "Brazil",
"currency": "BRL",
"currencyName": "Brazilian real",
"currencySymbol": "R$",
"emoji": ""
},
{
"country": "DO",
"countryName": "Dominican Republic",
"currency": "DOP",
"currencyName": "Dominican peso",
"currencySymbol": "RD$",
"emoji": ""
}
]
}
Detalles de la Respuesta
- country — Código ISO 3166-1 alpha-2 del país de destino.
- countryName — Nombre completo del país de destino.
- currency — Código ISO 4217 de la divisa de destino.
- currencyName — Nombre completo de la divisa.
- currencySymbol — Símbolo de la divisa de destino (si está disponible).
- emoji — (Opcional) Representación de la bandera en emoji.
Notas de Uso
- Usa este endpoint para poblar listas desplegables o validar corredores cuando el usuario selecciona un país de origen.
- Una vez elegido un par origen–destino válido, puedes proceder a solicitar cotizaciones y crear payouts.
GET /organizations/{tenant}/payout/{sourceCountryIso2}/destinations
