Export Excel
POST
/api/user/transactions/export-excel
.xlsx). Suporta diversos filtros para personalizar os dados exportados, alĆ©m de paginaĆ§Ć£o e ordenaĆ§Ć£o.ā Requisitos da RequisiĆ§Ć£o
POST/api/user/transactions/export-excelapplication/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 para ordenaĆ§Ć£o |
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 POST '/api/user/transactions/export-excel?limit=10&page=1&orderBy=id&orderDirection=desc&id=ff5486957430b 4gdt5he5kgsrlƧfj30294uakl&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=fingerprint&idAtAcquirer=acquirerId&acquirers=uuid, uuid, uuid&name=Customer Name&email&documentNumber=000.000.000-00&phone=(99) 98765-4321&paymentMethods=PIX, BOLETO&status=PROCESSING, PAID, REFUSED&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
201 - Example 1
{
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": "string"
}Modified atĀ 2025-07-23 19:02:40