Saltearse al contenido

La búsqueda solo está disponible en las versiones de producción. Intenta construir y previsualizar el sitio para probarlo localmente.

Países de pago

Devuelve los países que tienen al menos un pagador activo, opcionalmente filtrados por servicio y moneda.

Endpoint

GET/api/v1/pay-out/countries

Autenticación: HTTP Basic con tu clave y tu secreto API. Consulta Autenticación.

Parámetros de consulta

Todos son opcionales.

ParámetroTipoDescripción
country_isostringCódigo de país de 3 letras (ISO 3166-1 alfa-3), por ejemplo COL. Devuelve solo ese país si está disponible.
service_slugstringSolo países atendidos por este servicio. Usa un slug de Servicios de pago.
currencystringSolo países con pagadores en esta moneda (ISO 4217), por ejemplo COP.
namestringSolo países cuyo nombre contiene este texto.

country_iso_code se acepta como alias de country_iso. Los códigos no distinguen mayúsculas.

Ejemplo

Ventana de terminal
curl "https://sandbox-api.cashela.com/api/v1/pay-out/countries?service_slug=bank-deposit" \
-u "$CASHELA_API_KEY:$CASHELA_API_SECRET" \
-H "Accept: application/json"
{
"success": true,
"data": [
{ "id": 48, "name": "Colombia", "country_iso": "COL", "iso_code": "COL" },
{ "id": 62, "name": "Dominican Republic", "country_iso": "DOM", "iso_code": "DOM" }
],
"message": "Countries retrieved successfully."
}

Los países se ordenan por nombre. Los IDs y países del ejemplo son ilustrativos.

Campos de la respuesta

CampoTipoDescripción
idintegerID de país en Cashela.
namestringNombre del país.
country_isostringCódigo de país de 3 letras. Úsalo en destination.country_iso_code al crear una cotización.
iso_codestringMismo valor que country_iso.

Errores

EstadoCuándo
422Un filtro tiene un valor desconocido (por ejemplo un country_iso, currency o service_slug que no existe).