Integration with external payment gateway
The following steps explain the integration process flow between the Sterling Order Management System applications and external Payments Gateway to capture card-based payments such as debit cards, credit cards and gift cards.
- As the first step, the user interacts through a browser with one of the Sterling Order Management System applications to enter the order information.
- The payment information must be captured as part of gathering the order information. At this point, interaction with the Payment Gateway starts and a new session is created. Payment Gateway sends the URL for the iFrame to the Sterling Order Management System application. The payment page that is hosted by external Payments Gateway can be incorporated as an inline frame in the Sterling Order Management System payment screens.
- Internally, payment information is captured and submitted through the iFrame, which is
transparent to Sterling
Order Management System. This hosted payment page captures sensitive details such
as Credit Card Number, Expiry Date, and CVV code for credit cards and Store Value Card number for
gift cards.
The Payment Gateway can optionally redirect to the success or failure page.
- If the transaction is a success, then the payment token number, expiry date, last 4 digits of
credit card number must be mapped to Credit Card Number, Expiry Date, and Display Credit Card Number
fields respectively on the Sterling
Order Management System side. In case of gift cards, the tokenized gift
card number should be saved against the SVC number. After the payment method is saved in Sterling
Order Management System, users can be directed to a page, which indicates that the payment method is
successfully added.
If the transaction fails, in the failure page, you must retrieve the error details and display an appropriate message to the users. If the transaction is canceled, then the user must be taken back to the parent screen.
- The token number that is provided by the external Payments Gateway must be stored as Primary Account Number, Credit Card Number, or Store Value Card number in the Sterling Order Management System applications. This number must be used to refer to the payment method for all future interactions with the Payments Gateway (like sending a charge or authorization request)