4 - Manual Refund
Manual Collection Order Refund
Through this API, it is possible to request the return of a settled Collection Order.
The return request will only be possible if the Collection Order is in status 9 - Settled.
Important:
- It will only be possible to request a return if the Collection Order corresponds to the CollectionOrderType:
- PixQrCodeDinamicDueDate = 0
- PixQRCodeDinamic = 3
- BoletoPixQRCode = 2 - Condition: Settlement must have been made PIX.
- It will not be possible to request a return if the Collection Order corresponds to the CollectionOrderType:
- Boleto = 1
- This request will only be made possible through API and is only available if the refund has occurred within the
90 days of the settlement date. This rule complies with the regulation of the Central Bank of Brazil.
API Method = RefundCollectionOrder
{
"Method": "RefundCollectionOrder",
"PartnerId": 30770,
"BusinessUnitId": 61847,
"DocumentNumber": 10247,
"Identifier": ""
}
Description:
Parameter | Description | Mandatory | Type | Comments |
---|---|---|---|---|
Method | Name of the method to be used | YES | STRING | None |
PartnerId | Partner identifier provided by FitBank | YES | BIGINT | None |
BusinessUnitId | Business unit identifier provided by FitBank | YES | BIGINT | None |
DocumentNumber | Operation document number | YES | INTEGER | None |
Identifier | ID Reference | NO | STRING | None |
Successful Response:
{
"Success": "true",
"Message": "ISI0001 - Collection Order refund request"
}
Collection Order with a status other than settled:
{
"Success": "false",
"Message": "EXC0002 - Collection Order Status does not allow Refund"
}
Updated 6 months ago