Summary all
GET
/api/user/transactions/summary
✅ Requisitos da Requisição
GET/api/user/transactions/summaryapplication/jsonapi_token🧠 Header da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
x-api-key | string | Sim | Token de autenticação API Key |
User-Agent | AtivoB2B/1.0 | Sim |
📥 Parâmetros obrigatórios
| Parâmetro | Tipo | Descrição |
|---|---|---|
limit | string | Quantidade de registros por página |
page | string | Página atual |
orderBy | string | Campo a ser ordenado |
orderDirection | string | Direção da ordenação (asc ou desc) |
id | string | ID da transação |
externalRef | string | Referência externa |
pixEnd2EndId | string | ID Pix end-to-end |
createStartDate | string (date-time) | Data de criação inicial |
createEndDate | string (date-time) | Data de criação final |
refundStartDate | string (date-time) | Data inicial do reembolso |
refundEndDate | string (date-time) | Data final do reembolso |
updateStartDate | string (date-time) | Data de atualização inicial |
updateEndDate | string (date-time) | Data de atualização final |
expirationDateStart | string (date-time) | Data de expiração inicial |
expirationDateEnd | string (date-time) | Data de expiração final |
firstSixDigits | string | Primeiros seis dígitos do cartão |
lastFourDigits | string | Últimos quatro dígitos do cartão |
brand | string | Bandeira do cartão |
fingerprint | string | Identificador do cartão |
idAtAcquirer | string | ID no adquirente |
acquirers | array[string] | Lista de adquirentes |
name | string | Nome do comprador |
email | string | Email do comprador |
documentNumber | string | Documento (CPF/CNPJ) do comprador |
phone | string | Telefone do comprador |
paymentMethods | array[string] | Métodos de pagamento (ex: PIX, BOLETO, etc.) |
status | string | Status da transação (PROCESSING, AUTHORIZED, PAID, REFUNDED, WAITING_PAYMENT, REFUSED, CHARGEDBACK, CANCELED, IN_PROTEST) |
installments | array[string] | Número de parcelas |
deliveryStatus | array[string] | Status da entrega (ex: WAITING, IN_TRANSIT) |
Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/user/transactions/summary?limit=10&page=1&orderBy=jf3ls3dkru92i4903ivf290b5um24350&orderDirection=desc&id=uuid&externalRef=externalRef&pixEnd2EndId=pixEnd2EndId&createStartDate=2025-04-11T12:47:35.884Z&createEndDate=2025-04-11T12:47:35.884Z&refundStartDate=2025-04-11T12:47:35.884Z&refundEndDate=2025-04-11T12:47:35.884Z&updateStartDate=2025-04-11T12:47:35.884Z&updateEndDate=2025-04-11T12:47:35.884Z&firstSixDigits=123456&lastFourDigits=4321&brand=brand&fingerprint&idAtAcquirer=acquirerId&acquirers=uuid, uuid&name=Customer Name&email=johndoe@email.com&documentNumber= 000.000.000-00&phone=(99) 98765-4321&paymentMethods=PIX, BOLETO&status=PROCESSING, PAID&installments=1, 2, 3&deliveryStatus=WAITING, IN_TRANSIT&expirationDateStart=2025-04-11T12:47:35.885Z&expirationDateEnd=2025-04-11T12:47:35.885Z' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0'Response Response Example
200 - Success
{
"status": 200,
"message": "Transações encontradas com sucesso.",
"data": {
"data": [
{
"id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"amount": 1000,
"status": "PAID",
"paymentMethod": "BOLETO",
"installments": "X",
"card": "X",
"pix": "X",
"boleto": {
"id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"url": "https://XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"barcode": "X",
"digitableLine": "X",
"expirationDate": "2025-04-23T00:00:00.000Z",
"instructions": "X",
"createdAt": "2025-04-16T12:56:01.605Z",
"transactionId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
"customer": {
"name": "XXXXXXXXXXXXX",
"email": "XXXXXXXXXXXXXXXXXXXX"
},
"items": [
{
"title": "XXXXXXXXXXXX",
"unitPrice": 10,
"quantity": 1
}
],
"createdAt": "2025-04-16T12:55:55.557Z",
"updatedAt": "2025-04-16T12:56:01.325Z",
"paidAt": "X",
"externalRef": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"provider": "XXXXXXXX"
},
{
"id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"amount": 100000,
"status": "PAID",
"paymentMethod": "CREDIT_CARD",
"installments": 3,
"card": {
"id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"holderName": "XXXXXXXX",
"expirationMonth": 12,
"expirationYear": 2030,
"brand": "X",
"lastDigits": "XXXXXXXXXXXXXXXX",
"reusable": false,
"createdAt": "2025-04-16T12:53:37.539Z",
"gatewayId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
"pix": "X",
"boleto": "X",
"customer": {
"name": "XXXXXXXXXXXXX",
"email": "XXXXXXXXXXXXXXXXXXXX"
},
"items": [
{
"title": "XXXXXXXXXXXX",
"unitPrice": 10,
"quantity": 1
}
],
"createdAt": "2025-04-16T12:53:37.539Z",
"updatedAt": "2025-04-16T14:35:32.679Z",
"paidAt": "2025-04-16T12:53:49.238Z",
"externalRef": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"provider": "XXXXXXXX"
}
],
"pages": 44,
"page": 1,
"limit": 10,
"total": 439
},
"error": "X"
}
Modified at 2025-07-23 19:02:40