📄 Detalhar Cobrança
Retorna os dados detalhados de uma única cobrança, incluindo informações do pagador, status e rastreabilidade financeira.
Endpoint: GET /backoffice/charges/\{id\}
📥 Parâmetros de Entrada (Path)
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID único da cobrança no sistema. |
📊 Colunas Disponíveis (Charge Object)
Abaixo estão os campos retornados no detalhamento da cobrança.
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID único da cobrança no sistema. |
value | decimal | Valor original da cobrança. |
amount_paid | decimal | Valor total pago. |
due_date | timestamp | Data de vencimento. |
payment_date | timestamp | Data de confirmação do pagamento. |
payment_method | string | Método utilizado (PIX, BOLETO, etc). |
status | object | Status atual (id, title, description). |
client | object | Dados do cliente (id, name, document, email). |
account | object | Conta favorecida (id, name). |
created_at | timestamp | Data de geração. |
updated_at | timestamp | Última atualização de dados. |
📤 Retorno de Sucesso (200 OK)
json
{
"data": {
"id": 1,
"value": 150.00,
"amount_paid": 150.00,
"due_date": "2024-05-10 23:59:59",
"payment_date": "2024-05-09 10:30:00",
"payment_method": "PIX",
"status": {
"id": 2,
"title": "PAGO",
"description": "Pagamento recebido e conciliado"
},
"client": {
"id": 10,
"name": "João da Silva",
"document": "12345678901",
"email": "joao@email.com"
},
"account": {
"id": 5,
"name": "Conta Principal"
},
"created_at": "2024-04-17 14:00:00",
"updated_at": "2024-05-09 10:30:00"
}
}❌ Erros Comuns
| Código | Descrição |
|---|---|
401 | Não Autorizado: Token ausente ou inválido. |
404 | Não Encontrado: Cobrança não existe ou o ID é inválido. |
403 | Proibido: Usuário não tem permissão para acessar este recurso. |