Detalhe de cobrança da subconta
GET
/api/subaccounts/{{subaccount_id}}/charges/{{sub_charge_id}}
Operação delegada (white-label)
subaccounts:readPath params
| Param | Descrição |
|---|---|
{{subaccount_id}} | ID da subconta. |
{{sub_charge_id}} | ID (cuid interno) da cobrança. |
Ownership
404 idêntico ao de recurso inexistente (não vaza existência cross-tenant).Resposta 200 OK
{ charge: { ... } } com os campos:| Campo | Tipo | Notas |
|---|---|---|
id | string | cuid interno. |
correlationId | string | |
value | int | CENTAVOS. |
status | string | ChargeStatus. |
description | string|null | |
brCode | string|null | BR Code copia-e-cola. |
qrCodeImage | string|null | data URL / URL da imagem do QR. |
paymentLink | string|null | |
endToEndId | string|null | E2E do PIX (após pagamento). |
paidAt | string|null | ISO8601. |
expiresAt | string | ISO8601. |
createdAt | string | ISO8601. |
payerName / payerTaxId | string|null | Quem pagou. |
gatewayFee | int|null | CENTAVOS — taxa cheia. |
customerName / customerEmail / customerTaxId | string|null | Devedor informado na criação. |
Sigilo (crítico): apenas gatewayFee(taxa cheia). Comissão/base do master NUNCA aparecem aqui.
Códigos de erro
| HTTP | Quando |
|---|---|
401 | API Key ausente/inválida. |
404 | Master sem white-label, subconta não-sua, ou cobrança não pertence à subconta. |
Exemplo cURL
Requisição
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '/api/subaccounts/{{subaccount_id}}/charges/{{sub_charge_id}}' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Sucesso (200) — cobrança paga
{
"charge": {
"id": "clsubcharge0001",
"correlationId": "dotfyt1714000000000abc12345",
"value": 2990,
"status": "COMPLETED",
"description": "Pedido #1234",
"brCode": "00020126360014BR.GOV.BCB.PIX0114...",
"qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg...",
"paymentLink": "https://app.dotfy.com.br/checkout/clsubcharge0001",
"endToEndId": "E18236120202605071435s00abc12345",
"paidAt": "2026-05-07T14:35:12.000Z",
"expiresAt": "2026-05-07T15:30:00.000Z",
"createdAt": "2026-05-07T14:30:00.000Z",
"payerName": "Maria Silva",
"payerTaxId": "12345678901",
"gatewayFee": 89,
"customerName": "Maria Silva",
"customerEmail": "maria@exemplo.com",
"customerTaxId": "12345678901"
}
}Modificado em 2026-07-02 06:57:27