WorldFirst DocsWorldFirst Docs

Integration Skill

WorldFirst has now packaged its core API integration capabilities into Skill components, making the API integration documentation easily understandable by AI. Developers only need to describe their integration requirements to AI tools using natural language, the AI tool will then automatically generate the corresponding integration code. This allow developers to bypass the complex underlying signature logic and interface detail processing, helping them to complete the integration process efficiently.

Applicable scenarios

This component is designed for developers who want to connect WorldFirst APIs through a Vibe Coding workflow. It covers the following modules:

Module

What it does

WorldFirst Transfer

Move funds between WF accounts — consult, initiate, query, and receive result notifications.

Global Payout

Pay out to external bank cards or e-wallets — consult, initiate, query, and receive result notifications.

Beneficiary Management

Look up card templates, bind, delete, edit, or query beneficiaries, and receive bind-result notifications.

Account Management

Check account info, balances, FX quotas, sub-accounts, and stores; listen for recharge and balance-change events.

Statement Management

Pull transaction lists and drill into individual transaction details.

Trade Order Submission

Upload trade orders (for B2C FX settlement or B2B order linkage), query outcomes, and handle asynchronous notifications.

Supported languages

Language

Coverage

Java

All modules

Golang

All modules

Python

Currently only support Common module and Statement Management modules.

Before you begin

Make sure you have the following ready:

Steps

Follow the steps below to install the skill and start using it.

Step 1: Download the Skill

This Skill follows the open SKILL.md spec and works seamlessly with Claude, Cursor, and similar tools. You can choose to download the Skill from Github or via npx.

After downloading, copy the Skill folder into your project under /.claude/skills/.

Notes: This Skill evolves alongside WorldFirst products. Make sure to check back regularly and update to the latest version.

Download from GitHub

  1. Pull the latest source from GitHub.
  2. Place the wf-api-integration/ folder into your editor's skills directory, for example .claude/skills/wf-api-integration/.

Download via npx

  1. Run the command below to install the skill.
copy
npx skills add https://github.com/ant-intl/wf-ai-tools/tree/main/wf-api-integration -y -g

Step 2: Describe your requirements

Describe your integrating requirement in natural language, and AI will generate the integration code for you.

When you interacts with AI, it's important to specify the business module you would like to integrate (such as WorldFirst Transfer, Global Payout, or Beneficiary Management) to avoid ambiguity.

Below are some prompts to help you get started:

Business scenario

Sample prompt

WorldFirst Transfer

"Help me integrate the WorldFirst transfer interface to move money between WF accounts."

Global Disbursement

"Help me integrate the WorldFirst Payout interface so I can pay salaries to multiple bank cards."

Beneficiary Management

"Help me integrate WorldFirst beneficiary management to bind and look up beneficiary bank cards."

Account Management

"Help me integrate the WorldFirst account balance query interface."

Statement Management

"Help me integrate the WorldFirst query statement details interface."

Trade Order Submission

"Help me integrate the WorldFirst trade order submission interface for B2C FX settlement."

Before generating integration code, AI will ask you to confirm the following:

  • Project path and chosen programming language
  • Base package or module name
  • WF Client ID, User ID, and API gateway address
  • Paths to your RSA private key and public key files

Notes:Treat AI-generated integration code as a reference. Ensure you thoroughly review the logic before pushing to production.

Step 3: Obtain sandbox configuration information

  1. Log in to the WorldFirst Developer Center.
  2. Access Developer Center to obtain the sandbox configuration information.
  3. Provide the sandbox configuration information to the AI tool in the following format:
copy
client-id: SANDBOX_xxxxxxxx
user-id: xxxxxxxx
api-base-url: https://open-sea.worldfirst.com
private-key-path: /path/to/private_key.pem
wf-public-key-path: /path/to/wf_public_key.pem

Notes:

Before going live, we recommend that you:

  • Test the full API flow in the WorldFirst sandbox environment. No real money is required to complete this end-to-end validation.
  • Update the sandbox configurations with your live credentials of the production environment.

To see the latest documentation changes, check the Release notes.