Overview

This version of Pay1st Gateway integration is considered a major version upgrade and will contain breaking changes when compared to the previous versions of the Pay1st Gateway integration.

The migration will be discussed in a series of steps and will allow both versions of integrations to exist until the old integration can be decommissioned.

Step One - User Migration

The existing Pay1st Users should be migrated to become Partner Users.

Role Migration

Roles should be migrated as follows

Identify the existing Administator and Read Only users in the system
These roles should be migration with the help of the Pay1st Implementation Manager
For parallel testing, a salted email on an existing Administrator account should be used (e.g. pay1st-account@pay1st.com should use something like pay1st-account+test@pay1st.com)
- If salted emails are not possible, then any other email address that is not a Pay1st user can be used

Step Two - Product and Product Bundle Migration

Product and Product Bundles will not need to be migrated. These will be specified in the Create Payment Request API
- Partners needs to make sure that the SKU identifiers match their external system
- Partners needs to ensure that the new Pay1st Integration supports the same Payment Methods and their existing integrations (the channelIDs should still be preserved)

Step Three - Implementation Migration

There are some noteworthy items when it comes to migrating the implementation of a previous Pay1st Integration. As a general guideline, Pay1st Partners that are migrating implementation should only be aware of the differences, but still treat the migration as if it is new.

At this point, Get Started with the Gateway Integration should now be followed, and the Partner needs to be aware of the changes to User Validation and Summary Webhooks.

API Credential Migration

The following credentials will need to be shredded post integration completion

Basic Auth Token
Basic Auth Username
Basic Auth Password

These will be replaced with New Pay1st Gateway API Credentials

User Validation Migration

User Validation endpoints and its processing will not need to be migrated
The new gateway integration only facilitates payments, so It is expected that the partner will need to validate their users before payments can be initiated with the Pay1st Gateway

Summary Webhook Migration

In case the partner wants to reuse this functionality, Summary Webhooks will need to be replaced by Payment Webhook Events
The table below details the fields that needs to change when migrating from Summary Webhook to Payment Webhook Events

OLD Summary Webhook Field	NEW Payment Webhook Event Field	Notes
reference	reference
externalReference	partnerReference
playerId	customerId
productBundleId	N/A	There is no Product Bundle management in the new version of Pay1st Integration
productBundleExternalId	N/A	There is no Product Bundle synchronisation/mapping in the new version of Pay1st Integration
amount	orderAmount	This amount is no longer in CENTS
currency	currencyCode
tokensPurchased	N/A	There is no Product Bundle management in the new version of Pay1st Integration
digitalCurrency	N/A	There is no Product Bundle management in the new version of Pay1st Integration
status	status	The possible values are different. These are now `ABANDONED`, `CANCELLED`, `CHARGEBACK`, `FAILED`, `NEW`, `PAY_OFFLINE`, `PENDING`, `PENDING_INVESTIGATION`, `READY`, `REFUND`, `SEND_BIRTHDAY`, `SEND_PHONE`, `SEND_PIN`, `SEND_OTP`, `SEND_VALIDATION_TOKEN`, `SUCCESSFUL`, `VALIDATED`

Step Four - Decommissioning the Old Pay1st Integration Implementation

Decommissioning can only occur when

The new Pay1st implementation is running in both staging and production environments
At least one external report has been successfully generated with the new data

The decommissioning steps are as follows

There should only be one Administrator user enabled, this user will only be present for purposes of auditing tasks and viewing transaction history
If there are any users who do not form part of the partner users, these would need to be marked as deleted
All Products and Product Bundles will need to be marked as deleted
Blank out and shred the Basic Auth Token, Basic Username and Basic Password for all Partner Products