API Documentation

Introduction Authentication Merchant Onboarding Create Merchant KYC Verification KYB Business Activation Query KYC Status Query KYB Status Fund In Service Shop Management Get Platforms Add Shop Holder Create Shop Query Shop Transaction Processing Upload Transaction Materials VA Account Service Apply VA Account Query VA Account Download Account Credential Fund Out Service Beneficiary Management Add Beneficiary Update Beneficiary Delete Beneficiary Query Beneficiary Payment Processing Single Payment FX Quota Management Upload FX Materials Query FX Status Query FX Quota FX Service Merchant Rate Inquiry Realtime FX Wallet Service Wallet Query Wallet Transfer Transaction Query Download Credential Query Transaction Detail Common Service Event Notification File Service

Introduction

Welcome to the EurewaX API documentation. This guide provides comprehensive information about the EurewaX open platform APIs, including authentication, request/response formats, and available endpoints.

The API uses standard HTTP response codes, authentication headers, and returns JSON in all responses.

Authentication

All API requests require the following authentication headers:

Header Type Required Description
x-signature string Yes Request signature for authentication
x-app-id string Yes Application ID provided by EurewaX
x-request-id string Yes Unique request identifier

Merchant Onboarding

Merchant registration, KYC verification, and business activation related APIs.

Create Merchant

Create an account for merchants to conduct all subsequent business activities.

POST /api/v1/ex/onboarding/merchant

Request Parameters

Headers
Parameter Type Required Description
x-signature string Yes Signature
x-app-id string Yes App ID
x-request-id string Yes Request ID
Body Parameters
Parameter Type Required Description
merchantName string Yes Merchant name
credential string Yes Email/phone number for registration (if phone, format: +[country code] [phone number], e.g. +86 18000000000)
remark string No Remarks
Response Parameters
Parameter Type Required Description
merchantNo string Yes Unique merchant identifier
registerTime string Yes Registration timestamp

Merchant Onboarding

Merchant registration, KYC verification, and business activation related APIs.

Create Merchant

Create an account for merchants to conduct all subsequent business activities.

POST /api/v1/ex/onboarding/merchant

Request Parameters

Headers
Parameter Type Required Description
x-signature string Yes Signature
x-app-id string Yes App ID
x-request-id string Yes Request ID
Body Parameters
Parameter Type Required Description
merchantName string Yes Merchant name
credential string Yes Email/phone number for registration (if phone, format: +[country code] [phone number], e.g. +86 18000000000)
remark string No Remarks
Response Parameters
Parameter Type Required Description
merchantNo string Yes Unique merchant identifier
registerTime string Yes Registration timestamp

KYC Verification

Submit merchant KYC information and materials. KYC verification must be approved before proceeding with business operations.

POST /api/v1/ex/onboarding/merchant/kyc

Request Parameters

Headers
Parameter Type Required Description
x-signature string Yes Signature
x-app-id string Yes App ID
x-request-id string Yes Request ID
Body Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
bizType string Yes Business type
kycData string Yes KYC data in JSON format based on country/region KYC template
Response Parameters
Parameter Type Required Description
status string Yes Verification status
completeTime string No Completion time
failReason string No Reason for rejection (required when status is REJECTED)

KYB Business Activation

If KYC verification has already been approved for one business line, use this API to activate additional business lines. KYB verification must be approved before proceeding with operations for the corresponding business line.

POST /api/v1/ex/onboarding/merchant/kyb

Request Parameters

Body Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
bizType string Yes Business type
kybData string Yes KYB data in JSON format based on country/region KYB template
Response Parameters
Parameter Type Required Description
status string Yes Verification status
completeTime string No Completion time
failReason string No Reason for rejection (required when status is REJECTED)

Query KYC Status

Query the status of a KYC verification.

POST /api/v1/ex/onboarding/merchant/kyc/query-status

Request Parameters

Body Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
Response Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
status string Yes Verification status
completeTime string No Completion time
failReason string No Reason for rejection (required when status is REJECTED)

Query KYB Status

Query the status of a KYB verification for a specific business type.

POST /api/v1/ex/onboarding/merchant/kyb/query-status

Request Parameters

Body Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number

Fund In Service

Multi-currency collection, VA account service and platform collection related APIs.

Shop Management

Platform shop management related APIs.

Get Platforms

Get a list of available platforms for shop creation.

POST /api/v1/ex/fundin/shop/plat-list
Request Parameters
Parameter Type Required Description
platSource string Yes Platform source code
Response Parameters
Parameter Type Required Description
platId string Yes Platform site ID
platDesc string Yes Platform site name
platType string Yes Platform site type
checkUrlFlag boolean Yes Whether third-party platform login authorization is required

Add Shop Holder

Add shop holder information for Amazon shops.

POST /api/v1/ex/fundin/shop/holder
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
holderType string Yes Holder type
shopName string Yes Shop name
shopCountryCode string Yes Shop country code

Create Shop

Create a new shop for platform collection.

