WorldFirst DocsWorldFirst DocsDOCS

Development via API

This document provides a step-by-step guide elaborating on how to complete various development tasks.

Prerequisites

Before getting started with the integration process, make sure to complete the following prerequisites:

  • Read through the introduction to familiarize yourself with the overall workflow and core features.
  • Get onboard with WorldFirst. Work with our solution architect team to produce an integration plan.
  • Retrieve the necessary information from the WorldFirst Technical Support, which includes:

Information

Value

Domain name of endpoints

http://remit3.sit.dl.alipaydev.com

Partner ID

2120120004157775

Merchantid(expbizpartnerID)

2188121014196758

Client ID

5J5Y307NSG5GB700810

WorldFirst public key

MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAhqe3BYkjEXdwAl7LWyFjcbYkEYLyFVqXpnwsBzfIsBDujqtQYrDPKm7+PbomkZ787aRj2lWDb6RYy7NwkLnu0Vw799WPGnSwLHnXyM8P/V+YVvzFm873PHUj30sYPDs5uJBWnrcIVpNGKTkGyebtQuF+IFAxP/0yqF/LG3bVIWQa5m6Mkv6pngs+Ln84rULkYBqmROgAzUCoEt8jlynmXUGNH0WeVPk5IA97ZzMoQsp71zC3u4gszN7Kl0qfGKT1Vz7vl/pLZ5SySACISlP0GzyDufBA823g5DDzkxeKKO5zNshKaQaI5t1k+ODgBT8yB9IW8lMyrebVnFO9L5f/8wIDAQAB

WorldFirst outbound IP address range

Contact WorldFirst Support.

IP address whitelist (For offline integration)

Contact WorldFirst Support.

API integration solution

WorldFirst provides a comprehensive solution to support API integration.

  • Start with the Getting started with WorldFirst APIs chapter for a quick walkthrough. This step gives you hands-on experience with WorldFirst APIs.
  • For development via API, the Partner needs to read through the basic information with regard to WorldFirst APIs. For example:
  • Procedures to call an API.

For more details, refer to the Message transmission workflow section in the API Overview chapter.

  • Add and verify signatures.

For more details, refer to the sign a request and verify the signature chapter.

SDK integration solution

SDK integration solution is planned and to be released in the near future.

General procedure

  1. The Customer needs to complete the Customer onboarding process.
  2. The Partner needs to make prefunding deposits prior to initializing a transfer.
  1. The Partner needs to call the inquiryBalance API to inquire about the result of the prefunding process.
  1. The Customer can create a transfer
  1. The Partner needs to call the inquiryBalance API again to ensure sufficient prefunding balance.
  2. (Optional) If the Customer launches a cross-currency transfer, the Partner needs to call the inquiryQuote API to retrieve the currency exchange rates.
  3. The Partner calls the transfer API to create a transfer.
  4. The Partner calls the inquiryTransfer API to inquire about the transfer result.
  5. WorldFirst notifies the Partner about the transfer result with the notifyTransferResult API.
  1. Once the transfer process is completed, the Customer can log in to the WorldFirst website to check the balances.
  2. WorldFirst pulls the Customer's transaction data from the Partner with the pullTransactionData API on the day after the transfer is initiated.

For more details about the APIs used in the process, refer to the API list chapter.

@2024 WorldFirst