Payment via Payee ID

Overview

This section details how to perform the complete payment process through API calls. The payment process consists of the following three phases:

• Phase 1: Pre-integration setup
• Phase 2: Payee ID creation or reuse (collect payee information, generate payeeId)
• Phase 3: Initiate payment (must contain valid payeeId)

1 Pre-Use Preparation

Step 1: Environment Requirements

Environment Requirements

All integrations must first be tested in the Sandbox environment. Switch to the Production environment after ensuring functionality is correct.

Environment	Purpose
Sandbox Environment	For integration testing and debugging
Production Environment	For formal transactions

Tip

For details, please refer to Integration Instructions

Step 2: Integration Signature

Security Requirements

Before calling any API, you must generate a signature (sign) and use your private key (privateKey) to ensure request security.

Complete signature instructions, please see:

INFO

Reference documentation Integration Signature

Step 3: Confirm Payment Method

Before initiating payment, you should select the appropriate payment method according to business needs:

• LOCAL (Local transfer)
• SWIFT (International wire transfer)
• Digital wallet

Available payment methods depend on factors such as target country and currency.

INFO

Reference documentation Payment Method Query Interface

Step 4: Confirm Payee Required Fields

Obtain required field information based on the following parameters:

• Country
• Currency
• Entity type (Individual/Business)
• Payment method

The system will return a complete list of required fields based on these parameters, ensuring payer information is complete and compliant.

INFO

Reference documentation Payee Required Field Query Interface

Step 5: Payment on Behalf of Others (Optional)

If you need to pay on behalf of individuals or entities (such as platforms paying on behalf of creators), you need to first add payer information.

Payment on Behalf Scenario:

• Platform pays recipients in the name of sub-merchants

INFO

Reference documentation Add Payer Interface

2 Payee ID Creation or Reuse

Before initiating payment, you need to confirm whether you already have the payeeId of the target payee. Each payee (account) is assigned a unique payeeId by the system, and subsequent payment requests need to be submitted based on this ID.

Operation Process and Judgment Instructions

1. Query Whether payeeId Already Exists

   • First, it is recommended to directly call Create Payee Interface and try to actively initiate payee creation operation based on target payee information (such as account, name, entity, payment method, etc.).
   • If the interface returns normally, i.e., creation successful, the interface will return a new payeeId, and subsequent payments directly use this ID.
   • If the interface returns an error, at this time you should call Payee List Query Interface, find and obtain the existing payeeId through detailed information, then continue with subsequent payment.
     • Note: Different currencies, payment methods, entity types may require supplementing different required fields, ensure submitted information is complete and compliant.

2. Subsequent Operations

   • The obtained payeeId is used as a required parameter for initiating payment API, referenced in each payment.
   • The same payee only needs to be created once, subsequent payments only need to reuse the corresponding payeeId.

Scenario	Handling Method
Payee Already Exists	Query payee, obtain and reuse its payeeId.
Payee is Brand New Information	Call create interface, use after obtaining new payeeId.

The overall process can be simplified as: "Reuse if exists, create if not", ensuring each payment request is clearly associated with a unique payee ID.

3 Initiate a Payment

Interface Description

INFO

Interface information: Initiate Payment via Payee ID Interface

Confirm Before Submission

Check Item	Requirement
Payer Status	Payer status valid
Account Balance	Account balance sufficient
Charge Mode	Charge mode (fixed amount or actual amount) correctly set