POST /api/v1/ex/fundin/shop
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
platId string Yes Platform ID
shopName string Yes Shop name
address string No Shop address
authData string No Authorization data in JSON format

Query Shop

Query shop information by shop ID.

POST /api/v1/ex/fundin/shop/detail
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
shopId string Yes Shop ID

Transaction Processing

Processing fund-in transactions related APIs.

Upload Transaction Materials

Upload transaction materials after funds are received for review.

POST /api/v1/ex/fundin/txn/attachment
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
transactionId string Yes Fund-in transaction ID
url string Yes File path obtained from file upload API

VA Account Service

Virtual Account management related APIs.

Apply VA Account

Apply for Virtual Account. Merchants can specify a bank or apply based on business type, currency, and country. Note that some account opening is asynchronous and will be notified via async notification.

POST /api/v1/ex/fundin/va
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
bizType string Yes Business type
currency string Yes Currency
accountName string No Account name
countryCode string Yes Country code
salesCategory string Yes Sales category
bankCode string No Specific bank code. Banks are updated periodically, please contact technical support for bank list
platInfo object No Platform information (required when business type is platform collection)
Response Parameters
Parameter Type Required Description
accountId string Yes VA account ID
status string Yes Account status
currency string Yes Currency
accountCountry string No Account country/region
bankAccountNo string No Bank account number
bankAccountName string No Bank account name
bankName string No Bank name
bankAddress string No Bank address
clearSysInfos array No Clearing system information
platId string No Platform site ID
gmtCreateTime string No Creation time

Query VA Account

Query Virtual Account information and application status by account ID.

POST /api/v1/ex/fundin/va/detail
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
accountId string Yes VA account ID

Download Account Credential

Download the account opening certificate for a Virtual Account.

POST /api/v1/ex/fundin/va/credential
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
accountId string Yes VA account ID
Response Parameters
Parameter Type Required Description
previewUrl string Yes Certificate file preview URL
url string Yes Certificate file download URL

Fund Out Service

Payment services, beneficiary management, and FX quota management related APIs.

Beneficiary Management

Beneficiary account management related APIs.

Add Beneficiary

Add a new beneficiary for payments. Supports both individual and corporate beneficiaries.

POST /api/v1/ex/fundout/payee
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
remarkName string Yes Beneficiary nickname
type string Yes Beneficiary type (PERSON/ENTERPRISE)
person object No Individual information (required if type is PERSON)
enterprise object No Enterprise information (required if type is ENTERPRISE)
address string Yes Beneficiary address
bankAccountName string Yes Bank account name
bankAccount string Yes Bank account number (encrypted)
bankName string Yes Bank name (full name)
currency string Yes Account currency
paymentMethod string Yes Payment method
Response Parameters
Parameter Type Required Description
payeeAccountId string Yes System-assigned unique beneficiary account ID
status string Yes Verification status

Update Beneficiary

Update beneficiary information with additional materials if required for verification.

POST /api/v1/ex/fundout/payee/attachments
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
payeeAccountId string Yes Beneficiary ID
url string Yes File URL for beneficiary materials

Delete Beneficiary

Delete a previously added beneficiary.

POST /api/v1/ex/fundout/payee/delete
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
payeeAccountId string Yes Beneficiary ID

Query Beneficiary

Query beneficiary verification status and details. If verification status is "PENDING_MATERIALS", additional documents need to be uploaded via the update beneficiary API.

POST /api/v1/ex/fundout/payee/detail
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
payeeAccountId string Yes Beneficiary ID
Response Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
payeeAccountId string Yes Beneficiary account ID
status string Yes Verification status
failReason string No Failure reason (returned when status is REJECTED or PENDING_MATERIALS)
completeTime string No Completion time

Payment Processing

Payment transaction processing related APIs.

Single Payment

Create a single payment order. Supports payments to self and others, with optional POBO. The receiving currency is determined by the beneficiary's account currency.

POST /api/v1/ex/fundout/txn/pay
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
merchantOrderNo string Yes Merchant order number (max 64 characters)
payeeAccountId string Yes Beneficiary account ID
pobo boolean No Whether to use POBO
payerCurrency string Yes Payer currency
payerAmount number No Payer amount (choose one: payerAmount or estimatedReceivingAmount)
estimatedReceivingAmount number No Estimated receiving amount
feeType string No Fee type (SHA/OUR/BEN for SWIFT, SHA/OUR for RTGS)
paymentPurpose string No Payment purpose (required for payments to others)
reference string No Payment reference
Response Parameters
Parameter Type Required Description
merchantOrderNo string Yes Merchant order number
transactionId string Yes Payment transaction ID
transactionType string Yes Transaction type
status string Yes Transaction status

FX Quota Management

Foreign exchange quota management related APIs.

Upload FX Materials

If foreign exchange is required after fund collection, call this API to upload B2B or B2C order information. After approval, corresponding FX quota will be generated for foreign exchange.

