Detalhe da cobrança
Recupere os dados completos de uma cobrança específica pelo ID, incluindo o cliente associado, as parcelas geradas, notificações configuradas e a URL de pagamento.
Endpoint
/invoices/applications/invoices/:id
Authorization: Basic {token}Parâmetros de path
Substitua :id na URL pelo identificador único da cobrança:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | UUID | Obrigatório | Identificador único da cobrança a ser consultada. Retornado no campo id da resposta de cadastro da cobrança. |
Exemplo de requisição
Exemplo de chamada para buscar uma cobrança. Substitua $TOKEN pelo seu token Base64 e {{invoiceId}} pelo id real da cobrança:
curl -X GET https://api.az.center/invoices/applications/invoices/{{invoiceId}} \
-H "Authorization: Basic $TOKEN"Respostas
Cobrança encontrada
Retorna o objeto completo da cobrança, com os dados principais, o cliente associado (customer), as parcelas geradas (installments) com status e datas de pagamento, as notificações configuradas em quatro categorias, os webhooks ativos, os tipos de pagamento aceitos e a url de pagamento pronta para ser enviada ao pagador.
{
"id": "00000000-0000-0000-0000-000000000001",
"description": "Aqui a descrição da cobrança teste",
"invoiceType": "SINGLE",
"price": 6,
"dueDate": "2026-08-21T00:00:00.000Z",
"endDate": null,
"endInstallment": null,
"endSubscription": null,
"frequency": null,
"installmentCount": 1,
"customer": {
"id": "00000000-0000-0000-0000-000000000002",
"fullName": "Maria da Silva",
"document": "000.000.000-00",
"business": "Empresa Exemplo LTDA",
"email": "[email protected]",
"userId": "00000000-0000-0000-0000-000000000003",
"applicationId": "00000000-0000-0000-0000-000000000004",
"phone": "+5521979807478",
"addressId": "00000000-0000-0000-0000-000000000005",
"observations": "Cliente preferencial, vencimento sempre no dia 10",
"createdAt": "2026-05-28T20:00:35.000Z",
"deletedAt": null
},
"redirectTo": "https://www.ciabra.com.br",
"installments": [
{
"createdAt": "2026-05-28T23:03:53.000Z",
"deletedAt": null,
"dueDate": "2026-08-21T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000006",
"installment": 1,
"invoiceId": "00000000-0000-0000-0000-000000000001",
"lastViewAt": null,
"paidAt": null,
"paymentReceivedAt": null,
"price": 6,
"pricePaid": 0,
"_status": "WAITING_PAYMENT",
"updatedAt": null,
"viewsCount": 0
}
],
"items": [],
"notificationBeforeDueDate": [],
"notificationAfterDueDate": [],
"notificationAfterPayment": [],
"notificationSendTypes": [],
"webhooks": [],
"paymentTypes": [
{
"invoiceId": "00000000-0000-0000-0000-000000000001",
"paymentTypeAccepted": "PIX"
}
],
"createdAt": "2026-05-28T23:03:53.000Z",
"url": "https://pagar.ciabra.com.br/i/00000000-0000-0000-0000-000000000006"
}Formato de resposta de erro
Em caso de erro (cobrança não encontrada, token inválido, etc.), a API retorna um envelope com code (status HTTP) e message (descrição do erro).
{
"code": <código HTTP>,
"message": "<descrição do erro>"
}Status possíveis das parcelas
O campo _status de cada item do array installments pode assumir os valores abaixo:
| Valor | Descrição |
|---|---|
WAITING_PAYMENT | Aguardando pagamento. Estado inicial da parcela após a cobrança ser criada. |
CONFIRMED | Pagamento confirmado pela instituição financeira. |
REVERSED | Pagamento estornado. |