跳转到主要内容
Before reading this API document, please check API Description Guide

Limits

Transaction TypeLimit
CollectionUSD: 0.99–1000; EUR: 1–500

Collection API

Collection Request

Brief Description:
  • Create a collection order
URL: USD: /usd/collect/apply
Note: appId USD, amount USD, settlement USD
EUR: /eur/collect/apply
Note: appId EUR, amount EUR, settlement EUR
Parameters:
Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, needs to pass the corresponding Business ID based on the currency in the URL)
orderIdYesStringMerchant order number (must be unique, length no more than 48)
nameYesStringUser name, recommended to use real name. Format: contains firstName and lastName separated by a space. Example: Donald John Trump
phoneYesStringReal phone number (format reference Phone Number Format)
emailYesStringReal email address
amountYesStringTransaction amount (accurate to two decimal places; punctuation such as “,” is prohibited)
payTypeYesStringNon-cashier mode: BANK_TRANSFER; Cashier mode: CASHIER
inBankCodeYesStringPayment Method
callBackUrlYesStringRedirect URL after successful payment
callBackFailUrlYesStringRedirect URL after failed payment
notifyUrlNoStringCallback URL
subjectNoStringPayment remark
countryNoStringRequired in cashier mode, reference Country Code, pass the 3-digit code
bodyNoStringRemark details
partnerUserIdYesStringUnique user identifier (e.g., userId), used for risk control system. Must be real and valid, otherwise may affect transaction. Allowed: numbers, letters, or common symbols -~!@#$%&*()_.
signYesStringSignature
request
{
    "appId": 1054,
    "orderId": "M233323000059",
    "amount": "300",
    "phone": "09230219312",
    "email": "23423@qq.com",
    "name": "test",
    "inBankCode": "USA",
    "payType": "BANK_TRANSFER",
    "partnerUserId": "149597870",
    "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}
response
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M233323000059",
        "orderNo": "6023071013539074",
        "payUrl": "",
        "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
    }
}
Response data field description
Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
payUrlStringPayment link
signStringSignature

Collection Query

Brief Description:
  • Query collection order
URL: USD: /usd/collect/query EUR: /eur/collect/query Parameters:
Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, needs to pass the corresponding Business ID based on 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 field description
Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
amountStringTransaction amount
actualAmountStringReceived amount
feeStringTransaction fee
statusIntegerStatus (0 Not Started, 1 In Progress, 2 Success (final), 3 Failed (final), -1 Exception Pending Confirmation)
payTimeStringPayment success time (when status=2, in local time), format: yyyy-MM-dd HH:mm:ss
errorMsgStringFailure reason (when status=3)
signStringSignature

Payment Methods

1. Cashier Mode:
payTypeinBankCode
CASHIERCASHIER
2. Non-Cashier Mode:
payTypeinBankCodeDescriptionLocal Cashier
BANK_TRANSFERBANCONTACT_USDUSD order, Belgium BANCONTACTSupported
BANK_TRANSFEREPS_USDUSD order, Austria EPSSupported
BANK_TRANSFERPRZELEWY24_USDUSD order, Poland PRZELEWY24Supported
BANK_TRANSFERBLIK_USDUSD order, Poland BLIKSupported
BANK_TRANSFERIDEAL_USDUSD order, Netherlands IDEALSupported
BANK_TRANSFEREPS_EUREUR order, Austria EPSSupported
BANK_TRANSFERIDEAL_EUREUR order, Netherlands IDEALSupported
BANK_TRANSFERBANCONTACT_EUREUR order, Belgium BANCONTACTSupported
EWALLETBANCOMATPAY_USDUSD order, Italy BANCOMATPAYSupported
EWALLETBANCOMATPAY_EUREUR order, Italy BANCOMATPAYSupported
EWALLETGOOGLE_PAYUSD order 0.99~1000, Google PaySupported
EWALLETAPPLE_PAYUSD order 0.99~1000, Apple PaySupported

Country Code (country)

1. Europe Cashier: USD, EUR
CodeDescription
000Show all supported countries
040Austria
056Belgium
380Italy
528Netherlands
616Poland
Last modified on April 17, 2026