Ir al contenido

Transacciones (Brasil)

GET /v1/br/transactions

Lista tus transacciones de Brasil — cobros y pagos Pix — con paginación por cursor. Solo incluye transacciones de Brasil.

ParamTipoRequeridoDescripción
typestring❌PAYIN, PAYOUT o ALL
statusstring❌Filtra por estado (PENDING, COMPLETED, FAILED, …)
startDatestring❌Fecha inicio (YYYY-MM-DD)
endDatestring❌Fecha fin (YYYY-MM-DD)
limitnumber❌Resultados por página (default 50, máximo 100)
nextTokenstring❌Cursor de la página anterior para continuar

Ejemplo:

GET /v1/br/transactions?type=PAYIN&status=COMPLETED&startDate=2026-10-01&endDate=2026-10-31&limit=100
{
"transactions": [
{
"txId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"txIdSource": "ORD-20261005-0000000000001",
"type": "PAYIN",
"subType": "PIX_INSTANT",
"status": "COMPLETED",
"amount": 10000,
"feeCharged": 300,
"netAmount": 9700,
"totalDebit": null,
"currency": "BRL",
"description": "Pedido #1234",
"e2eId": "E12345678202610051400000000001",
"failureReason": null,
"createdAt": "2026-10-05T15:00:00.000Z",
"updatedAt": "2026-10-05T15:02:30.000Z"
}
],
"count": 1,
"nextToken": "eyJ..."
}
CampoDescripción
txIdSourceTu referencia (txIdSource del cobro o reference del pago)
typePAYIN o PAYOUT
subTypePIX_INSTANT (cobro), PIX_KEY / PIX_BANK (pago)
netAmountNeto acreditado (cobros)
totalDebitTotal debitado (pagos)
nextTokenEnvíalo en la siguiente llamada para obtener la página siguiente; ausente si no hay más