Skip to main content
Before reading this API document, please make sure to review API Description Guide

Limits

Transaction TypeLimit (Unit: USD)
Payout1–800

Payout API

Payout Request

URL: USD: /usd/pay/apply Parameters:
NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from the backend; must use the corresponding business ID for the currency in the URL).
orderIdYesStringMerchant order number (must be unique, max length 48).
nameYesStringRecipient’s full name, recommended to use the real name in English, no special characters, separated by spaces, must include at least firstName and lastName. Example: Donald John Trump
phoneYesStringReal phone number (format reference: Phone Number Format).
emailYesStringReal email address.
notifyUrlNoStringCallback URL.
amountYesStringTransaction amount (unit: USD, accurate to two decimals; no punctuation marks allowed, e.g., “,”).
accountTypeYesStringAccount type.
bankCodeYesStringPayment Method.
subjectYesStringPayment remark.
accountNoYesStringAccount number, for PayPal it is the email address.
identifyTypeNoStringBank routing code, required for ACH.
bodyNoStringRemark details, required for ECASHAPP.
countryNoStringRecipient’s country, required for ACH,for example: US.
address1NoStringRecipient’s address - street details, required for ACH.
address2NoStringRecipient’s address - city, required for ACH.
address3NoStringRecipient’s address - state/province, required for ACH.
postalCodeNoStringRecipient’s postal code, required for ACH.
bankNameNoStringRecipient’s bank name, required for ACH.
swiftCodeNoStringswiftCode, required for ACH.
partnerUserIdYesStringUser unique identifier (e.g., userId). Used for risk control. Must be real and valid, otherwise it will affect the transaction. Allowed characters: digits, uppercase/lowercase letters, or common symbols -~!@#$%&*()_.
signYesStringSignature.
request
{
    "appId": 1054,
    "orderId": "M233323000059",
    "amount": "300",
    "phone": "09230219312",
    "email": "23423@qq.com",
    "name": "test",
    "accountType": "EWALLET",
    "bankCode": "PayPal",
    "accountNo": "123465",
    "partnerUserId": "149597870",
    "sign": "af0gAHkUOyYH***"
}
response
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M233323000059",
        "orderNo": "6023071013539074",
        "payUrl": "",
        "sign": "YEoA8Y2JzQFG***"
    }
}
Response data description
NameTypeDescription
orderIdStringMerchant order number (must be unique).
orderNoStringPlatform order number.
payUrlStringPayment link.
signStringSignature.

Payout Query

Description:
  • Create a payout order
  • If orderNo is returned synchronously, it can be queried directly
  • For other payment methods, after asynchronous notification, use orderNo to query and confirm the status again
URL: USD: /usd/pay/query Parameters:
NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from the backend; must match the currency in the URL).
orderIdYesStringMerchant order number.
orderNoNoStringPlatform order number (faster response).
signYesStringSignature.
request
{
    "appId": 1054,
    "orderId": "M22222000028",
    "sign": "EmyJGm3ELzG4FsOd0Krs9ncbSjo4oTGuXWML+7djYla3+VAwd9wS17z38p/7U2ZAjroO04XrE7YXcB1o76Dtyipj3h3bJzs7FYma1QNkMUdt9hh7m8U6hMsMQX7vIWHtXNwz4pbTSC75+kQWXaCew7KoE6LXECdJU8AISgNgeki2TK9R0pCfshr0Z2SZBPeuT6OvIH5LdmqgdZhuqnffGU2qnXk4KMkO848e6/WALLBR+LE1wyKHfPnYVcuKSMVYxkvKyyIL5JIPEgW0o5bh4RCbaUn3NZtyYwrU1uQ3ZDFRThm9j6XAQP+LBlmq3nOePqBtp/VDVarRaV+7FbQg3A=="
}
response
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M22222000028",
        "orderNo": "6023042811314347",
        "amount": "50.00",
        "actualAmount": "0.00",
        "fee": "0.00",
        "status": 1,
        "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
    }
}
Response data description
NameTypeDescription
orderIdStringMerchant order number (must be unique).
orderNoStringPlatform order number.
amountStringTransaction amount.
feeStringTransaction fee.
statusIntegerStatus (0 = Not started, 1 = Processing, 2 = Success (final), 3 = Failed (final), -1 = Exception pending confirmation).
payTimeStringPayment success time (value present when status=2). Local time, format: yyyy-MM-dd HH:mm:ss.
errorMsgStringFailure reason (value present when status=3).
signStringSignature.

Payment Methods

CurrencyPayment Type (accountType)Payment Code (bankCode)LimitStatusDescription
USDEWALLETPayPal1-800AvailablePayPal Wallet
USDEWALLETVENMO1-800AvailableVenmo Wallet
USDBANK_ACCOUNTACH10-200000AvailableACH Transfer
USDEWALLETECASHAPP1-800MaintenanceCashApp Wallet

Notes

  1. What does the failure reason <Bank Reversal> mean? The user’s account has been flagged by PayPal as a high-risk account and cannot receive funds. The user must change to another account.
  2. Can an order that is already in the payout process be recalled? No, it cannot.
  3. Funds have been sent, but the user has not received them. What should be done? The user needs to check their PayPal email to see if there is a notification email and claim the payment.
    If the payment remains in “pending transfer” status, after 30 days without being claimed, it will be automatically refunded.
    Below is the PayPal email claiming guide: Example of the PayPal email claim flow for received funds
Last modified on April 16, 2026