Consulta de detalhes do boleto
Changed onVerifique mais informações sobre determinado boleto através desta API
get/{invoice_id}
Request
- Base URLhttps://api.stage.cora.com.br/v2/invoices
- URLhttps://api.stage.cora.com.br/v2/invoices/{invoice_id}
- AuthOAuth 2
Path parameters
invoice_idstring required
ID da fatura na Cora. Esse ID precisará ser usado para consultar os detalhes da fatura.
Response
200
Example response
{
"id": "inv_D1CdW70OQbiCL1vkbaMErQ",
"status": "PAID",
"created_at": "2023-01-03T13:23:41Z",
"total_amount": 3000,
"total_paid": 3000,
"occurrence_date": "2023-01-03",
"code": "meu_id",
"customer": {
"name": "Gol Transportes Aereos Sa",
"email": "email@email.com",
"document": {
"identity": "34052649000178",
"type": "CNPJ"
},
"address": {
"street": "Rua Gomes de Carvalho",
"number": "1629",
"district": "Vila Olímpia",
"city": "São Paulo",
"state": "SP",
"complement": "N/A",
"zip_code": "00111222"
}
},
"services": [
{
"name": "Nome Do Serviço",
"description": "Descrição do serviço",
"amount": 3000,
"unit": "AMOUNT"
}
],
"payment_terms": {
"due_date": "2023-03-12",
"fine": {
"date": "2023-03-14",
"amount": 200
},
"interest": {
"rate": 3.67
},
"discount": {
"percent": 1.5
}
},
"payment_options": {
"bank_slip": {
"barcode": "00199928700000030000000003480462000004622617",
"digitable": "00190000090348046200900046226179992870000003000",
"our_number": "34804620000046226",
"registered": true,
"url": "https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-0e05ef46-3e22-4660-9438-521f17e852bf.pdf?generation=1672752221318114&alt=media"
}
},
"payments": [
{
"id": "fd1307b0-32f7-4a60-b058-d2973a6638db",
"status": "SUCCESS",
"created_at": "2023-01-03T13:32:56Z",
"finalized_at": "2023-01-03T13:33:02Z",
"total_paid": 3000,
"method": "BANK_SLIP",
"order": 1
}
],
"notifications": {
"id": "1d8e593f-5b91-4743-96c1-49a5c276d33d",
"channels": [
"EMAIL"
],
"destination": {
"name": "Fulano Ciclano Oliveira",
"email": "email@email.com"
},
"schedules": [
{
"rule": "NOTIFY_TEN_DAYS_AFTER_DUE_DATE",
"status": "CANCELED",
"scheduled_to": "2023-03-23"
}
]
}
}Changes
- info
api operation id
consultar-detalhes-de-um-boleto-v2removed and replaced withconsultar-detalhes-de-um-boleto - info
added the optional property
to the response with the status
- info