Payment flows

This page gives a summary of the payment flows within Connect. For details on each scenario, refer to the Payments section.

Standard payment flows

Paying externally

In the scenario where a client application processes a payment itself, Connect merely records the external payment for reporting or auditing purposes. The order is then completed.

• V1.Ticketing.ExternalPaymentStarting
  • AutoCompleteOrder parameter is set to false
  • The order will be marked as being paid externally, and the the before it is considered stale will be increased (preventing the order from being cancelled before the payment has been completed).
• V1.Ticketing.CompleteOrder
  • PerformPayment parameter is set to false
  • Details of original payment(s) (including masked card number, bank reference etc.) are optional but useful to provide

Paying with Vista cinema payment module

Vista can process payments via the payments module running at the cinema location.

We do not recommend this option for credit or debit card payments, as it requires transmission of full card details through the system.

• V1.Ticketing.CompleteOrder
  • PerformPayment parameter is set to true
  • Full payment details required by the payment system are provided and passed to payment provider, but never stored in Vista.

Paying with vista gift cards and/or Vista loyalty points

An order can be paid for using gift card and/or Loyalty points payments. For these two payment options the Vista Vouchers & Gift Cards and Loyalty systems operate as payment providers much like any bank or payment service would, and are configured the same way to run via the Vista Cinema Payment module. For more information on paying with Loyalty points, see Loyalty Points Payments.

The call flow for this scenario is therefore identical to paying with credit/debit cards via the Cinema Payment Module.

• V1.Ticketing.CompleteOrder
  • PerformPayment parameter is set to true
  • Gift card and/or Loyalty card details are provided and passed to payment provider, but never stored in Vista.

Paying with Vista web payment module

The Vista Web Payment Module is a service offering redirect-style payments. In these cases the customer is redirected to an external, trusted website to perform a payment and then redirected back to the client application to see their order completed.

• V1.Ticketing.ExternalPaymentStarting
  • AutoCompleteOrder parameter is set to true
  • Returns the URL the customer should redirect user to

    The user is redirected to the external payment system. Once the payment has been completed, the user is redirected back to the client application, with the complete order process initiated in parallel.

• V1.Ticketing.GetOrderDetails
  • Once back on the client application, this end-point should be polled to confirm the order has been completed

Combined payment flows

Connect supports the ability to combine payment methods for a single order. The most typical example of this is when a customer exhausts their gift card balance or Loyalty points balance, and then pays the remainder with a credit or debit card.

Combined external payment flow

External payments can be combined with gift card and/or Loyalty points payments. Any gift card and Loyalty points payments must be applied before starting the external payment.

Note: The external payment must cover the full amount remaining to be paid the order (excluding the amount paid by gift cards and Loyalty points payments).

• V1.Ticketing.ApplyGiftCard (optional)
  • Apply gift card for amount to be paid by gift card
• V1.Ticketing.ApplyLoyaltyPointsPayment (optional)
  • Apply Loyalty points payment for amount to be paid by Loyalty points
• V1.Ticketing.ExternalPaymentStarting
  • AutoCompleteOrder parameter is set to false
• V1.Ticketing.CompleteOrder
  • PerformPayment parameter is set to false
  • External payment details are provided for the remaining amount to be paid
  • Applied gift cards and Loyalty points payments will be automatically processed and the external payment details will be recorded as usual

Combined cinema payment module flow

The standard Cinema Payment Module flow already allows the payment total to be split across multiple payment types, including gift card and Loyalty points payments.

It is also possible to apply any gift card and/or Loyalty points payments before starting the Cinema payment using the ApplyGiftCard and ApplyLoyaltyPointsPayment end-points.

• V1.Ticketing.ApplyGiftCard (optional)
  • Apply gift card for amount to be paid by gift card
• V1.Ticketing.ApplyLoyaltyPointsPayment (optional)
  • Apply Loyalty points payment for amount to be paid by Loyalty points
• V1.Ticketing.CompleteOrder
  • PerformPayment parameter is set to true
  • Gift card and/or Loyalty card details can also be provided here, along with debit/credit card details

Combined web payment module flow

• V1.Ticketing.ApplyGiftCard (optional)
  • Apply gift card for amount to be paid by gift card
• V1.Ticketing.ApplyLoyaltyPointsPayment (optional)
  • Apply Loyalty points payment for amount to be paid by Loyalty points
• V1.Ticketing.ExternalPaymentStarting
  • AutoCompleteOrder parameter is set to true
  • Returns the URL the customer should redirect user to
• The user is redirected to the external payment system
  • Once payment has been completed, the user is redirected back to the client application and the complete order process is initiated
  • Applied gift card and Loyalty point payments will automatically be processed during order completion
• V1.Ticketing.GetOrderDetails
  • Once back on the client application, this end-point should be polled to confirm completion of the order
  • The payment status of any applied gift cards and Loyalty points payments will be shown