POST /api/v1/ex/fundout/quota/attachment
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
platId string Yes Platform ID
shopAddress string No Shop URL
fileName string Yes File name
path string Yes File path returned from file upload API
Response Parameters
Parameter Type Required Description
transactionId string Yes Material upload transaction ID
status string Yes Upload status

Query FX Status

Query the status of FX material verification. If no verification result notification is received, use this API to check the status.

POST /api/v1/ex/fundout/quota/attachment/query-status
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
transactionId string Yes Material upload transaction ID

Query FX Quota

After FX materials are approved, corresponding FX quota will be generated based on order amounts. Call this API to query remaining available FX quota (currency is unified as CNY). Note that FX quota fluctuates with market exchange rates in real-time.

POST /api/v1/ex/fundout/quota/query
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
currency string Yes Currency

FX Service

Foreign exchange service related APIs.

Merchant Rate Inquiry

Query exchange rates for currency pairs. Supports both single and multiple currency pair queries.

POST /api/v1/ex/fx/rate/merchant
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
sellCurrency string Yes Sell currency
sellAmount number No Sell amount (choose one: sellAmount or buyAmount)
buyCurrency string Yes Buy currency
buyAmount number No Buy amount
Response Parameters
Parameter Type Required Description
rateToken string Yes Rate inquiry token
rate number Yes Exchange rate

Realtime FX

Execute real-time currency exchange using a rate token obtained from the rate inquiry API.

POST /api/v1/ex/fx/txn/realtime
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
merchantOrderNo string Yes Merchant order number (unique, max 64 characters)
token string Yes Rate inquiry token from merchant rate inquiry API
Response Parameters
Parameter Type Required Description
merchantOrderNo string Yes Merchant order number
transactionId string Yes Transaction ID
transactionType string Yes Transaction type
sellAmount number Yes Sell amount
sellCurrency string Yes Sell currency
buyAmount number Yes Buy amount
buyCurrency string Yes Buy currency
rate string Yes Exchange rate
status string Yes Transaction status

Wallet Service

Account management and wallet transfer related APIs.

Wallet Query

Query merchant account balances for different currencies.

POST /api/v1/ex/wallet/query
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
currencies string Yes Currency list (comma-separated, leave empty to query all currencies)
Response Parameters
Parameter Type Required Description
currency string Yes Currency
balance number Yes Balance
status string Yes Account status

Wallet Transfer

Transfer funds between merchant accounts within the wallet system. For merchants with fund transfer needs, such as related companies or suppliers within the same registered account system, transfers can be completed instantly with zero fees.

POST /api/v1/ex/wallet/transfer
Request Parameters
Parameter Type Required Description
merchantNo string Yes Payer merchant number
merchantOrderNo string Yes Merchant order number
payeeMerchantNo string Yes Payee merchant number
payeeMerchantName string Yes Payee account name
currency string Yes Currency
amount string Yes Amount
paymentPurpose string Yes Transfer purpose
Response Parameters
Parameter Type Required Description
merchantOrderNo string Yes Merchant order number
transactionId string Yes Transaction ID
transactionType string Yes Transaction type
status string Yes Transaction status

Transaction Query

Transaction query and credential download related APIs.

Download Transaction Credential

Download transaction credential document.

POST /api/v1/ex/txn/query/credential
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
merchantOrderNo string Yes Merchant order number (max 64 characters)
transactionType string Yes Transaction type
Response Parameters
Parameter Type Required Description
previewUrl string Yes Credential file preview URL
url string Yes Credential file download URL

Query Transaction Detail

Query detailed transaction information for fund-in, transfer, payment, and FX transactions.

POST /api/v1/ex/txn/query/detail
Request Parameters
Parameter Type Required Description
merchantNo string Yes Merchant number
transactionType string Yes Transaction type
merchantOrderNo string No Merchant order number
transactionId string No Transaction ID (choose one: merchantOrderNo or transactionId)
Response

The response varies based on transaction type and returns detailed transaction information including amounts, statuses, fees, and other relevant details specific to the transaction type (fund-in, fund-out, transfer, or FX transactions).

Common Service

Event notification and file service related APIs.

Configure Notification URL

Configure callback URLs for different notification types. Supports configuring different URLs for each notification type or a unified URL for all notifications (set notifyType="ALL").

POST /api/v1/ex/common/notification/config
Request Parameters
Parameter Type Required Description
notifyType string Yes Notification type (use "ALL" for unified callback)
url string Yes Notification URL (must support POST requests)

Upload File

Upload file for use in other business APIs. Other business APIs requiring material uploads should first call this API to upload the file, then use the returned URL in business API requests.

POST /api/v1/ex/common/file/upload
Request Parameters
Parameter Location Type Required Description
x-signature header string Yes Signature
x-app-id header string Yes App ID
x-request-id header string Yes Request ID
checksum query string Yes File checksum using SHA-512 algorithm
file body binary Yes File to upload
Response Parameters
Parameter Type Required Description
url string Yes File URL for use in other APIs