Amending passenger name

High level example API flow for amending passenger name

This functionality allows you to amend a passenger’s name. Any amendment must stay within the limits set by the airline.

Amending a passenger’s name takes at least 7 steps:

  1. Check what changes are supported - GET /v1/servicing/passenger/changeName/rules?supplierCode=BAE&supplierBookingReference=abcd

    • Response will list the passengers and the supported changes for each passenger
    • Response will indicate approximate fees per change and the rules (constraints) for each change
      • maxChangedCharactersTotal is the total number of characters you can change across the sum of applicableFields per passenger. If for example each name field has its own airline imposed limit then the rules will be repeated once per name field type.

  2. Quote - Request a quote for amending name(s) for one or more passengers - POST /v1/servicing/passenger/changeName/quote?supplierCode=BAE&supplierBookingReference=abcd

    • Set the request URL parameters as appropriate
    • NOTE request body has been omitted from this example
    • The request body must list each passenger that you wish to amend and the fields that you wish to amend with their respective new values
      • Each passenger is identified by their DID. To find the DID for a given passenger check the rules response
    • If initially successful the response will then need polling

  3. Poll for quote response - GET /v1/servicing/passenger/changeName/quote/poll?asyncOperationToken=b3604d53-2e29-4d03-923d-565a98d7ad1e

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

  4. Prepare - Provide payment details to get a final price - POST /v1/servicing/passenger/changeName/prepare?transactionId=78dfe432-5159-490f-82ea-a63b90e77693

    • NOTE request body has been omitted from this example
    • transactionId is from the previous response

  5. Poll for prepare response - GET /v1/servicing/passenger/changeName/prepare/poll?asyncOperationToken=79c2b2e0-b982-4d27-8179-d03cbdd64142

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

  6. Execute - Request amendment be performed - POST /v1/servicing/passenger/changeName/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.

  7. Poll for execute response - GET /v1/servicing/passenger/changeName/execute/poll?asyncOperationToken=0f2430a8-7500-416f-9877-923370f5ddb6

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