v1
latestOpenAPI 3.1.02026-07-24890394.2 KBDar baixa em cobrança
Este recurso efetua a baixa de uma cobrança.
patch/charges/{charge_uuid}/paid_externally
Path parameters
charge_uuidstring required
uuid da cobrança.
Response
200
Example response
{
"data": {
"id": "2c2dbc6e-91a8-4ad3-9511-1e8b03a00851",
"type": "charge",
"attributes": {
"createdAt": "2023-12-06T17:46:50.584-03:00",
"updatedAt": "2023-12-07T15:32:33.519-03:00",
"status": "paid_externally",
"paymentMethod": "boleto",
"dueDate": "2023-12-10",
"value": 699.09,
"discount": {
"range": "2023-12-09",
"discountType": "percentage",
"discountValue": 5
},
"abatementValue": 5.2,
"interestType": "percentage",
"interestValue": 2,
"applicableFine": 2,
"updateStatus": "completed",
"updateDetails": [
{
"field": "dueDate",
"status": "success",
"previousValue": "2026-01-11",
"newValue": "2026-02-22"
}
],
"payer": {
"data": {
"type": "payer",
"attributes": {
"name": "Joseu dos Santos",
"documentNumber": "74510367660",
"email": "dwight.schrute@dunder-mifflin.paper",
"address": {
"street": "Rua Dr. Albuquerque Lins",
"number": "2222",
"complement": "Apt 222",
"zipCode": "01230-000",
"neighborhood": "Santa Cecília",
"city": "São Paulo",
"state": "SP"
},
"phone": {
"countryCode": "55",
"areaCode": "51",
"number": "995562211"
}
}
}
},
"grantor": {
"data": {
"type": "grantor",
"attributes": {
"name": "Harry M. Lopes",
"documentNumber": "12705274000165",
"address": {
"street": "Rua Dr. Albuquerque Lins",
"number": "22",
"complement": "Apt 222",
"zipCode": "01230-000",
"neighborhood": "Santa Cecília",
"city": "São Paulo",
"state": "SP"
}
}
}
},
"fees": {
"data": [
{
"id": "109553",
"type": "event",
"attributes": {
"kind": "charge_boleto_pix_registered_cost"
}
}
]
},
"boleto": {
"data": {
"id": "a1059a8b-70e9-436f-b482-4c94d6a20b6c",
"type": "boleto",
"attributes": {
"ourNumber": 13089,
"ourNumberDv": "7",
"barCode": "27491956000000699090001010000001308981246950",
"emv": "00020101021226970014br.gov.bcb.pix2575qr-h.cornerpix.com.br/11581339/v2/cobv/a051cdfe-5356-4555-8572-7add17c932695204000053039865802BR5914BMP MONEY PLUS6009SAO PAULO62070503***6304B0D3",
"image": "iVBORw0KGgoAAAANSUhEUgAAAhIAAAISAQAAAACxRhsSAAAE4ElEQVR4nO2dTW7jOBCFX40EZEkBfQAfRbpBH6nhm0lHyQECiMsAFGoWrCIpuztpoB21xvO4CGxK+UAChWL90qL407H888cIgAwyyCCDDDLIIIMMMipDbPQQGQCZYm9zE7b8AMAmMgGQKfr704PXQQYZHzJGVVVdAQCb6PWSAIQEAJ1i1JQFWGdsojM6VVXVPeMR6yCDjA8ZsWhHABhXQGcAWKS3T+PaNbEB17GPXgcZZPw2QybY4a8zNhEZNtHrALcKjloHGWTY6G++6/K9UyB+SwAAybMx26e92qfHr4MMMn6HEVR1hivLZQB0zqapqluqAJaLvaeq6ZbxiHWQQcZPR+sQodNshn72x98fVVXns+yFjOdlZDndjdQ+Nn1qWrTONYNySsaXM1yfBlXA4013Jzs6m5tDyg8sBkA5JeMQRnPu7ywAeHAqJJfOFVD14BTllIwjGSado6rZncUMzfp0bNSrvecWQFG+Z9kLGc/LQD3oMebzvLPMVKNPy8umWbudkXCWvZDxvIydH1VU6RxSFtvsQmVxLMGp7Ft51IpySsbXM1BFVOfqTK1djpqaVbq3ChCKpUA5JeMQBqqyzIH9Zg4wOTVnqkStQrEPKKdkHMIoMllLoLpGWXro1Nwql91qGlBOyTiCkdP1grBCgC4p4iC6SJd0GVbYUwAyzgAQ3poEvz5uHWSQ8TlD59i745QP/02AKKL6WuXSvCyRAWiSpyfbCxnPyGicpBrJ94rpMkJqAqs7W4DnPhlHMFp/v7VUU/Htzem3gNUuGkD7lIyDGG6fovNaUwBYvr9BEQEg9hAEhSC8CxDexP4hsp6fjMMYRZ8CTUi0zVHpLqG/1jnG+ck4mCFySShl+4KlNj+5gyVTUNXr0M49fB1kkPERwzL4IQGLvKj8WDexWr+QgGXoVHXdxLz8PPcF6yCDjF+M5owH0Jzsnkb1rzkzhbbplP4+GQcxSr2e15yYJHb7OVj5VAkEaFP1d5a9kPG8DLNDF+lUEAWKsELNSLWMkwBdyk6/JaXeBaia9Sx7IeN/wNjEKveiSO43VVXFMmyiMzYLWi0DoNehay2F8+2FjCdlWOg+9gBCgkyweyY8BuBPc1LqtYdMft3U2fZCxjMySl1faeYLbfy0lkX5y6m4VYyfkvF3GFGk3jQlU9asneocxa2CUqWyXBg/JeMwRuk7Sa47b/pOSrmJvXLj/lOfknEE466pZKxNeit2JShFdsttfpRTMg5ilK59tzb3bfp2tVTpMs2WavCIK+1TMo5kZP+oNU3fxYQwvmiuoraxCcZXEb3KiwenzrUXMp6Rcdu/X2+c8DZp7NOotS+V5z4ZBzPkh5Z6KY/zy1TLTVyf6hzeRaYoOR8l04PXQQYZvxi6HygO/l2bPtpbpdi/T8bxjPp7J1ljivTIhXzwpFRWr2PJWy28n5+MwxnF1c+38udP8Dao5dJeMuVtfV+xDjLI+Pm4j5+iOE43F0rtPuVYFc99Mv4KQ68XVTvUY28JqOuwiaWnokjNR8n0Zesgg4x23P18yfjap1x/irD68R5fVBAHACH1uRx1EdafknEYo71/1zJO9ZIzS+ibQeAPqmnKc5+Mgxh3v3eCUC/f93sl6+0SY3MfBZg3JeMohujn73wylrPshQwyyCCDDDLIIIOM/z7jXx3CtBBVPQ5PAAAAAElFTkSuQmCC",
"quickPdfUrl": "https://grafeno-pagamentos-carrierwave-staging.s3.amazonaws.com/uploads/bmp/boleto/28879/file/10-12-2023_-_VIVI_ATUAL__NF__-_Joseu_do_Protesto_novo_-_53807.pdf?X-Amz-Expires=259200&X-Amz-Date=20231207T183233Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6GUDBFRJDLS2JG7S%2F20231207%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=93e7834406732bbf9bb77d23fd62a83387b2cd7624a480b2cbf77362b9d7bbc3",
"lineCode": "27490001011000000130489812469503195600000069909",
"registrationStatus": "registered",
"pdf": "https://pagamentos.grafeno.be/charges/2c2dbc6e-91a8-4ad3-9511-1e8b03a00851/download_boleto",
"yourNumber": "88993322",
"registrationMethod": "online",
"messagingRuleId": "589f899a-9650-45ce-aeda-937f49c27156",
"observation": "Sr(a) caixa, não receber o boleto após o vencimento"
}
}
},
"clientControlNumber": "7543649847645556555553425",
"origin": "api",
"receiptNumber": "51080701212344000127550010000000981364117781",
"expiresAfter": 90,
"titleType": "monthly_tuition"
}
}
}