Cancel Terminal Order

Authorization

Include a Bearer Token in the Authorization header. You can obtain this token from Front Payment.

Example:

'type'=>Authorization: 'required|string'Bearer YOUR_FRONTPAYMENT_BEARER_TOKEN

Request Payload

Send the following parameters as a JSON object in the request body:

{
    "type": "payment"
}

Validation Rules

Make sure your request meets the following requirements:

Response Structure

A successful request will return a 200 OK status with the following JSON payload:

// Success
{
    "status_code": 200,
    "status_message": "OK",
    "message": "cancelledOrderSuccessfully",
    "is_data": false,
    "data": null
}
//

API returns a 404 error, it means requested order with ORDER_UUID could not be found in our system.

{
    "status_code": 404,
    "status_message": "Not Found",
    "message": "orderNotFound",
    "is_data": false,
    "data": null
}

API returns a 417 error, it means requested payload is not valid.

{
    "status_code": 417,
    "status_message": "Client Error",
    "message": "payloadValidationErrors",
    "is_error": true,
    "errors": "Array"
}
{

API 404,return "status_message":a "Not400 Found",error, "message":it "orderNotFound",means "is_data":your false,requested "data":order nullis }already PAID.

{
    "status_code": 400,
    "status_message": "Conflict of Business Logic",
    "message": "orderStatusAlreadyPaid",
    "is_data"is_error": false,
    "data"errors": null
}

API returns a 510 error, it means something failed on the server side

{
    "status_code": 510,
    "status_message": "Execution Exception Occurred",
    "message": "somethingWentWrong"Something Went Wrong",
    "is_error": true,
    "errors": "Array"
}

{
    "status_code": 200,
    "status_message": "OK",
    "message": "cancelledOrderSuccessfully",
    "is_data": false,
    "data": null
}