Listar cobranças da subconta
GET
/api/subaccounts/{{subaccount_id}}/charges
Operação delegada (white-label)
{{subaccount_id}}. Autenticada pela API Key do master.subaccounts:readQuery params
| Param | Tipo | Default | Descrição |
|---|---|---|---|
page | int | 1 | Página (≥1). |
limit | int | 50 | Itens por página (1–100). |
status | string | — | Filtra por ChargeStatus (ACTIVE, COMPLETED, EXPIRED, REFUNDED). |
Resposta 200 OK
{ data: [...], pagination: { page, limit, total, pages } }. Cada item:| Campo | Tipo | Notas |
|---|---|---|
id | string | cuid interno. |
correlationId | string | Gerado pelo Dotfy. |
value | int | CENTAVOS. |
status | string | ChargeStatus. |
description | string|null | |
brCode | string|null | BR Code copia-e-cola. |
paymentLink | string|null | |
paidAt | string|null | ISO8601. |
expiresAt | string | ISO8601. |
createdAt | string | ISO8601. |
payerName | string|null | |
gatewayFee | int|null | CENTAVOS — taxa cheia da cobrança. |
Sigilo (crítico): gatewayFeeé a única taxa exposta nesta superfície. A comissão do master e a base de taxa NUNCA aparecem aqui.
Códigos de erro
| HTTP | Quando |
|---|---|
401 | API Key ausente/inválida. |
404 | Master sem white-label, ou subconta inexistente/não-sua. |
Exemplo cURL
Requisição
Parâmetros de Consulta
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '/api/subaccounts/{{subaccount_id}}/charges?page=1&limit=50&status=ACTIVE' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Sucesso (200)
{
"data": [
{
"id": "clsubcharge0001",
"correlationId": "dotfyt1714000000000abc12345",
"value": 2990,
"status": "COMPLETED",
"description": "Pedido #1234",
"brCode": "00020126360014BR.GOV.BCB.PIX0114...",
"paymentLink": "https://app.dotfy.com.br/checkout/clsubcharge0001",
"paidAt": "2026-05-07T14:35:12.000Z",
"expiresAt": "2026-05-07T15:30:00.000Z",
"createdAt": "2026-05-07T14:30:00.000Z",
"payerName": "Maria Silva",
"gatewayFee": 89
}
],
"pagination": { "page": 1, "limit": 50, "total": 1, "pages": 1 }
}Modificado em 2026-07-02 06:57:27