Skip to content

📄 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)

CampoTipoDescrição
idintegerID único da cobrança no sistema.

📊 Colunas Disponíveis (Charge Object)

Abaixo estão os campos retornados no detalhamento da cobrança.

CampoTipoDescrição
idintegerID único da cobrança no sistema.
valuedecimalValor original da cobrança.
amount_paiddecimalValor total pago.
due_datetimestampData de vencimento.
payment_datetimestampData de confirmação do pagamento.
payment_methodstringMétodo utilizado (PIX, BOLETO, etc).
statusobjectStatus atual (id, title, description).
clientobjectDados do cliente (id, name, document, email).
accountobjectConta favorecida (id, name).
created_attimestampData de geração.
updated_attimestampÚ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ódigoDescrição
401Não Autorizado: Token ausente ou inválido.
404Não Encontrado: Cobrança não existe ou o ID é inválido.
403Proibido: Usuário não tem permissão para acessar este recurso.

FastGivr API Documentation