Pagadores

Un pagador es la institución o red que entrega el dinero al beneficiario. Este endpoint devuelve los pagadores activos, filtrados por servicio, país y moneda, con paginación.

Endpoint

GET/api/v1/pay-out/payers

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

Parámetros de consulta

Todos son opcionales.

Parámetro	Tipo	Descripción
country_iso	string	Código de 3 letras del país de destino, por ejemplo COL.
currency	string	Moneda de destino (ISO 4217), por ejemplo COP.
service_slug	string	Un slug de Servicios de pago, por ejemplo bank-deposit.
page	integer	Número de página, desde 1.
per_page	integer	Resultados por página, de 1 a 100. Por defecto 100.

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

Ejemplo

curl "https://sandbox-api.cashela.com/api/v1/pay-out/payers?service_slug=bank-deposit&country_iso=COL&currency=COP" \
  -u "$CASHELA_API_KEY:$CASHELA_API_SECRET" \
  -H "Accept: application/json"

{
  "success": true,
  "data": {
    "total": 1,
    "per_page": 100,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "first_page_url": "https://sandbox-api.cashela.com/api/v1/pay-out/payers?page=1",
    "self": "https://sandbox-api.cashela.com/api/v1/pay-out/payers?page=1",
    "last_page_url": "https://sandbox-api.cashela.com/api/v1/pay-out/payers?page=1",
    "next_page_url": null,
    "prev_page_url": null,
    "path": "https://sandbox-api.cashela.com/api/v1/pay-out/payers",
    "data": [
      {
        "id": 123,
        "name": "Example Bank",
        "source": "pay_out_payers",
        "pay_out_payer_id": 123,
        "increment": 0.01,
        "precision": 2,
        "mandatory_branch": false,
        "currency": "COP",
        "country_iso": "COL",
        "country_iso_code": "COL",
        "service": { "id": 2, "slug": "bank-deposit", "name": "Bank deposit", "source": "pay_out_services" },
        "transaction_types": ["C2C"]
      }
    ]
  },
  "message": "Payers retrieved successfully."
}

Los pagadores se ordenan por nombre. Los valores son ilustrativos.

Campos de la respuesta

Los campos de paginación (total, per_page, current_page, last_page, from, to, next_page_url, prev_page_url y las demás URLs) van junto a la lista data.

Campo	Tipo	Descripción
id	integer	ID del pagador. Envíalo como pay_out_payer_id al ejecutar una transacción, o como payer_id en una cotización para cotizar solo este pagador.
pay_out_payer_id	integer	Mismo valor que id.
name	string	Nombre del pagador.
source	string	Catálogo del que viene el pagador. Siempre pay_out_payers.
currency	string	Moneda en la que paga el pagador.
country_iso / country_iso_code	string	Código de 3 letras del país que atiende.
service	object	Servicio del pagador: id, slug, name, source.
increment	number	Incremento de importe configurado para el pagador.
precision	integer	Precisión decimal configurada para el pagador.
mandatory_branch	boolean o null	Si el pagador exige datos de sucursal.
transaction_types	array o null	Tipos de transacción que acepta el pagador (C2C, C2B, B2C, B2B).

La respuesta puede incluir otros campos. No construyas sobre campos que no aparecen aquí.

Nota

Este endpoint no devuelve los datos de beneficiario y de cuenta que necesita cada pagador. Pide a Cashela la lista de campos de cada corredor antes de salir a producción. Consulta Ejecutar una transacción.

Errores

Estado	Cuándo
422	Un filtro tiene un valor desconocido, o per_page está fuera de rango.