Cash Networks Brasil

Este servicio te permite integrarte con distintas redes de efectivo para consultar los datos de una cuenta y registrar intenciones de ingresos de dinero (cash in intent) para una cuenta en una red de efectivo.

Para ingresar dinero, deberás registrar un cash in intent en alguna de las redes de pagos habilitadas.

PaísNetworkID
BrasilBoletoBOLETO

Crear Intento de Cash in

El endpoint POST /networks/cash/v1/cashin/intents te permitirá generar un intento de cash in para una cuenta determinada. Cada intento representa la intención de ingresar dinero al balance de una cuenta a través de una red de pago.

Ciclo de vida

El intento se resuelve cuando se realice efectivamente el ingreso de dinero a través de una red de cash o cuando se alcance la fecha de expiración, lo primero que ocurra.

El intento puede tener distintos estados dependiendo qué acción haya sido aplicada al mismo:

  • ACTIVE: el intento se encuentra activo y puedes usarlo hasta la fecha de expiración (expires_at). Cuando llega la fecha de expiración no podrás usar ese intent para ingresar dinero, deberás generar uno nuevo.
  • REJECTED: la integración con la red de cash rechazó la creación del intent.
  • PAID: el intent se pagó en su totalidad por el monto que solicitaste.
  • PARTIALLY_PAID: el intent se pagó parcialmente, es decir que la sumatoria los pagos que efectuaron en nombre de este intent es menor que el monto que solicitaste. Es posible hacer pagos parciales hasta la fecha de expiración del intent.
  • CANCELLED: este estado puede alcanzarse por distintas vías. La primera es que hayas cancelado el intent con el endpoint de cancelación o bien, que el proveedor de la red de efectivo proactivamente anule el intent que generaste.
Parámetros disponibles
Header Parameters
X-Idempotency-Keystringrequired
Body Parameters
account_idstringrequired
Identificador de la cuenta
Ejemplo: acc-20I4qJinTCudWvJULZygeC257wy
networkstringrequired
Identificador de la red de pago
Ejemplo: BOLETO
amountstringrequired
Monto de la intención de ingreso
Ejemplo: 397.67
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
POST/networks/cash/v1/cashin/intents
{
"account_id":
"acc-20I4qJinTCudWvJULZygeC257wy"
"network":
"BOLETO"
"amount":
"397.67"
}
Ejemplo de respuestas

Obtener intento de cash in

El endpoint GET /networks/cash/v1/cashin/intents/{intent_id} te permitirá obtener todos los datos de una intención de cashin a través de su identificador.
Parámetros disponibles
Path Parameters
intent_idstringrequired
Identificador del intento de cash in
Ejemplo: cin-20I4qJinTCudWvJULZygeC257wy
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
GET/networks/cash/v1/cashin/intents/{intent_id}
Ejemplo de respuestas

Cancelar intento de cash in

El endpoint DELETE /networks/cash/v1/cashin/intents/{intent_id} te permitirá cancelar un cash in intent.
Parámetros disponibles
Path Parameters
intent_idstringrequired
Identificador del intento de cash in
Ejemplo: cin-20I4qJinTCudWvJULZygeC257wy
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
DELETE/networks/cash/v1/cashin/intents/{intent_id}
Ejemplo de respuestas

Listar intentos de cash in por cuenta

El endpoint GET /networks/cash/v1/cashin/intents/account/{account_id} te permitirá listar todos los cash in intents de una cuenta en particular.
Parámetros disponibles
Query Parameters
filter[status]string
Estado
Enum: ACTIVEREJECTEDPAIDPARTIALLY_PAIDCANCELLED
filter[date_from]string(format: date-time)
Fecha desde
filter[date_to]string(format: date-time)
Fecha hasta
page[number]integer(format: int32)
Página
page[size]integer(format: int32)
Tamaño de página
Path Parameters
account_idstringrequired
Identificador de la cuenta
Ejemplo: acc-20I4qJinTCudWvJULZygeC257wy
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
GET/networks/cash/v1/cashin/intents/account/{account_id}
Ejemplo de respuestas