Used in Gateway Integration

Overview

Once all the API endpoints have been integrated, it should be possible to build a Pay1st Payment Link. This API uses the Hosted Payments Redirect URL pattern in order to complete payments on the Pay1st gateway.

Pre Requisites

The following needs to be in place before building a Pay1st Payment Link

The Payment Channels used should be configured in the Pay1st Console and obtained using the List Payment Methods API
A successful Create Payment Request needs to have taken place

API Description

URL Format

https://<payments_base_url>/checkout?channelId=<CHANNEL_ID>&reference=<REFERENCE>&accessToken=<ACCESS_TOKEN>

List of Query Parameters

These are the list of query parameters that needs to be passed from the Pay1st Partner to the Pay1st Gateway.

Name	Type	Description
channelId	String	This is the channelID. When this field is excluded, then the Customer will have the option to choose amongst all available payment methods.
reference	String	This is the Pay1st Reference from the response of the Create Payment Request API
accessToken	String	This is a URL escaped version of the Access Token that is used in the request