Cancelling an order

High level example API flow for cancelling an order

Tip

Note

Request and response bodies are omitted from this example. Check the reference docs.

Tip

PaxFaB Servicing will attempt to cancel the order in a cost efficient manner. This can include voiding an order where supported.

Tip

For consistency and future-proofing this flow has the same concepts of payment and prices as other transaction based flows. A present the only likely scenario to encounter is a newPayment.totalAmount of zero (if the agent is owed no money) or less than zero (if the agent is owed money) and a corresponding payment method type of NO_PAYMENT (as the agent is not paying the airline).

Cancelling an order takes at least 6 steps:

Quote - Request a quote for cancelling the order - POST /v1/servicing/orderCancel/quote?supplierCode=BAE&supplierBookingReference=abcd
- Set the request URL parameters as appropriate
- If initially successful the response will then need polling
Poll for quote response - GET /v1/servicing/orderCancel/quote/poll?asyncOperationToken=b3604d53-2e29-4d03-923d-565a98d7ad1e
- asyncOperationToken is from previous response
- Multiple polls may be required
Prepare - Provide payment details to get a final price POST /v1/servicing/orderCancel/prepare?transactionId=78dfe432-5159-490f-82ea-a63b90e77693
- transactionId is from the previous response
Poll for prepare response - GET /v1/servicing/orderCancel/prepare/poll?asyncOperationToken=79c2b2e0-b982-4d27-8179-d03cbdd64142
- asyncOperationToken is from previous response
- Multiple polls may be required
Execute - Request cancellation be performed - POST /v1/servicing/orderCancel/execute?transactionId=78dfe432-5159-490f-82ea-a63b90e77693
- NOTE request body has been omitted from this example
- expectedPriceAmount & expectedPriceAmountCurrency in request body must be correctly set based on totalPrice from previous response
  - This validates that you agree with PaxFaB Servicing’s calculations
- expectedPaymentAmount & expectedPaymentAmountCurrency in request body must be correctly set based on newPayment.totalAmount from previous response.
  - This validates that you agree with PaxFaB Servicing’s calculations
- Payment details must be provided in request. If these differ than at prepare undefined behaviour may occur.
Poll for execute response - GET /v1/servicing/orderCancel/execute/poll?asyncOperationToken=0f2430a8-7500-416f-9877-923370f5ddb6
- asyncOperationToken is from previous response
- Multiple polls may be required