Listar cobranças
Lista as cobranças da sua conta com paginação e filtros por status, data, valor, meio de pagamento e texto.
apiKeyAuthorizationBearer <token>Chave de API gerada no painel: Authorization: Bearer <chave>.
page?integerPágina, a partir de 1.
1 <= value1limit?integerItens por página, até 100.
1 <= value <= 10020search?stringBusca parcial, sem diferenciar maiúsculas, no id da cobrança, no
externalReference, na descrição e nos ids das tentativas.
length <= 255status?stringUm ou mais status, separados por vírgula (PAID,REFUNDED) ou com o
parâmetro repetido. Valores desconhecidos são ignorados.
kind?stringTipo da cobrança, mesmo formato de status. SALE é a cobrança
normal; DISCOUNT_MED_APPLY é o lançamento de desconto por
devolução PIX (MED). Omitido, a lista traz os dois.
from?stringInício do intervalo de criação, em ISO 8601.
date-timeto?stringFim do intervalo de criação, em ISO 8601.
date-timeminAmount?numberValor mínimo de grossAmount, em unidades da moeda (10.5 = 10,50).
0 <= valuemaxAmount?numberValor máximo de grossAmount, em unidades da moeda.
0 <= valueamount?integerValor exato de grossAmount, em centavos (4990 = 49,90).
Ignorado se minAmount ou maxAmount vier junto.
0 <= valuecurrency?stringMoeda da cobrança.
"BRL""USD""EUR"paymentMethod?stringMeio de pagamento da tentativa, ou o meio fixado na criação.
"PIX""BANK_SLIP""CREDIT_CARD""CRYPTO"subscriptionId?stringSó as cobranças geradas por esta assinatura.
length <= 36sortField?stringCampo de ordenação.
"createdAt""createdAt""grossAmount"sortDirection?stringDireção da ordenação, em minúsculas.
"desc""desc""asc"Página de cobranças. O total também vem no header X-Total-Count.
application/json- response
items?array<>actualPage?integerPágina atual.
pagesQuantity?integerTotal de páginas. Mínimo 1, mesmo sem resultados.
total?integerTotal de cobranças com os filtros aplicados.
curl -X GET 'https://api.gates2b.com/charge/list'{ "items": [ { "id": "01JC8Z3R5W7Y9A1C3E5G7J9K2M", "kind": "SALE", "status": "PAID", "grossAmount": "49.90", "refundedAmount": "0.00", "currency": "BRL", "externalReference": "pedido-0001", "description": "Assinatura mensal", "expiresAt": "2026-11-30T23:59:59.000Z", "subscriptionId": null, "paymentMethod": "PIX", "customerMeta": { "name": "Maria da Silva", "document": "123******09", "email": "cl*****@example.com", "phone": null }, "canRefund": true, "canRefundPartial": true, "attemptIds": [ "0192f4c6-7d1e-7a3b-9c2d-4e5f6a7b8c9d" ], "createdAt": "2026-10-22T14:00:00.000Z", "updatedAt": "2026-10-22T14:03:12.000Z" } ], "actualPage": 1, "pagesQuantity": 1, "total": 1}Regras
- A paginação usa
pageelimit(até100por página). A resposta traztotal,pagesQuantityeactualPage; o total também vem no headerX-Total-Count. - Para reconciliar um período, filtre por
frometoe percorra as páginas atéactualPageigual apagesQuantity. Ordene porcreatedAtpara a paginação ficar estável. minAmountemaxAmountsão em unidades da moeda (49.9);amounté o valor exato em centavos (4990).sortDirectionaceita só minúsculas:ascoudesc.- Uma cobrança
PENDINGcom prazo vencido aparece comoEXPIRED, mesmo antes de o status ser gravado. - Os itens são um resumo: não trazem
netAmount, tarifas nem o pagamento confirmado. Para isso, use Consultar cobrança.