Card Migration (Old API)

Overview

This guide will walk you through the steps required to migrate your card data from our old API (Core API) to our REST API, ensuring a smooth and hassle-free experience for both you and your customers.

Why migrate to our new API?

Migrating your card data to our REST API offers numerous benefits, including improved security, enhanced flexibility, and streamlined integration with your existing systems. By leveraging our REST API, you can centralise your card management processes, simplify compliance with industry standards, and provide a better experience for your customers. We will no longer be updating our old documentation site.

API Based Migration

We are providing an endpoint which will convert a single Core API INIT transaction to a REST API customer and card entity. You'll be provided with a customer_id and card_id which can then be used to make recurring payments using our REST API APIs.

Migrating a transaction

POST/v1/tools/migrate-token

Request & Response

{
  "original_transaction_id": "1234567890"
}

{
    "status": "success",
    "customer_id": "0198a34b-fe76-735d-b160-3d386f077425",
    "card_id": "0198a34b-fe79-73bc-8d6a-938a382c967b"
}

Guidance

Please note that we have the following recommendations when using this endpoint:

• You should not run this immediately before processing a transaction or payment run. Please run this as a background process before payments are processed.
• You should run a maximum of 10 migration requests per second when running this as a batch process.

Batch Process

Note: This method should only be used if you cannot integrate with the API. It is slower, riskier, and requires manual intervention. We strongly recommend API-based migration.

1. Contact our support team to initiate the migration process.
2. Once your migration request is processed, you will receive a file containing the INIT data along with newly created customer_id and card_id mapped accordingly. This file will serve as the basis for migrating your card data to our REST API.
3. Use the provided migration file to map your existing card data to the corresponding endpoints in our REST API. Ensure that the data is accurately mapped to the appropriate fields and follows the specified format and conventions.
4. Before finalising the migration, thoroughly test the integration to ensure that the data is successfully transferred and processed by our API. Verify that all card information is accurately captured and reflects the desired outcome.
5. Once you are satisfied with the migration and have validated the data, finalise the migration process by submitting the mapped data to our REST API. Our team will review the submitted data and assist with any additional steps or troubleshooting as needed.