Saltearse al contenido

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

Servicios de pago

Un servicio es la forma en que el dinero llega al beneficiario, por ejemplo un depósito bancario. Este endpoint devuelve los servicios que tienen al menos un pagador activo, opcionalmente para un país y una moneda.

Endpoint

GET/api/v1/pay-out/services

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 3 letras del país de destino, por ejemplo COL.
currencystringMoneda de destino (ISO 4217), por ejemplo COP.

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/services?country_iso=COL&currency=COP" \
-u "$CASHELA_API_KEY:$CASHELA_API_SECRET" \
-H "Accept: application/json"
{
"success": true,
"data": {
"data": [
{ "id": 2, "slug": "bank-deposit", "name": "Bank deposit", "source": "pay_out_services" }
]
},
"message": "Services retrieved successfully."
}

La lista va anidada en data.data. Los IDs y nombres son ilustrativos; léelos de la API.

Campos de la respuesta

CampoTipoDescripción
idintegerID del servicio. Envíalo como pay_out_service_id en una cotización para limitarla a este servicio.
slugstringIdentificador estable del servicio. Úsalo como service_slug en países y pagadores.
namestringNombre visible.
sourcestringCatálogo del que viene el servicio. Siempre pay_out_services.

Errores

EstadoCuándo
422country_iso o currency no existe.