|
|
@@ -0,0 +1,612 @@
|
|
|
+# PC Web Integration Specification V4.2.1
|
|
|
+[Shanghai AllPay Technology Co., Ltd.](https://www.allpayx.com)
|
|
|
+
|
|
|
+* Version:English V4.2.1
|
|
|
+* Update Time:April 2018
|
|
|
+
|
|
|
+#### 1.Overview
|
|
|
+
|
|
|
+AllPay provides customers with unified API access to help them implement fast, secure and centralized access payment channels.
|
|
|
+#### 2.Transaction process
|
|
|
+
|
|
|
+
|
|
|
+#### 3.General API specification
|
|
|
+Common interface between merchant server and AllPay gateway, each channel has functions including: Purchase, Refund, Inqiury interface.
|
|
|
+
|
|
|
+##### 3.1. Description of verifying the signature
|
|
|
+```
|
|
|
+1.For a POST request message sent to the ALLPAY system, in which all incoming parameters (except signature parameters) according to the field name of ASCII smallest sequence (dictionary), using the format of the URL key/value pair (key1 = value1 & key2 = value2... ) spliced into a string String1.
|
|
|
+
|
|
|
+2.At the end of String1, the signature key K1(assigned at ALLPAY upon access) agreed by both parties is spliced directly (no need to connect with "&"), resulting in a stringSignTemp string, and an md5 operation on stringSignTemp to get the value of signature.
|
|
|
+
|
|
|
+3.Sample signature string:acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInfo=iPhone x&merID=800039253992510&merReserve=&orderAmount=1.00&orderCurrency=INR&orderNum=ap0180417163142&paymentSchema=EB&signType=MD5&transTime=20180417163142&transType=PURC&trxn_email_id=benson.zhang@allpayx.com&trxn_firstname=benson zhang&trxn_is_coupon_enabled=1&trxn_phone=15026528888&unique_id=abcde12345&version=VER000000002f3e0e436cd24430aa4aaaed597450f26
|
|
|
+```
|
|
|
+##### 3.2. General API access address
|
|
|
+ Transaction Type |Test Address|Production Address
|
|
|
+ ------- |-----------|-------
|
|
|
+ Purchase |https://testapi.allpayx.com/pay/v1 |https://api.allpayx.com/pay/v1
|
|
|
+ Inqiury |https://testapi.allpayx.com/pay/v1 |https://api.allpayx.com/pay/v1
|
|
|
+ Refund |https://testapi.allpayx.com/pay/v1 |https://api.allpayx.com/pay/v1
|
|
|
+
|
|
|
+##### 3.3. Purchase interface
|
|
|
+
|
|
|
+1. Request message format
|
|
|
+
|
|
|
+ This field is a list of common fields, sending, every channel needs some channel channel exclusive field, specific fields please go to the channel's exclusive canal to the fields that view. Consumer interface is divided into jump transformation and parameters return type, default to jump transformation, parameters return type will be explained in chapter 4 channels (exclusive) inside.
|
|
|
+
|
|
|
+ No. |Field Name |Max.Length|Type|Parameter Name|Comment
|
|
|
+ -----|-----|----|----|------|------
|
|
|
+ 1|Message Version|12|Text|version |"VER000000002"
|
|
|
+ 2|Character set coding |6|Text|charSet |"UTF-8"
|
|
|
+ 3|Transaction type |4|Text|transType |"PURC"
|
|
|
+ 4|Order Number |60|Text|orderNum |The merchant shall define it by itself, and the order number of the same merchant number shall not be repeated
|
|
|
+ 5|Order Amount |12|Text|orderAmount |100 is displayed as 100 or 100.00
|
|
|
+ 6|Order Currency |3|Text|orderCurrency |Fill in "CNY" in RMB and "USD" in USD
|
|
|
+ 7|Frontend URL Address |400|Text|frontURL |Payment results are notified to this address front
|
|
|
+ 8|Backend URL Address |400|Text|backURL |Payment results are notified to this address asynchronously
|
|
|
+ 9|Merchant Reserved |1024 |Text|merReserve |Merchant reserved content, can pass any content, such as purchase information, account number, etc., but do not pass special symbols, such as commas.
|
|
|
+ 10|Merchant ID |15 |Text|merID |Merchant ID, assigned by AllPay
|
|
|
+ 11|Acquirer ID |11 |Text|acqID |"99020344"
|
|
|
+ 12|Payment Channel Code |10 |Text|paymentSchema|Payment Channel Code：[Click here for details](https://git.allpayx.com/OpenAPI/b2c/src/master/pc_api/paymentSchema.md)
|
|
|
+ 13|Goods Information |60 |Text|goodsInfo |Goods Information
|
|
|
+ 14|Transaction Time |14 |Text|transTime |Transaction time, format :" yyymmddhhmmss"
|
|
|
+ 15|Signature Type |3 |Text|signType |MD5
|
|
|
+ 16|Signature Data |32 |Text|signature |MD5 signature
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+2. Jump transformation Purchase interface response message
|
|
|
+
|
|
|
+ The merchant needs to provide an HTTP/HTTPS protocol interface that is included in the parameters passed to the SDK, the backURL. After the payment is complete, the AllPay server will call the backURL as a Get, informing the payment result.
|
|
|
+
|
|
|
+The parameters are as follows:
|
|
|
+
|
|
|
+
|
|
|
+ No. |Field Name |Max.Length|Type|Parameter name|Comment
|
|
|
+ -----|-----|----|----|------|------
|
|
|
+ 1|Message Version|12|Text|version |"VER000000002"
|
|
|
+ 2|Character set coding |6|Text|charSet |"UTF-8"
|
|
|
+ 3|Transaction type |4|Text|transType |"PURC"
|
|
|
+ 4|Order Number |60|Text|orderNum |The merchant shall define it by itself, and the order number of the same merchant number shall not be repeated
|
|
|
+ 5|Order Amount |12|Text|orderAmount |100 is displayed as 100 or 100.00
|
|
|
+ 6|Order Currency |3|Text|orderCurrency |Fill in "CNY" in RMB and "USD" in USD
|
|
|
+ 7|Settlement Amount |12 |Text|settAmount |100 is displayed as 100 or 100.00
|
|
|
+ 8|Settlement Currency |3|Text|settCurrency |Comply with ISO standards and fill in the number type
|
|
|
+ 9|Settlement FX Rate |7|Text|rate |Real exchange rate, 7 digits
|
|
|
+ 10|Merchant Reserved |1024 |Text|merReserve |Merchant reserved content, can pass any content, such as purchase information, account number, etc., but do not pass special symbols, such as commas.
|
|
|
+ 11|Gateway Transaction ID |32|Text|transID |The unique transaction id generated by the gateway.
|
|
|
+ 12|Merchant ID |15 |Text|merID |Merchant ID, assigned by AllPay
|
|
|
+ 13|Acquirer ID |11 |Text|acqID |"99020344"
|
|
|
+ 14|Payment Channel Code |10 |Text|paymentSchema|Payment Channel Code：[Click here for details](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md)
|
|
|
+ 15|Response Code |2 |Text|RespCode |00 stands for success; 01 stands for fail.
|
|
|
+ 16|Response Message |20 |Text|RespMsg |Response message, all English characters
|
|
|
+ 17|Transaction Time |14 |Text|transTime |Transaction time, format :" yyymmddhhmmss"
|
|
|
+ 18|Gateway process time |14 |Text|GWTime |YYYYMMDDHHMMSS this should be a GWtime, currently is local transaction time
|
|
|
+ 19|Signature Type |3 |Text|signType |MD5
|
|
|
+ 20|Signature Data |32 |Text|signature |MD5 signature
|
|
|
+
|
|
|
+##### 3.4. Inqiury interface
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+1. Interface specification
|
|
|
+
|
|
|
+ This interface provides the function of inqiury transaction for access merchants.
|
|
|
+
|
|
|
+2. Request message format
|
|
|
+
|
|
|
+
|
|
|
+ No. |Field Name |Max.Length|Type|Parameter name|Comment
|
|
|
+ -----|-----|----|----|------|------
|
|
|
+ 1|Message Version|12|Text|version |"VER000000002"
|
|
|
+ 2|Character set coding |6|Text|charSet |"UTF-8"
|
|
|
+ 3|Transaction type |4|Text|transType |"INQY"
|
|
|
+ 4|Order Number |60|Text|orderNum |The merchant shall define it by itself, and the order number of the same merchant number shall not be repeated
|
|
|
+ 5|Merchant Reserved |1024 |Text|merReserve |Merchant reserved content
|
|
|
+ 6|Merchant ID |15 |Text|merID |Merchant ID, assigned by AllPay
|
|
|
+ 7|Acquirer ID |11 |Text|acqID |"99020344"
|
|
|
+ 8|Payment Channel Code |10 |Text|paymentSchema|Payment Channel Code：[Click here for details](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md)
|
|
|
+ 9|Transaction Time |14 |Text|transTime |Transaction time, format :" yyymmddhhmmss"
|
|
|
+ 10|Signature Type |3 |Text|signType |MD5
|
|
|
+ 11|Signature Data |32 |Text|signature |MD5 signature
|
|
|
+
|
|
|
+
|
|
|
+3. Response message format
|
|
|
+
|
|
|
+
|
|
|
+ No. |Field Name |Max.Length|Type|Parameter name|Comment
|
|
|
+ -----|-----|----|----|------|------
|
|
|
+ 1|Message Version|12|Text|version |"VER000000002"
|
|
|
+ 2|Character set coding |6|Text|charSet |"UTF-8"
|
|
|
+ 3|Transaction type |4|Text|transType |"INQY"
|
|
|
+ 4|Order Number |60|Text|orderNum |The merchant shall define it by itself, and the order number of the same merchant number shall not be repeated
|
|
|
+ 5|Gateway Transaction ID |32|Text|transID |The unique transaction id generated by the gateway.
|
|
|
+ 6|Merchant ID |15 |Text|merID |Merchant ID, assigned by AllPay
|
|
|
+ 7|Acquirer ID |11 |Text|acqID |"99020344"
|
|
|
+ 8|Response Code |2 |Text|RespCode |00 stands for success; 01 stands for fail.
|
|
|
+ 9|Response Message |20 |Text|RespMsg |Response message, all English characters
|
|
|
+ 10|Transaction Time |14 |Text|transTime |Transaction time, format :" yyymmddhhmmss"
|
|
|
+ 11|Gateway process time |14 |Text|GWTime |YYYYMMDDHHMMSS this should be a GWtime, currently is local transaction time
|
|
|
+ 12|Signature Type |3 |Text|signType |MD5
|
|
|
+ 13|Signature Data |32 |Text|signature |MD5 signature
|
|
|
+
|
|
|
+##### 3.5. Refund interface
|
|
|
+
|
|
|
+1.Interface specification
|
|
|
+
|
|
|
+This interface provides the function of refund transaction for access merchants.
|
|
|
+
|
|
|
+2.Request message format
|
|
|
+
|
|
|
+ No. |Field Name |Max.Length|Type|Parameter name|Comment
|
|
|
+ -----|-----|----|----|------|------
|
|
|
+ 1|Message Version|12|Text|version |"VER000000002"
|
|
|
+ 2|Character set coding |6|Text|charSet |"UTF-8"
|
|
|
+ 3|Transaction type |4|Text|transType |"REFD"
|
|
|
+ 4|Order Number |60|Text|orderNum |The merchant shall define it by itself, and the order number of the same merchant number shall not be repeated
|
|
|
+ 5|Return Amount |12|Text|returnAmount |100 is displayed as 100 or 100.00
|
|
|
+ 6|Order Currency |3|Text|orderCurrency |Fill in "CNY" in RMB and "USD" in USD
|
|
|
+ 7|Merchant Reserved |1024 |Text|merReserve |Merchant reserved content, can pass any content, such as purchase information, account number, etc., but do not pass special symbols, such as commas.
|
|
|
+ 8|Merchant ID |15 |Text|merID |Merchant ID, assigned by AllPay
|
|
|
+ 9|Acquirer ID |11 |Text|acqID |"99020344"
|
|
|
+ 10|Payment Channel Code |10 |Text|paymentSchema|Payment Channel Code：[Click here for details](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md)
|
|
|
+ 11|Transaction Time |14 |Text|transTime |Transaction time, format :" yyymmddhhmmss"
|
|
|
+ 12|Signature Type |3 |Text|signType |MD5
|
|
|
+ 13|Signature Data |32 |Text|signature |MD5 signature
|
|
|
+
|
|
|
+3.Response message format
|
|
|
+
|
|
|
+
|
|
|
+ No. |Field Name |Max.Length|Type|Parameter name|Comment
|
|
|
+ -----|-----|----|----|------|------
|
|
|
+ 1|Message Version|12|Text|version |"VER000000002"
|
|
|
+ 2|Character set coding |6|Text|charSet |"UTF-8"
|
|
|
+ 3|Transaction type |4|Text|transType |"REFD"
|
|
|
+ 4|Order Number |60|Text|orderNum |The merchant shall define it by itself, and the order number of the same merchant number shall not be repeated
|
|
|
+ 5|Gateway Transaction ID |32|Text|transID |The unique transaction id generated by the gateway.
|
|
|
+ 6|Merchant ID |15 |Text|merID |Merchant ID, assigned by AllPay
|
|
|
+ 7|Acquirer ID |11 |Text|acqID |"99020344"
|
|
|
+ 8|Response Code |2 |Text|RespCode |00 stands for success; 01 stands for fail.
|
|
|
+ 9|Response Message |20 |Text|RespMsg |Response message, all English characters
|
|
|
+ 10|Transaction Time |14 |Text|transTime |Transaction time, format :" yyymmddhhmmss"
|
|
|
+ 11|Gateway process time |14 |Text|GWTime |YYYYMMDDHHMMSS this should be a GWtime, currently is local transaction time
|
|
|
+ 12|Signature Type |3 |Text|signType |MD5
|
|
|
+ 13|Signature Data |32 |Text|signature |MD5 signature
|
|
|
+
|
|
|
+#### 4.Channel exclusive allocation
|
|
|
+##### 4.1 EB(Transition）
|
|
|
+
|
|
|
+
|
|
|
+No. |Field Name |Max.Length|Type|Parameter name|Comment
|
|
|
+ -----|-----|----|----|------|------
|
|
|
+ 1| Name |32 |Text|trxn_firstname |This is name of the customer who is doing the transaction.
|
|
|
+ 2| Email |40 |Text|trxn_email_id |this is email id of the customer who is doing transaction.
|
|
|
+ 3|Phone |20 |Text|trxn_phone|Phone number of the customer.
|
|
|
+
|
|
|
+##### 4.2 UP(Transition）
|
|
|
+
|
|
|
+No. |Field Name |Max.Length|Type|Parameter name|Comment
|
|
|
+ -----|-----|----|----|------|------
|
|
|
+ 1| UnionPay card number |19 | Text|uCardNumber |The overseas UnionPay channel is applicable to the UnionPay excellent plan. Can not upload, if you need to fill in the bank card number in advance, then send this field.
|
|
|
+
|
|
|
+##### 4.3 WX(Includes transition and parameter return）
|
|
|
+
|
|
|
+ No. |Field Name |Max.Length|Type|Parameter name|Comment
|
|
|
+ -----|-----|----|----|------|------
|
|
|
+ 1| Transaction scenario code|16 | Text|code |1.“NATIVE“：Return the URL value of WeChat payment collection for parameter return, ask the merchant to convert it into QR code, generate the front interface of payment, and prompt the user to scan the code to pay; 2.“QUICK”：It's jump mode, open the front-end page provided by AllPay, which contains WeChat QR code.
|
|
|
+
|
|
|
+##### 4.4 PPRO(Transition）
|
|
|
+###### 4.4.1 PPRO_AC
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+
|
|
|
+Note: AstroPay Card is available for currency USD and country codes BO, BR, CL, CN, CO, CR, MX, PE, UY, VE.
|
|
|
+
|
|
|
+###### 4.4.2 PPRO_AD
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+
|
|
|
+Note: AstroPay Direct is available for currency USD and country codes AR, BR, CL, CN, CO, MX, PE, UY.
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.3 PPRO_AR
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+nationalid |M |Text |Consumer’s national id (up to 30 characters)
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+dob |O |Text |Date of birth, format YYYYMMDD
|
|
|
+
|
|
|
+Note: Aura (Brazil) is available for currency USD and country code BR.
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.4 PPRO_BA
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+nationalid |M |Text |Consumer’s national id (up to 30 characters)
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+dob |O |Text |Date of birth, format YYYYMMDD
|
|
|
+
|
|
|
+Note: Baloto Cash (Colombia) is available for currency USD and country code CO.
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.5 PPRO_BB
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+nationalid |M |Text |Consumer’s national id (up to 30 characters)
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+dob |O |Text |Date of birth, format YYYYMMDD
|
|
|
+
|
|
|
+Note: Banco do Brasil (Brazil) is available for currency USD and country code BR.
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.6 PPRO_BO
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+nationalid |M |Text |Consumer’s national id (up to 30 characters)
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+dob |O |Text |Date of birth, format YYYYMMDD
|
|
|
+
|
|
|
+Note: Boleto Bancario is available for currency USD and country code BR.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.7 PPRO_CC
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+nationalid |M |Text |Consumer’s national id (up to 30 characters)
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+dob |O |Text |Date of birth, format YYYYMMDD
|
|
|
+
|
|
|
+Note: Cartao MercadoLivre (Brazil) is available for currency USD and country code BR.
|
|
|
+
|
|
|
+###### 4.4.8 PPRO_DR
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+phone |M |Text |Valid international phone number of the account holder
|
|
|
+
|
|
|
+Note: Dragonpay is only available for currency PHP and country code PH.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.9 PPRO_EN
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+phone |M |Text |Valid international phone number of the account holder
|
|
|
+
|
|
|
+Note: eNETS is only available for currency SGD and country code SG.
|
|
|
+
|
|
|
+###### 4.4.10 PPRO_EP
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+
|
|
|
+Note: eps only works for the countrycode “AT” and currency “EUR”.
|
|
|
+
|
|
|
+###### 4.4.11 PPRO_GP
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+bic |O |Text |Valid BIC (8 or 11 alphanumeric letters) of consumer’s bank
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.12 PPRO_HC
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+nationalid |M |Text |Consumer’s national id (up to 30 characters)
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+dob |O |Text |Date of birth, format YYYYMMDD
|
|
|
+
|
|
|
+Note: Hipercard (Brazil) is available for currency USD and country code BR.
|
|
|
+
|
|
|
+###### 4.4.13 PPRO_ID
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+
|
|
|
+Note: iDEAL only works for the countrycode “NL” and currency “EUR”.
|
|
|
+
|
|
|
+###### 4.4.14 PPRO_IT
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+nationalid |M |Text |Consumer’s national id (up to 30 characters)
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+dob |O |Text |Date of birth, format YYYYMMDD
|
|
|
+
|
|
|
+Note: Itaú (Brazil) is available for currency USD and country code BR.
|
|
|
+
|
|
|
+###### 4.4.15 PPRO_MB
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+
|
|
|
+Note: MyBank only works for the country code IT and currency EUR.
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.16 PPRO_PC
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.17 PPRO_PB
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+phone |M |Text |Valid international phone number of the account holder
|
|
|
+
|
|
|
+Note: PAYSBUY Cash is only available for currency THB and country code TH.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.18 PPRO_PU
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+
|
|
|
+Note: PayU works only for country code/currency combinations CZ/CZK and PL/PLN.
|
|
|
+
|
|
|
+###### 4.4.19 PPRO_PL
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+
|
|
|
+Note: POLi only works for the countrycode/currency combinations “NZ”/”NZD” and “AU/AUD”.
|
|
|
+
|
|
|
+###### 4.4.20 PPRO_P24
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+
|
|
|
+Note: Przelewy24 only works for the countrycode “PL” and currencies “PLN” and “EUR”.
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.21 PPRO_QW
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+mobilephone|M |Text |Valid international Russian mobile phone number identifying the QIWI destination account to pay out to (excluding plus sign or any other international prefixes, including a leading 7 for Russia, 11 digits in total, e.g. 71234567890).
|
|
|
+
|
|
|
+
|
|
|
+Note: QIWI Payout only works for the countrycodes “RU”, “KZ” and UA, and - depending on your contract - currency
“RUB” , “EUR” ,”KZT” and “USD”.
|
|
|
+###### 4.4.22 PPRO_SP
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+
|
|
|
+Note: SafetyPay only works for country codes “AT”, “BR”, “CO”, “CR”, “DE”, “ES”, “MX”, “NI”, “NL”, “PA”, “PE” and currencies “EUR”, “USD”.
|
|
|
+
|
|
|
+###### 4.4.23 PPRO_SD
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+
|
|
|
+
|
|
|
+Note: SEPA Direct Debit works for all SEPA countries and currency EUR.
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.24 PPRO_SG
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+phone |M |Text |Valid international phone number of the account holder
|
|
|
+
|
|
|
+Note: SingPost (Singapore) is only available for currency SGD and country code SG.
|
|
|
+
|
|
|
+###### 4.4.25 PPRO_SK
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+email |O |Text |RFC compliant email address of the account holder
|
|
|
+address |O |Text |Consumer’s address (e.g. street)
|
|
|
+zipcode |O |Text |Consumer’s postal code
|
|
|
+city |O |Text |Consumer’s city
|
|
|
+
|
|
|
+###### 4.4.26 PPRO_DP
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+bic |O |Text |Valid BIC (8 or 11 alphanumeric letters) of consumer’s bank
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.27 PPRO_TP
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+
|
|
|
+TrustPay works for the following country code/currency combinations:
|
|
|
+
|
|
|
+
|
|
|
+CZ
|
|
|
+CZK, EUR
|
|
|
+
|
|
|
+
|
|
|
+SK
|
|
|
+EUR
|
|
|
+
|
|
|
+
|
|
|
+The currencies available to you may depend on your contract.
|
|
|
+
|
|
|
+
|
|
|
+###### 4.4.28 PPRO_WP
|
|
|
+
|
|
|
+
|
|
|
+ Field name |M/O |Type |Description
|
|
|
+ -----|-----|----|----
|
|
|
+ countrycode|M |Text |The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see payment method specific documentation.
|
|
|
+accountholdername|M |Text |The account holder - minimum of 3 characters, up to 100 charac- ters.
|
|
|
+consumerref |M |Text |Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
|
|
|
+nationalid |M |Text |Consumer’s national id (up to 30 characters)
|
|
|
+email |M |Text |RFC compliant email address of the account holder
|
|
|
+dob |O |Text |Date of birth, format YYYYMMDD
|
|
|
+
|
|
|
+Note: WebPay is available for currency USD and country code CL.
|
|
|
+
|
|
|
+#### 5.Test account
|
|
|
+
|
|
|
+ Please note that AliPay and TenPay transactions need to be tested with Chinese real-name certified accounts. All test transactions do not provide liquidation services. Please use a small amount of test.
|
|
|
+
|
|
|
+The following are the UnionPay channel test cards for testing only:
|
|
|
+
|
|
|
+```
|
|
|
+Credit Card:5200831111111113
|
|
|
+Mobile:13552535506
|
|
|
+CVN2:123
|
|
|
+Exp Date:month 11 year 19
|
|
|
+SMS Code on PC:111111
|
|
|
+SMS Code on Mobile:123456
|
|
|
+
|
|
|
+Credit Card:6226388000000095
|
|
|
+Mobile:18100000000
|
|
|
+CVN2:248
|
|
|
+Exp Date:month 12 year 19
|
|
|
+SMS Code on PC:111111
|
|
|
+SMS Code on Mobile:123456
|
|
|
+
|
|
|
+```
|
|
|
+
|
|
|
+#### 6. error code
|
|
|
+
|
|
|
+
|
|
|
+| code | msg |
|
|
|
+| -------------- | ------------------------------------------ |
|
|
|
+| U1 | Clientid not found |
|
|
|
+| U2 | Signature error |
|
|
|
+| V1 | Parameter missing |
|
|
|
+| E1 | Exceed the limit |
|
|
|
+| R1 | Orderno repeat |
|
|
|
+| C1 | Order currency is not set |
|
|
|
+| P1 | paychannel error |
|
|
|
+| I1 | Illegal request address |
|
|
|
+| T1 | Parameter missing（version或tranType） |
|
|
|
+| T2 | Txntype error |
|
|
|
+| T3 | transaction is not exist or fail |
|
|
|
+| T4 | The maximum amount exceeds the upper limit |
|
|
|
+| 99 | System error
|
|
|
+
|
|
|
+
|
|
|
+#### 7.Technical support
|
|
|
+
|
|
|
+If you have problems with debugging, please contact us:support@allpayx.com
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
