5 - Canceling
Cancelling a Payment Order
The Payment Order client may, at any time, request the cancellation of an issued Payment Order.
Important:
The cancellation request will be accepted when the payment order is in the following statuses: Created, Verifying, Pending or CanBePreAuthorized.
API Method = CancelPaymentOrder
{
"Method": "CancelPaymentOrder",
"partnerId": 299,
"businessUnitId": 441,
"TaxNumber": "72522358073",
"PaymentOrderId": 123456
}
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 |
| TaxNumber | User's Social Security Number | YES | STRING | None |
| PaymentOrderId | Operation document number | YES | INTEGER | None |
Successful Response:
{
"Success": "true",
"DocumentNumber": 14147,
"Message": "ISI0468 - Canceled Payment Order."
}
Failure Response:
{
"Success": "false",
"Message": "API0011 - Information sent is invalid. See json Validation property for more details",
"Validation": [
"string"
]
}
PaymentOrder Status
| Status | Title | Description |
|---|---|---|
| 0 | Created | Created Payment Order |
| 7 | Verifying | Beneficiary of the Payment Order pending validation |
| 17 | Pending | Payment Order exceeded maximum amount |
| 13 | CanBePreAuthorized | Payment Order fees are about to be charged |
Updated over 1 year ago
Did this page help you?