Pago de servicios Brasil

Listar pagos

El endpoint GET /payments/v1 permite obtener un listado de todos los pagos generados por una cuenta.
Parámetros disponibles
Query Parameters
page[number]integer(format: int32)
page[size]integer(format: int32)
filter[status]array
Enum: CREATEDPAYMENT_IN_PROCESSTX_AUTHORIZEDTX_REJECTEDTX_REJECTED_BY_PROVIDERPENDING_PROVIDER_CONFIRMATIONPAID
filter[type]array
Enum: TICKETSERVICE
filter[user_id]string
filter[account_id]string
filter[payment_id]string
filter[created_from]string(format: date-time)
filter[created_until]string(format: date-time)
sortstring
Detalle de respuestas
metaobjectrequired
dataarrayrequired

¿Te resultó útil esta sección?

GET/payments/v1
Ejemplo de respuestas
{
"meta":{
"pagination":{
...
}
}
"data":[
0:{
...
}
]
}

Crear Pago

En endpoint POST /payments/v1 permite realizar el pago del boleto escaneado.
Parámetros disponibles
Body Parameters
payment_idstringrequired
Número identificatorio del pago
amountstringrequired
Monto del pago
account_idstringrequired
Número identificatorio de la cuenta
Detalle de respuestas
dataobjectrequired

¿Te resultó útil esta sección?

POST/payments/v1
{
"payment_id":
"string"
"amount":
"string"
"account_id":
"string"
}
Ejemplo de respuestas
{
"data":{
"payment_id":
"string"
"nsu_code":
"string"
"payment_status":
"CREATED"
"type":
"TICKET"
"payment_method":
"DEBIT"
"amount":
"string"
"created_at":
"2025-07-01T13:35:43.267Z"
"updated_at":
"2025-07-01T13:35:43.267Z"
"account_data":{
...
}
"payment_data":{
...
}
}
}

Validar código de barras

En endpoint POST /payments/v1/validate permite validar el código de barras del boleto a pagar.
Parámetros disponibles
Header Parameters
X-Idempotency-Keystringrequired
Body Parameters
barcodestringrequired
Código de barras del boleto a pagar
Detalle de respuestas
dataobjectrequired

¿Te resultó útil esta sección?

POST/payments/v1/validate
{
"barcode":
"string"
}
Ejemplo de respuestas
{
"data":{
"payment_id":
"string"
"nsu_code":
"string"
"payment_status":
"CREATED"
"type":
"TICKET"
"payment_method":
"DEBIT"
"amount":
"string"
"created_at":
"2025-07-01T13:35:43.269Z"
"updated_at":
"2025-07-01T13:35:43.269Z"
"account_data":{
...
}
"payment_data":{
...
}
}
}

Revertir pago

El endpoint /payments/v1/reverse te permite revertir un pago mediante su ID. En caso de ser revertido exitosamente, se devolverá un status 204
Parámetros disponibles
Body Parameters
payment_idstringrequired
Número identificatorio del pago
Detalle de respuestas

¿Te resultó útil esta sección?

POST/payments/v1/reverse
{
"payment_id":
"string"
}
Ejemplo de respuestas
{}

Obtener pago

El endpoint GET /payments/v1/{pay-id} permite obtener toda la información relacionada a un pago ya realizado.
Parámetros disponibles
Path Parameters
idstringrequired
Detalle de respuestas
dataobjectrequired

¿Te resultó útil esta sección?

GET/payments/v1/{id}
Ejemplo de respuestas
{
"data":{
"payment_id":
"string"
"nsu_code":
"string"
"payment_status":
"CREATED"
"type":
"TICKET"
"payment_method":
"DEBIT"
"amount":
"string"
"created_at":
"2025-07-01T13:35:43.272Z"
"updated_at":
"2025-07-01T13:35:43.272Z"
"account_data":{
...
}
"payment_data":{
...
}
}
}