Use this API to build the payment links which are to redirect from your application/game to our pay1st gateway.
Used in Gateway Integration
Overview
Once all the API endpoints have been integrated, it should be possible to build up a Pay1st Payment Link. This APi uses the Hosted Payments Redirect URL pattern in order to initialise and complete payments on the Pay1st gateway.
Typically, the configuration that has been configured on the Pay1st Admin console needs to be used in order to build a valid Pay1st Payment Link.
Pre Requisites
The following needs to be in place before building a Pay1st Payment Link
- In Pay1st Console
- The Product Bundles needs to be configured and needs to be in an
Activestate - All the callback URLs needs to have been implemented (Successful, Pending and Failure)
- The Product Bundles needs to be configured and needs to be in an
API Description
URL Format
https://<payments_url>/payment?username=<USERNAME>&platform=<PLATFORM>&productBundleId=<PRODUCT_BUNDLE_ID>&countryCode=<COUNTRY_CODE>&externalReference=<EXTERNAL_REFERENCE>&amount=<AMOUNT>¤cyCode=<CURRENCY_CODE>&headless=<TRUE>&partnerSource=<PARTNER_SOURCE>&quantity=<QUANTITY>&isPay1st=<TRUE>&channelId=<PAYMENT_METHOD_ID>
List of Query Parameters
These are the list of query parameters that needs to be passed from the Pay1st Partner to the Pay1st Gateway.
| Param | Format | Description |
|---|---|---|
| username | String | The user identity. This should be a unique identifier used to identify the user in the Pay1st Partner’s system. |
| platform | String | The mobile platform is used to load the Platform. Use WEB for payments from web applications. |
| productBundleId | Long | The bundle identifier as configured in Pay1st Console. |
| countryCode | String | The ISO-2 country code, e.g. ZA |
| externalReference | String (Optional) | The Pay1st Partner reference that needs to be used for reconciliation. This value will be sent back via the Summary Webhook API Call |
| amount | Decimal (Optional) | The amount to pay. |
| currencyCode | String (Optional) | The currency code for the amount. |
| partnerSource | String | The source that identifies the partner. |
| quantity | Decimal | The quantity of product bundle being bought. |
| isPay1st | Boolean | The value of this attribute should be set to true |
| channelId | Long | The ID of the payment method. The ID values can be retrieved via List Payment Methods |
| isHeadless | Boolean | The value of this attribute should be set to true |