API Reference

Use this checklist to track your progress or to plan ahead

Gateway Integration Overview

This integration extends on the Shop integration and allows the Pay1st Partner to use the Pay1st Gateway in their own app, game client, or web store.

The steps in this integration style involve:

Pre Requisites

These are the pre-requisites that are needed from the Pay1st Partner

  • A list of users/email addresses that would need to be invited to the Pay1st Admin Console
  • A communication method to be set up: Slack is preferred, but alternative communication tools (WeChat, Skype, Teams, Telegram, etc.) can be used as well

Checklist

The following table is a checklist that can be used for tracking progress or for project management purposes:

Estimated
Time (in days)
TaskTeam Members
~0.5dAll supplied email addresses will receive a welcome email from Pay1st. The steps in this email need to be completed to complete registrationPay1st Partner
~2dThe Pay1st Implementation Manager will work with the Pay1st Partner to help configure their products and bundles (SKUs). The Pay1st Partner will need to decide on

- Which countries should be enabled for the listed products
- The pricing model for the bundles
Pay1st Partner and Pay1st Implementation Manager
~0.5dConfigure the fulfilment method for the listed productsPay1st Partner
~2dImplement the User Info WebhookPay1st Partner’s Development Team
~3dImplement the Summary WebhookPay1st Partner’s Development Team
~1dImplement the Success, Failure and Pending callback URLs in order for Pay1st to redirect back to the Pay1st Partner’s app/game client/web store correctlyPay1st Partner’s Development Team
~1d(Optional) Call the Query Payment Status API if it is required to keep track of the status of a payment (in addition to the payment callback URLs that we redirect to). This API requires credentials which can be obtained from the Pay1st Implementation ManagerPay1st Partner’s Development Team
~1d(Optional) If payment method selection is required, then theList Payment Methods API needs to be integrated. This API requires credentials which can be obtained from the Pay1st Implementation ManagerPay1st Partner
~2dBuild a Pay1st Payment Link from the Pay1st Partner’s app/game client/web store so that customers can make payments on the Pay1st GatewayPay1st Partner’s Development Team
~1dDo a full end to end test transaction in the Sandbox/Staging EnvironmentPay1st Partner and Pay1st Implementation Manager
~1dReplicate the staging product and product bundle configuration for productionPay1st Partner or Pay1st Implementation Manager
~0.5dDo a UAT production test using this configurationPay1st Partner or Pay1st Implementation Manager
Go Live!