Endpoints da APIRelatórios
Listar transações
Autorização
BearerAuth AutorizaçãoBearer <token>
Em: header
Parâmetros de query
dateFrom?string
Data inicial (YYYY-MM-DD).
dateTo?string
Data final (YYYY-MM-DD).
limit?number
Itens por página (máximo 1000).
Padrão
10page?number
Número da página (padrão 1).
Padrão
1id?string
ID da transação.
status?string
Status da transação. Aceita CSV: PENDING,COMPLETED,etc.
type?string
Tipo da transação. Aceita CSV: DEPOSIT,WITHDRAW,COMMISSION.
method?string
Método/trilho da transação. Aceita CSV: PIX,BANK_SLIP,INTERNAL_TRANSFER.
amount?number
Filtro por valor. Mínimo 0.01.
Intervalo
0.01 <= valuedocument?string
CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números sem formatação.
Padrão regex
^[0-9]{11,14}$name?string
Filtro por nome.
endToEndId?string
ID end-to-end do Pix.
sortBy?string
Campo pelo qual ordenar
Padrão
"createdAt"Valor em
"createdAt" | "updatedAt"sortDirection?string
Direção da ordenação
Padrão
"desc"Valor em
"asc" | "desc"clientReference?string
Filtra por referência externa
virtualAccount?string
Subconta virtual (até 50 caracteres) usada na criação. Aceito como chave de busca alternativa.
Tamanho
length <= 50Corpo da resposta
application/json
application/json
application/json
application/json
curl -X GET "https://api.exemplo.processamento.com/v1/user/transactions?dateFrom=2025-08-01&dateTo=2025-08-17&limit=10&page=1&id=PIX2025081418333632CYKN8M&status=COMPLETED&type=DEPOSIT&method=PIX&amount=15000&document=12345678901&name=Alice&endToEndId=E00360305202508141833bcf1f37b487"{
"total": 104,
"pages": 2,
"transactions": [
{
"id": "PIX202511061998787515D0PH2Y",
"amount": 10,
"status": "PENDING",
"type": "DEPOSIT",
"qrCodeText": "00020126860014br.gov.bcb.pix2564qrcode.pix.com.br/pix/84f95c33-3c86-4708-87f1-0e09b96b35795204000053039865802BR5908PAYZPLUS6009SAO PAULO62070503***63048227",
"qrCodeBase64": null,
"qrCodeUrl": "https://pix.pix.com.br/v1/pix/qr-code/PIX202511061998787515D0PH2Y",
"serviceFeeCharged": 0.115,
"payerDocument": null,
"payerName": null,
"payerInstitutionIspb": null,
"payerInstitutionName": null,
"receiverDocument": null,
"receiverName": null,
"receiverInstitutionIspb": null,
"receiverInstitutionName": null,
"generatedDocument": "00000000191",
"generatedName": "THIAGO SILVA",
"generatedEmail": null,
"endToEndId": null,
"withdrawPixKey": null,
"withdrawPixType": null,
"paidAt": null,
"createdAt": "2025-11-06T22:06:19.598Z",
"updatedAt": "2025-11-06T22:06:19.598Z",
"clientReference": "order_12345",
"refundEndToEndId": null,
"refundAmount": null,
"refundStatus": null,
"refundReason": null,
"refundDescription": null,
"refundedAt": null,
"cancellationReason": null
},
{
"id": "PIX202511061998787515D0PH2Y",
"amount": 5.5,
"status": "ERROR",
"type": "WITHDRAW",
"qrCodeText": null,
"qrCodeBase64": null,
"qrCodeUrl": null,
"serviceFeeCharged": 1,
"payerDocument": null,
"payerName": null,
"payerInstitutionIspb": null,
"payerInstitutionName": null,
"receiverDocument": null,
"receiverName": null,
"receiverInstitutionIspb": null,
"receiverInstitutionName": null,
"generatedDocument": null,
"generatedName": null,
"generatedEmail": null,
"endToEndId": null,
"withdrawPixKey": "88888888888",
"withdrawPixType": "cpf",
"paidAt": null,
"createdAt": "2025-11-06T19:08:55.848Z",
"updatedAt": "2025-11-06T19:09:13.602Z",
"clientReference": null,
"refundEndToEndId": null,
"refundAmount": null,
"refundStatus": null,
"refundReason": null,
"refundDescription": null,
"refundedAt": null,
"cancellationReason": "PIX_KEY_NOT_FOUND"
}
]
}{
"statusCode": 400,
"error": "Bad Request",
"message": "querystring/dateFrom Invalid input: expected string, received undefined",
"requestId": "cmou00000abcdef01s6ghij1k2lm"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Missing or invalid Bearer token",
"requestId": "cmou00000abcdef01s6ghij1k2lm"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found",
"requestId": "cmou00000abcdef01s6ghij1k2lm"
}