Boleto Brasil

Este servicio te permite integrarte con la red de Boleto para recibir fondos a través de un título que tus usuarios podrán pagar en todo tipo de establecimientos. Existen dos tipos de boleto que se pueden emitir:

  • El boleto de depósito permite a tus clientes (personas físicas o jurídicas) hacer depósitos en su cuenta de Pomelo. La información de este tipo de boleto es fija y solo tendrás que definir el monto.
  • El boleto de cobranza permite a tus clientes con personería jurídica realizar cobros a terceros personalizando distintos campos. ¿Quieres saber más sobre Boleto? Te contamos todos los detalles en nuestra documentación.

Crear boleto de depósito

El endpoint POST /networks/cash/v1/cashin/intents te permitirá generar un boleto para realizar un depósito en una cuenta determinada.
Parámetros disponibles
Header Parameters
X-Idempotency-Keystringrequired
Identificador de idempotencia
countrystringrequired
País
Ejemplo: BRA
Body Parameters
account_idstringrequired
Identificador de la cuenta.
Ejemplo: acc-20I4qJinTCudWvJULZygeC257wy
networkstringrequired
Identificador de la red de pago.
Pattern: BOLETO
Ejemplo: BOLETO
amountstringrequired
Monto del boleto.
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
{
"data":{
"id":
"string"
"account_id":
"string"
"network":
"string"
"status":
"string"
"amount":
"number"
"data":{
...
}
"created_at":
"string"
"expires_at":
"string"
}
}

Crear boleto de cobranza

El endpoint POST /networks/cash/v1/cashin/charges te permitirá generar un boleto de cobranza para una cuenta determinada asignando un pagador.
Parámetros disponibles
Header Parameters
X-Idempotency-Keystringrequired
Identificador de idempotencia
countrystringrequired
País
Ejemplo: BRA
Body Parameters
account_idstringrequired
Identificador de la cuenta.
Ejemplo: acc-20I4qJinTCudWvJULZygeC257wy
networkstringrequired
Identificador de la red de pago.
Pattern: BOLETO
Ejemplo: BOLETO
amountstringrequired
Monto del boleto.
Ejemplo: 397.67
payerobjectrequired
Pagador del boleto de cobranza.
expires_atstringrequired
Fecha de vencimiento.
Ejemplo: 2022-07-26
detailsobject
Detalle de cobranza.
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/networks/cash/v1/cashin/charge
{
"account_id":
"acc-20I4qJinTCudWvJULZygeC257wy"
"network":
"BOLETO"
"amount":
"397.67"
"payer":{
"first_name":
"Nombre"
"last_name":
"Apellido"
"fantasy_name":
"Pomelo"
"person_type":
"F"
"identification_value":
"44128548000197"
"legal_address":{
...
}
}
"expires_at":
"2022-07-26"
"details":{
"payment_deadline":
"2022-07-26"
"instructions":
"Instrucciones"
"refund_amount":
"397.67"
"interest":{
...
}
"penalty":{
...
}
"discount":{
...
}
"days_to_protest}}":
"99"
"days_to_denial}}":
"99"
}
}
Ejemplo de respuestas
{
"data":{
"id":
"string"
"account_id":
"string"
"network":
"string"
"status":
"string"
"amount":
"number"
"data":{
...
}
"created_at":
"string"
"expires_at":
"string"
}
}

Obtener boleto

El endpoint GET /networks/cash/v1/cashin/intents/{intent_id} te permitirá obtener todos los datos de un boleto a través de su identificador.
Parámetros disponibles
Header Parameters
countrystringrequired
País
Ejemplo: BRA
Path Parameters
intent_idstringrequired
Identificador del boleto.
Ejemplo: cii-20I4qJinTCudWvJULZygeC257wy
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/networks/cash/v1/cashin/intents/{intent_id}
Ejemplo de respuestas
{
"data":{
"id":
"string"
"account_id":
"string"
"network":
"string"
"status":
"string"
"amount":
"number"
"data":{
...
}
"created_at":
"string"
"expires_at":
"string"
}
}

Cancelar boleto

El endpoint DELETE /networks/cash/v1/cashin/intents/{intent_id} te permitirá cancelar un boleto.
Parámetros disponibles
Header Parameters
countrystringrequired
País
Ejemplo: BRA
Path Parameters
intent_idstringrequired
Identificador del boleto.
Ejemplo: cin-20I4qJinTCudWvJULZygeC257wy
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

DELETE/networks/cash/v1/cashin/intents/{intent_id}
Ejemplo de respuestas
{
"data":{
"id":
"string"
"account_id":
"string"
"network":
"string"
"status":
"string"
"amount":
"number"
"created_at":
"string"
"expires_at":
"string"
}
}

Listar boletos por cuenta

El endpoint GET /networks/cash/v1/cashin/intents/account/{account_id} te permitirá listar todos los boletos de una cuenta en particular.
Parámetros disponibles
Header Parameters
countrystringrequired
País
Ejemplo: BRA
Query Parameters
filter[status]string
Estado
Ejemplo: ACTIVE
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áginas
Ejemplo: 10
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
{
"data":{
"id":
"string"
"account_id":
"string"
"network":
"string"
"status":
"string"
"amount":
"number"
"data":{
...
}
"created_at":
"string"
"expires_at":
"string"
}
}