End to End Payment via Settlement Plan

Description

This use case illustrates the flow whereby a customer shops with a Seller. During the shopping and pricing phases, the airline provides the seller with a series of payment options and the seller determines that payment for the specific order will be by way of a pre-existing settlement plan. The seller proceeds to create and pay for an order using the settlement plan. The payment is accepted and the order is confirmed.

Capabilities Demonstrated

Preconditions

  • Airline supports settlement via a Settlement Plan (e.g. BSP or ARC)

  • Seller is accredited with the Settlement Plan

  • Seller has sufficient credit with the Settlement Plan

Main Flow

Step 

Message 

Description 

01.1

AirShoppingRQ 

Seller submits travel plan(s) on behalf of a customer.

01.2

AirShoppingRS 

Airline responds with Offers and includes a catalogue of supported methods of payment and related payment fees.

02.1

OfferPriceRQ 

Seller requests price for the selected Offer/OfferItem(s) and expresses an intent to use a Settlement Plan. 

02.2

OfferPriceRS 

Airline responds with a priced offer with a specific price for settlement plan.

03.1

OrderCreateRQ 

Seller requests to create the order, stating their preference to pay using a settlement plan.

03.2

OrderViewRS 

Airline notifies Seller that the order is created and that payment via settlement plan is still a supported payment option, among others.

04.1

OrderChangeRQ 

Seller commits to pay for the order, passing settlement plan details.

04.2

OrderViewRS 

Airline notifies seller that the payment is “SUCCESSFUL” and the order is considered as paid.

Post Condition 

  • Airline has successfully taken into account the Seller’s commitment to pay via a Settlement Plan.

  • Seller is in receipt of an Order.

Data Elements 

Shop 

The table below is a non-exhaustive list of some of the functions used to illustrate this use case. 

Message 

Object 

Details 

AirShoppingRS

PaymentSupportedMethod

Used to list the various payment methods supported by the Airline, optionally including additional data, such as surcharges, brand codes, etc.

 Pricing

Message 

Object 

Details 

OfferPriceRQ
 

 

Payment type 

Optionally indicates a payment method that the seller may provide at time of purchase 

OfferPriceRS 

 

PaymentSupportedMethod

Used to list the various payment methods supported by the Airline, optionally including additional data, such as surcharges, brand codes, etc.

Order 

Message 

Object 

Details 

OrderCreateRQ
 

 

Payment type 

Optionally indicates a payment method that the seller may provide at time of purchase 

OrderViewRS
 

 

PaymentSupportedMethod

Used to list the various payment methods supported by the Airline, optionally including additional data, such as surcharges, brand codes, etc.

Pay

Message 

Object 

Details 

OrderChangeRQ
 

 

Settlement Plan 

Indicates payment will be via Settlement plan 

IATA Number

Indicates an IATA Number agency reference number

 

Amount

Amount agreed to be paid by the Seller, including currency

 

OrderRefID

Reference to the Order being paid

 

OrderItemRefID

Reference to the OrderItem(s) being paid

 

Payment Type Code

Confirms the Method of Payment (“CA”)

OrderViewRS
 

 

Payment ID 

Provides a unique reference for a given payment transaction

Payment Status 

Indicates the status of the payment transaction

 

Message Trace

  File Modified

XML File 01.1_AirShoppingRQ.xml

15 Jan 2024 by Vanni Sanvincenti

XML File 01.2_AirShoppingRS.xml

15 Jan 2024 by Vanni Sanvincenti

XML File 02.1_OfferPriceRQ.xml

15 Jan 2024 by Vanni Sanvincenti

XML File 02.2_OfferPriceRS.xml

15 Jan 2024 by Vanni Sanvincenti

XML File 03.1_OrderCreateRQ.xml

15 Jan 2024 by Vanni Sanvincenti

XML File 03.2_OrderViewRS.xml

15 Jan 2024 by Vanni Sanvincenti

XML File 04.1_OrderChangeRQ.xml

15 Jan 2024 by Vanni Sanvincenti

XML File 04.2_OrderViewRS.xml

15 Jan 2024 by Vanni Sanvincenti