Mandatory parameters - CNY flow

Mandatory parameterDescriptionFlow type
login32 charsB2C, B2B, P2P
pass32 charsB2C, B2B, P2P
external_idMax. 100 charsB2C, B2B, P2P
beneficiary_nameMax. 50 chars.
Only han characters (If document type is PASS then English characters are accepted)
B2C, B2B, P2P
countryCNB2C, B2B, P2P
bank_branchCNAPS codeB2C, B2B, P2P
bank_account15 to 18 digits for credit or debit cards
9 to 25 digits ​for bank accounts
B2C, B2B, P2P
account_typeMandatory only if the account is not a credit or debit card

C: for Checking accounts
S: for Savings accounts
B2C, B2B, P2P
currencyCNY or USDB2C, B2B, P2P
amountMax. 2 decimal numbersB2C, B2B, P2P
phoneMax. 100 charsB2C, B2B, P2P
document_idResident Identity Card or PASS: max. 100 chars.
TAXID: max 18 chars.
B2C, B2B, P2P
document_typeMandatory if document type is PASS or TAXID.B2C, B2B, P2P
purposeEPBTOB - Business to Business (B2B)
EPREMT - Remittance (P2P)
Mandatory only for Business to Business (B2B) and Remittance (P2P)
B2B, P2P
remitter_full_nameMax. 100 chars
Mandatory only for remittance (P2P)
P2P
remitter_document_type'ID' for national identification number
'PASS' for passport
Mandatory only for remittance (P2P)
P2P
remitter_documentMax. 45 chars
Mandatory only for remittance (P2P)
P2P
remitter_addressMax. 200 chars
Mandatory only for remittance (P2P)
P2P
remitter_cityMax. 40 chars
Mandatory only for remittance (P2P)
P2P
remitter_countryISO 3166-1 alpha-2 code
Mandatory only for remittance (P2P)
P2P
remitter_nationalityISO 3166-1 alpha-2 code
Mandatory only for remittance (P2P)
P2P

Example request

{
  "login":"1n234n56",
  "pass":"HolAc123o",
  "external_id":"1234567812345678",
  "beneficiary_name":"a1b2ca1b2ca1b2c",
  "country":"CN",
  "bank_account":"123456789123456",
  "bank_branch": "303513000052",
  "amount":"9273.34",
  "comments":"this is the 1st comment",
  "currency":"CNY",
  "phone": "6767658758869",
  "document_id": "110102YYYYMMDD888X",
  "extra_info":"{this_is_extra:2334}",
  "notification_url":"https://thisisawebsite.net/payments",
  "type":"json"
}

Mandatory parameters - USD flow

Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars.
Only han characters (If document type is PASS then English characters are accepted)
countryCN
bank_branchSWIFT code (we accept 8 or 11 alphanumeric characters in upper case)
bank_account15 to 25 digits
amountMax. 2 decimal numbers
phoneMax. 100 chars
addressMax. 200 chars
document_idResident Identity Card or PASS: max. 100 chars.
TAXID: max 18 chars.
document_typeMandatory if document type is PASS or TAXID.

Example request

{
    "login":"1n234n56",
    "pass":"HolAc123o",
    "external_id":"123456781234567118",
    "beneficiary_name":"John Mills",
    "country":"CN",
    "bank_account":"123456789012345",
    "bank_branch": "ABOCCNBJ080",
    "amount":"109.44",
    "currency":"USD",
    "currency_to_pay":"USD",  
    "phone": "6767658758869",
    "document_id": "110102YYYYMMDD888X",
    "address": "Street 1157",
    "notification_url":"https://thisisawebsite.net/payments",
    "type":"json"
}

Bank codes - CNY flow

The banks supported may change according to the payment's flow:

  • P2P & B2C flow
  • B2B flow

P2P & B2C flow

We support every bank covered by China UnionPay network.

B2B flow

Bank NameAbbreviationBank Code
Agricultural Bank of ChinaABC103
Bank of BeijingBCCB792
Bank of ChinaBOC001
Bank of Communications.BOCOM301
Bank of JiangsuJSCB795
Bank of NingboNBCB791
Bank of ShanghaiBOS794
China Bohai BankCBHB318
China CITIC BankCITIC302
China Construction BankCCB105
China Everbright BankCEB303
China Guangfa BankGDB789
China Merchants BankCMB308
China Minsheng BankCMBC305
China Zheshang BankCZB316
Hengfeng Bank Co.HFB793
HSBC BankHXB790
Industrial and Commercial Bank of ChinaICBC102
Industrial Bank Co., LtdCIB309
Ping An BankPINGAN788
Postal Savings Bank of ChinaPSBC403
Shanghai Pudong Development BankSPDB310