Documentation
How you can integrate with our Express Gateway Payment Service
Make sure that the merchant profile is enabled for the Express Gateway Service We recommend that you switch on Notifications for the service, so that you and the payer can both receive email notifications for a successful payment.
It is very simple to request an Express Checkout Interaction Use the Initiate Checkout operation Include payment and interaction data with completion instruction For example, see the code snippet to the right:
A successful response to this operation will contain session.id and successIndicator parameters. You can save the value returned in the successIndicator parameter on your shop system to verify the success or failure of the payment.
- Reference the checkout.min.js file from the gateway servers. This will place a Checkout object into global scope. If you are enabled for both Authorization and Purchase transaction types, you must use Express Gateway version 52 or above.
- Call Checkout.configure(), passing in a JSON object that includes the returned session.id and other request parameters. Data passed in Checkout.configure() will never overwrite data you provided in the Initiate Checkout operation.
Use one of the following methods to start the payment process
Callbacks can handle events that occur during the payment process. Using callbacks is optional, but if used, they must be defined in the body of the same <script> tag that references checkout.js. All defined callbacks must have an implementation which will be invoked when the relevant event is triggered
After the payment interaction is completed, you can redirect the payer to your shop site and generate your own receipt for the payer, and update your shop system with the payment details. To return the payer to your shop site you can either
You can determine the success of the payment by comparing the resultIndicator parameter to the successIndicator parameter returned in the Initiate Checkout response. A match indicates that the payment has been successful.
Note: The value in the resultIndicator parameter must never be used as the receipt number
Express Gateway allows you to control information displayed about your business and the transaction using either the Initiate Checkout operation or the Checkout.configure() method. Data provided in the Initiate Checkout request will always take precedence over data provided in the Checkout.configure() method. For enhanced security, we recommend that you provide data in a session using the Initiate Checkout operation
With Express Gateway Integration Ver. 57 or later, you must select 3-D Secure Authentication from the Payer Authentication Dropdown in the Admin > Integration Settings page of the Merchant Administration user interface.
For gift cards and Automated Clearing House payments, Express Gateway supports only payment details verification.
You can do this by setting interaction.operation=VERIFY in the Initiate Checkout request.
Express Gateway API Integration
You can determine the success of the verification operation by comparing resultIndicator to successIndicator.
If the interaction was not successful, Express Gateway displays a message indicating that verification has failed and prompts the payer to try again.