Skip to main content

Cancel Reservation


This API allows your application to cancel a specific reservation. By providing the order's unique ID and a reason for the cancellation, you can programmatically update the order's status.

Endpoint

GET

Request

the request a

Endpoint

:

https://demo-api.frontpayment.no/api/v1/connect/reservations/reservations/cancel/{{RESERVATION_UUID}}

Method

:

POST

Authorization

:

Bearer

Payload Validation

:

 

'note' => 'required|string'

Authorization

To access this endpoint, include a Bearer Token in the Authorization header of your request. You can obtain this token from Frontpayment.

Example PayloadAuthorization Header: Authorization: Bearer YOUR_FRONTPAID_BEARER_TOKEN

Payload

:

Send 		following

parameters as a JSON object in the request body:

{
    "note": "TestYour Cancellationcancellation Note,Note Replace by Real One"here"
}

Validation Rules

Make sure your request meets the following requirements:

FieldTypeDescription
notestringRequired Reservation cancellation note.

Response

ResponseA Structure

successful 		will

:

return 		202

status with the following JSON payload:

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

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

{
    "status_code": 404,
    "status_message": "Not Found",
    "message": "orderNotFound",
    "is_error": false,
    "errors": 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"
}
{
"status_code":

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

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

Reservation status is already EXPIRED and NOT IN SENT or RESERVED NOT PAID

{
    "status_code": 400,
    "status_message": "Conflict of Business Logic",
    "message": "prerequisiteFailedToCancelReservation",
    "is_error": false,
    "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"
}

 

Example Response

:

 

 

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

 

Back to top