WorldFirst DocsWorldFirst Docs

Integration guide

This guide provides general steps for you to go through the whole integration process. Read this topic to get started with WorldFirst integration.

To implement the integration, perform the following actions:

1648782783569-89c377ee-6bd1-473e-9e9d-c84bc5ac11ed.jpeg

Figure 1. Process to integrate with WorldFirst

Prepare for integration

Read the integration guides

For each specific solution, read through the necessary documents to familiarize yourself with the upcoming steps which include:

  • Product introduction
  • Integration guide
  • API references

Draft an integration plan

Work with our solution architect team to make an integration plan. Our solution architect team will help you figure out the integration scope such as the required capabilities to be integrated and determine which parts are optional.

Obtain Credentials

Before getting started with WorldFirst integration, you need to contact WorldFirst Technical Support to obtain the following information:

  • Environment address
  • Client ID
  • Generate an RSA2 key pair and exchange public keys with WorldFirst before integration. To learn how to generate an RSA2 key pair, refer to the Sign a request and validate the signature chapter.
  • WorldFirst public domain name or IP address
  • Get your IP whitelisted with WorldFirst (if integration is done offline)

Develop and integrate

You can develop an application and integrate it with WorldFirst based on your business requirements. The WorldCard APIs enable you to achieve functionalities such as business authorization, card application, card information query, card status and transaction limit adjustments.

OAuth (integrate as needed)

If you need to authorize a third party to do apply for and pay with WorldCard, you can configure a redirect link for token authorization. The diagram below shows the integration procedure:

image.png

Figure 2. Partner calls the APIs to obtain OAuth token

Apply for WorldCard

The following diagram illustrates the process of integrating APIs to apply for a WorldCard, confirm the application result and query the card information:

image.png

Figure 3. Partner calls the APIs to apply for WorldCard

Query WorldCard information

The following diagram illustrates the process of integrating APIs to query card information, card list and the sensitive data:

image.png

Figure 4. Partner calls the APIs to query the WorldCard information

Update WorldCard status and transaction limit

The following diagram illustrates the process of integrating APIs to update the WorldCard status and its transaction limit:

image.png

Figure 5. Partner calls the APIs to change card status and transaction limit

Query WorldCard bills and WorldFirst account statements

The following diagram illustrates the process of integrating APIs to query the WorldCard bills and WorldFirst account statements:

image.png

Figure 6. Partner calls the APIs to query card bills and account statements

Query WorldFirst account balance

The following diagram illustrates the process of integrating APIs to query the WorldFirst account balance:

image.png

Figure 7. Parnter calls the API to query WorldFirst account balance

Conduct production acceptance testing

Acceptance testing can determine whether a component or system satisfies the requirements. Contact WorldFirst Support Team for more details about the production acceptance testing process.

Launch into production

Once your application has passed the production acceptance testing, you can launch the application into production.