Ticketing an order

High level example API flow for ticketing a held order

Ticketing an order takes at least 6 steps:

  1. Quote - Request a quote for ticketing the order - POST /v1/servicing/heldTicket/quote?supplierCode=BAE&supplierBookingReference=abcd

    • Set the request URL parameters as appropriate
    • If initially successful the response will then need polling
  2. Poll for quote response - GET /v1/servicing/heldTicket/quote/poll?asyncOperationToken=b3604d53-2e29-4d03-923d-565a98d7ad1e

    • asyncOperationToken is from previous response
    • Multiple polls may be required
  3. Prepare - Provide payment details to get a final price - POST /v1/servicing/heldTicket/prepare?transactionId=78dfe432-5159-490f-82ea-a63b90e77693

    • NOTE request body has been omitted from this example
    • transactionId is from the previous response
  4. Poll for prepare response - GET /v1/servicing/heldTicket/prepare/poll?asyncOperationToken=79c2b2e0-b982-4d27-8179-d03cbdd64142

    • asyncOperationToken is from previous response
    • Multiple polls may be required
  5. Execute - Request ticketing be performed - POST /v1/servicing/heldTicket/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.
  6. Poll for execute response - GET /v1/servicing/heldTicket/execute/poll?asyncOperationToken=0f2430a8-7500-416f-9877-923370f5ddb6

    • asyncOperationToken is from previous response
    • Multiple polls may be required