Before initiating payments, you can query account information through the following APIs:
| API | Path | Description |
|---|---|---|
| Query Account CurrenciesTransfer API | POST /api/v1/acct/queryCurrency | Query the list of currencies supported by the merchant |
| Query Account BalanceTransfer API | POST /api/v1/acct/queryAccountDetail | Query available balance, frozen balance, etc. for each currency |
| Query Payment MethodsTransfer API | POST /api/v1/acct/queryPaymentMethod | Query supported payment methods for the target country |
| Query Exchange RateTransfer API | POST /api/v1/acct/queryExchangeRate | Query real-time exchange rates |
Creating a beneficiary is a preparatory step before initiating payments. By pre-creating beneficiaries, you ensure that each beneficiary's account information is verified and archived, improving payment accuracy and compliance.
Use Cases:
| Scenario | Description | Benefit |
|---|---|---|
| Frequent Beneficiary List | Pre-establish payment accounts for suppliers, employees, partners | Reduce repetitive data entry |
| High-frequency Payments | Business pays to the same account multiple times | Improve efficiency |
| Batch Settlement | External payments, refunds, settlements, and other high-frequency scenarios | Batch processing |
Process Flow:
Step 1: Collect Basic Information
Determine the following basic information:
Step 2: Query Required Fields
Different countries, currencies, and payment methods require different fields. Query first to confirm.
API: Query Beneficiary Required FieldsTransfer API POST /api/v1/acct/queryPaymentFeild
Query based on the following parameters: country, currency, entity type, payment method. The system returns a complete list of required fields to ensure beneficiary information is complete and compliant.
Step 3: Submit Create Request
API: Add BeneficiaryTransfer API POST /api/v1/beneficiary/add
beneficiaryId after validation passesStep 4: Use beneficiaryId to Initiate Payment
beneficiaryIdQuery beneficiaries to view and manage created beneficiary information.
Single Query:
API: Query Beneficiary DetailsTransfer API POST /api/v1/beneficiary/queryDetail
Query by beneficiaryId, returns complete beneficiary details (basic info, account info, review status, creation/update time).
Use cases: Verify information before payment, check review status.
Batch Query:
API: Query Beneficiary ListTransfer API POST /api/v1/beneficiary/queryList
Supports filtering by country, currency, status, etc., with pagination support.
Use cases: System synchronization, reconciliation, status monitoring. Recommended batch query limit is 100 records per page; use pagination to retrieve all data.
| API | Path | Description |
|---|---|---|
| Edit BeneficiaryTransfer API | POST /api/v1/beneficiary/edit | Update beneficiary information |
| Delete BeneficiaryTransfer API | POST /api/v1/beneficiary/del | Delete beneficiary |
Edit Restrictions: The following fields cannot be modified after creation. To change, delete and recreate:
Q: How soon can I use a beneficiary after creation? Immediately available for payments after successful creation.
Q: Can I use the same beneficiary multiple times? Yes, once created, it can be reused unlimited times.
Q: Do I need to create different beneficiaries for different currencies? Yes, the same beneficiary with different currencies requires different beneficiaryIds.
Q: Do I need to create different beneficiaries for different payment methods? Yes, the same beneficiary with different payment methods requires different beneficiaryIds.