Charge Maintenance
The charge write-off /void order does not make it impossible to receive payments that have already been made.
Partial Charge Update example [PATCH]
https://apisandbox.delbank.com.br/baas/v1/charges/correlationId
Delbank currently provide the partial update of the charge, thus being able to change Its due date.
Request Headers and Body
Content-Type:application/json
x-delbank-api-key:Api Key
{
"walletNumber": "112",
"yourNumber": "SEUNUMERO",
"amount": 10,
"dueDate": "2022-06-13",
"payer": {
"name": "FULANO CICLANO",
"document": "16166823533",
"zipCode": "49010030",
"address": "AV. RIO BRANCO, 186",
"neighborhood": "CENTRO",
"state": "SE",
"city": "ARACAJU"
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "yyyy-MM-dd",
"amount": 0
},
{
"date": "yyyy-MM-dd",
"amount": 0
},
{
"date": "yyyy-MM-dd",
"amount": 0
}
]
},
"lateFine": {
"type": "Percentage",
"date": "yyyy-MM-dd",
"amount": 0
},
"latePayment": {
"type": "Percentage",
"date": "yyyy-MM-dd",
"amount": 0
},
"allowPartialPayment": false
}
Response Header
Content-Type:text/plain
Obs.: Failed requisistions will have the following HTTP and body:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-d4f01e7c0b935601aa07789983ec6228-6fffc4c2b5f642dc-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
]
}
}
Charge write-off /void order [POST]
https://apisandbox.delbank.com.br/baas/v1/charges/correlationId/void
Endpoint to write-off/cancel the charge.
Request Header
x-delbank-api-key:Api Key
Response Header
Content-Type:application/json
Obs.: Failed requisistions will have the following HTTP and body:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"traceId": "00-8a3919c1917bff4f84367110dcf0680a-e156f57e8851b5be-00"
}