This document provides the integration details between the merchant & the PointCheckout systems. The integration allows the merchant system with its own shopping and order processing system to work in conjunction with PointCheckout system for the payments. The merchant would need the API credentials & the private secret key to access the PointCheckout API.
The process is outlined below:
When a customer is ready to pay for their order/shopping cart on the merchant system, a “Pay using PointCheckout / Card” option is presented.
On submitting the “Pay using Pointcheckout / Card” button, the merchant system processes the order & makes the “NEW CHECKOUT REQUEST” API call to PointCheckout & obtains a checkout key.
On successfully obtaining the token from PointCheckout in the previous step, the merchant system then redirects the customer to PointCheckout passing in this checkout key (See PAYMENT PAGE REDIRECT).
The customer then may either successfully complete the payment or cancel the payment.
In any of the cases in the previous step, the customer is finally returned to the merchant system.
Once the customer has been returned to the merchant system from PointCheckout, the merchant system makes the “GET CHECKOUT REQUEST” API call to retrieve the status of the payment and at this stage the checkout is now complete.
REQUIREMENTS
Below are the requirements that must be implemented in the shopping cart extension for PointCheckout.
Add a new Payment Method to the checkout page called Card payment or Pay using PointCheckout.
When the payment method to be used is POINTCHECKOUT, PointCheckout Logo from https://www.pointcheckout.com/en/image/logo.png must be presented to the customer at the payment page
Should support the following configuration options:
Support for Test / Live environments.
Ability to restrict payment to users from specific countries
Ability to restrict payment to users from specific user groups
Ability to configure new order status
SETTINGS SCREEN
The settings screen for the PointCheckout payment method should include at minimum the following configuration options.
SUPPORTED ENVIRONMENTS
The PointCheckout Payment Extension / Plugin should support the following two environments; Test and Production. Throughout the API, they will be referred to as $BASE_URL and the admin can select the current environment in the administrator settings screen.
API REQUESTS
There are two relevant API requests within the checkout process:
This requests sends the checkout details to the PointCheckout checkout service. It returns a unique checkout id that would be used for the processing of the payment.
The request is a JSON based object. It includes the following parameters
Grand Total = “subtotal” + “shipping” + “tax” – “discount”
Subtotal = Sum (item total) for all items.
Please consult with PointCheckout team on available payment methods for your account.
A valid customer email or phone number is required.
The response is a JSON based object. It has the following structure
Below is a sample request body for a “New Checkout” request.
Below is a sample response body for a “New Checkout” request.
Below is a sample response body for a “New Checkout” request.
This requests asks PointCheckout to send checkout updated, usually after a user is redirected back to the merchant website.
The Request URL may include the below parameters
The response is a JSON based object. It has the following structure
SAMPLE SUCCESSFUL RESPONSE BODY
Below is a sample response body for a “Get Checkout” request.
Below is a sample response body for a “Get Checkout” request.
A checkout can have multiple statuses that describe the current state that the checkout is in.
Once a user completes a transaction, the user is redirected to the merchant website to proceed with the payment. The user is redirected to resultyUrl passed in the “New Checkout” request. The response contains the following URL encoded parameters: