common/payExclusive_EN.md

Channel exclusive fields

Table of Contents:

• 1. WX
  • 1.1 QR code no jump mode
  • 1.2 QR code jump mode
  • 1.3 WeChat Official Accounts payment
  • 1.4 WeChat Mini Programs payment
  • 1.5 APP mode
• 2. AP
  • 2.1 WebSite mode
  • 2.2 H5 mode
  • 2.3 APP mode
  • 2.4 QR code no jump mode
  • 2.5 Alipay Mini Programs payment
• 3. UP
  • 3.1 H5 mode
  • 3.2 APP mode
  • 3.3 QR code no jump mode
  • 3.4 Express Pay
• 4. Apple Pay
  • 4.1 APP mode
• 5. FC
  • 5.1 H5 mode
    • 5.1.1 CIL international card
    • 5.1.2 SN international card
    • 5.1.3 TL international card
    • 5.1.4 ICBC international card
    • 5.1.5 RDP international card
    • 5.1.6 VT international card
  • 5.2 Background mode (Applicable to SN and TL international card)
  • 5.3 Background mode (Applicable to International card 3DS)
• 6. RevPay
  • 6.1 H5 mode
• 7. AliPayPlus
  • 7.1 H5 mode
  • 7.2 WebSite mode
  • 7.3 QR code no jump mode
  • 7.4 APP mode
• 8. PO
  • 8.1 H5 mode
• 9. India_Netbanking
  • 9.1 H5 mode
• 10. PAYPAL
  • 10.1 H5 mode
• 11. Neosurf
  • 11.1 H5 mode
• 12. DNC
  • 12.1 H5 mode
  • 12.2 Background mode
• 13. Ksher
  • 13.1 H5 mode
• 14. FPX
  • 14.1 H5 mode
• 15. India_UPI
  • 15.1 H5 mode
• 16. Boleto
  • 16.1 H5 mode
• 17. Baloto
  • 17.1 H5 mode
• 18. PIX
  • 18.1 H5 mode
• 19. PSE
  • 19.1 H5 mode
• 20. Webpay
  • 20.1 H5 mode
• 21. OXXO
  • 21.1 H5 mode
• 22. SPEI
  • 22.1 H5 mode
• 23. PagoEfectivo
  • 23.1 H5 mode
• 24. Interbank
  • 24.1 H5 mode
• 25 PayNow
  • 25.1 QR code no jump mode
• 26. P24
  • 26.1 H5 mode
• 27. Paysafecard
  • 27.1 H5 mode
• 28. IDEAL
  • 27.1 H5 mode
• 29. Evonet
  • 29.1 H5 mode
  • 29.2 Return parameter mode
  • 29.3 Qr code mode

1. WX

1.1 QR code no jump mode

This mode returns the QR code string, and merchants need to generate the QR code themselves.

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"QRCODE"

Response parameter "parameter" details

Parameter	Type	Required	Description
code_url	String	No	QR code string

1.2 QR code jump mode

This mode will redirect to the QR code page generated by GoAllPay.

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"QUICK"

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

1.3 WeChat Official Accounts payment

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"JSAPI"

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Payment URL

1.4 WeChat Mini Programs payment

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"APPLET"
openid	String	Yes	Wechat openid

Response parameter "parameter" details

Parameter	Type	Required	Description
sdk_params	Object	No	Required parameter for Mini Program payment.

Parameter sdk_params is used to call up the WeChat Mini Programs payment. Please refer to the WeChat Mini Programs integration specification.

1.5 APP mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"APP"

Response parameter "parameter" details

Parameter	Type	Required	Description
tn	String	No	Transaction serial number. Required parameter for Wechat app payment.

After getting tn, call the SDK to pay according to APP document.

2. AP

2.1 WebSite mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"WEB"

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

2.2 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"JSAPI"

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Payment URL

2.3 APP mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"APP"

Response message：

Parameter	Type	Required	Description
tn	String	No	Transaction serial number. Required parameter for Alipay app payment.

After getting tn, call the SDK to pay according to APP document.

2.4 QR code no jump mode

This mode returns the QR code string, and merchants need to generate the QR code themselves.

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"QRCODE"

Response parameter "parameter" details

Parameter	Type	Required	Description
code_url	String	No	QR code string

2.5 Alipay Mini Programs payment

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"APPLET"

Response parameter "parameter" details

Parameter	Type	Required	Description
sdk_params	String	No	Required parameter for Mini Program payment.

Parameter sdk_params is used to call up the Alipay Mini Programs payment. Please refer to the Alipay Mini Programs integration specification.

3. UP

3.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

3.2 APP mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"APP"

Response message：

Parameter	Type	Required	Description
tn	String	No	Transaction serial number. Required parameter for app payment.

After getting tn, call the SDK to pay according to APP document.

3.3 QR code no jump mode

This mode returns the QR code string, and merchants need to generate the QR code themselves.

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"QRCODE"

Response parameter "parameter" details

Parameter	Type	Required	Description
code_url	String	No	QR code string

3.4 Express Pay

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"PAN-PRESENT"
cardno	String	Yes	UnionPay card number
cvv	String	Yes	cvv2
expired	String	Yes	Expiry Date. Format: YYMM

Test cards:

Credit card：6250947000000014
mobile：+852 11112222
cvn2:  123
exp date: month 12 year 33
SMS Code on PC: 111111
SMS Code on Mobile: 123456

Debit card：6223164991230014
mobile：13012345678
PIN: 111111
cvn2:  123
exp date: month 12 year 33
SMS Code on PC：111111
SMS Code on Mobile：123456

Credit card：8171999927660000
mobile：+852 11112222
cvn2:  123
exp date: month 12 year 30
SMS Code on PC: 111111
SMS Code on Mobile: 123456

4. Apple Pay

4.1 APP mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"APP"

Response parameter "parameter" details

Parameter	Type	Required	Description
tn	String	No	Transaction serial number. Required parameter for Apple Pay.

After getting tn, call the SDK to pay according to APP document.

5. FC

5.1 H5 mode

5.1.1 CIL international card

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"

CIL test card

Card Number: 4761340000000019
Expiry Date: 1217
CVV2: 830

Card Number: 5204730000002555
Expiry Date: 1225
CVV2: 123

5.1.2 SN international card

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
billCountry	String	No	Billing country/region, 2-digit country code, such as: US
billState	String	No	Billing state/province/state, 2-digit code, such as: CA
billCity	String	No	Billing city
billStreet	String	No	Billing address
billEmail	String	No	Billing email
billPostalCode	String	No	Billing zip code
logisticsCountry	String	No	Logistics country/region, 2-digit country code, such as: US
logisticsState	String	No	Logistics state/province/state, 2-digit code, such as: CA
logisticsCity	String	No	Logistics city
logisticsStreet	String	No	Logistics address
logisticsPostalCode	String	No	Logistics zip code
logisticsEmail	String	No	Logistics email

SN test card

Card Number: 5309289710447190
Expiry Date: 0825
CVV2: 900

5.1.3 TL international card

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
email	String	No	Cardholder email
logisticsCountry	String	Yes	Logistics country/region, 2-digit country code, such as: US
logisticsState	String	Yes	Logistics state/province/state, 2-digit code, such as: CA
logisticsCity	String	Yes	Logistics city
logisticsStreet	String	Yes	Logistics address
logisticsPostalCode	String	Yes	Logistics zip code
logisticsPhone	String	Yes	Logistics phone number

TL test card

Card Number: 4012001037141112
Expiry Date: 1227
CVV2: 212

Card Number: 5204740000001002
Expiry Date: 1227
CVV2: 212

5.1.4 ICBC international card

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
ieu	String	Yes	Language identification. Portuguese: pt-BR English: en-US Chinese (simplified) : zh-CN Chinese (traditional) : zh-TW Please post these parameters strictly according to the document.

ICBC test card

Click the card number to get the SMS verification code.
Card 1: 4574108900117879
Card 2: 4377651201379895
Card 3: 5440163901773005
Card 4: 5305063800002981
Card 5: 5305066800004683
Card 6: 5305063800001223

5.1.5 RDP international card

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"

RDP test card

Card Number: 4111111111111111
Expiry Date: 122027
CVV2: 123

Card Number: 5200000900007102
Expiry Date: 122027
CVV2: 123

5.1.6 VT international card

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"

VT test card

Card Number: 4111111111111111
Expiry Date: 1227
CVV2: 123

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

5.2 Background mode (Applicable to SN and TL international card)

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"API"
cardNo	String	Yes	Card Number
expDate	String	Yes	Expiry Date. Format: MMYY
cvnCode	String	Yes	CVN
lastName	String	Yes	Last Name
firstName	String	Yes	First Name
billCountry	String	No	Billing country/region, 2-digit country code, such as: US
billState	String	No	Billing state/province/state, 2-digit code, such as: CA
billCity	String	No	Billing city
billStreet	String	No	Billing address
billEmail	String	No	Billing email
billPostalCode	String	No	Billing zip code
billPhone	String	No	Billing phone
logisticsCountry	String	No	Logistics country/region, 2-digit country code, such as: US
logisticsState	String	No	Logistics state/province/state, 2-digit code, such as: CA
logisticsCity	String	No	Logistics city
logisticsStreet	String	No	Logistics address
logisticsPostalCode	String	No	Logistics zip code
logisticsEmail	String	No	Logistics email
logisticsPhone	String	No	Logistics phone
pcToken2	String	No	Device fingerprint
forterTokenCookie	String	No	Client buried point
userIP	String	No	User IP

5.3 Background mode (Applicable to International card 3DS)

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"API-3DS"
cardNo	String	Yes	Card Number
expDate	String	Yes	Expiry Date. Format: MMYY
cvnCode	String	Yes	CVN
lastName	String	Yes	Last Name
firstName	String	Yes	First Name
billCountry	String	No	Billing country/region, 2-digit country code, such as: US
billState	String	No	Billing state/province/state, 2-digit code, such as: CA
billCity	String	No	Billing city
billStreet	String	No	Billing address
billEmail	String	Condition	Billing email. Required for RDP
billPostalCode	String	No	Billing zip code
billPhone	String	No	Billing phone
logisticsCountry	String	No	Logistics country/region, 2-digit country code, such as: US
logisticsState	String	No	Logistics state/province/state, 2-digit code, such as: CA
logisticsCity	String	No	Logistics city
logisticsStreet	String	No	Logistics address
logisticsPostalCode	String	No	Logistics zip code
logisticsEmail	String	No	Logistics email
logisticsPhone	String	No	Logistics phone
pcToken2	String	No	Device fingerprint
forterTokenCookie	String	No	Client buried point
userIP	String	No	User IP

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	3DS URL

6. RevPay

6.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
sub_brand_code	String	Yes	"boost", "grabpay", "touchngo", "maybankQR" Choose one of them.

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

7. AliPayPlus

7.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
sub_brand_code	String	Yes	"alipay_cn","gcash", "dana", "kakaopay", "alipay_hk", "truemoney", "tng", "bpi","connect_wallet","rabbit_line_pay" Choose one of them.

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

7.2 WebSite mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"WEB"
sub_brand_code	String	Yes	"alipay_cn","gcash", "dana", "kakaopay", "alipay_hk", "truemoney", "tng", "bpi","connect_wallet","rabbit_line_pay" Choose one of them.

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

7.3 QR code no jump mode

This mode returns the QR code string, and merchants need to generate the QR code themselves.

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"QRCODE"
sub_brand_code	String	Yes	"alipay_cn","gcash", "dana", "kakaopay", "alipay_hk", "truemoney", "tng", "bpi","connect_wallet","rabbit_line_pay" Choose one of them.

Response parameter "parameter" details

Parameter	Type	Required	Description
code_url	String	No	QR code string

7.4 APP mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"APP"
sub_brand_code	String	Yes	"alipay_cn","gcash", "dana", "kakaopay", "alipay_hk", "truemoney", "tng", "bpi","connect_wallet","rabbit_line_pay" Choose one of them.

Response parameter "parameter" details

Parameter	Type	Required	Description
tn	String	No	Transaction serial number. Required parameter for app payment.

After getting tn, call the SDK to pay according to APP document.

8. PO

8.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
tag	String	Yes	Options：directpay, boleto, webpay, trustpay, skrill, sepaddmodela, safetypay, qiwi, p24, poli, paysafecard, mybank, itau, ideal, hipercard, giropay, eps, enets, dragonpay, bancodobrasil, baloto, aura, payu, bcmc, santander, pagofacil, rapipago, konbini, payeasy, doku, ovo, grabpayotp, klarna
countrycode	String	Yes	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	String	Yes	The account holder - minimum of 3 characters, up to 100 characters.

When tag is paysafecard, you should add the following parameters:

Parameter	Type	Required	Description
consumerref	String	No	Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}

When tag is in aura, baloto, bancodobrasil, boleto, hipercard, itau, webpay, you should add the following parameters:

Parameter	Type	Required	Description
consumerref	String	Yes	Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20}
nationalid	String	Yes	Consumer’s national id (up to 30 characters)
email	String	Yes	RFC compliant email address of the account holder
address	String	Yes	Consumer's address
zipcode	String	Yes	Consumer's zip/postal code
dob	String	No	Date of birth, format YYYYMMDD

When tag is in dragonpay, enets, you should add the following parameters:

Parameter	Type	Required	Description
email	String	Yes	RFC compliant email address of the account holder
phone	String	Yes	Valid international phone number of the account holder

When tag is in giropay, directpay, you should add the following parameters:

Parameter	Type	Required	Description
bic	String	No	Valid BIC (8 or 11 alphanumeric letters) of consumer’s bank

When tag is in payu, p24, safetypay, you should add the following parameters:

Parameter	Type	Required	Description
email	String	Yes	RFC compliant email address of the account holder

When tag is qiwi, you should add the following parameters:

Parameter	Type	Required	Description
mobilephone	String	Yes	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).
siteid	String	Yes	Unique site identifier, forwarded to qiwi. Required for clients serving multiple points of sale.

When tag is skrill, you should add the following parameters:

Parameter	Type	Required	Description
email	String	No	RFC compliant email address of the account holder
address	String	No	Consumer's address
zipcode	String	No	Consumer's zip/postal code
city	String	No	Consumer’s city

When tag is sepaddmodela, you should add the following parameters:

Parameter	Type	Required	Description
email	String	Yes	RFC compliant email address of the account holder
iban	String	Yes	Valid IBAN

When tag is bcmc, you should add the following parameters:

Parameter	Type	Required	Description
BEPURL	String	No	Trigger URL for mobile payment options in the form BEP://1BC.GIROGATE.DE/BCMC/123456789$ICAE3BUIH5P9U53Y5HKA9CRT (contrived example).

When tag is in santander, pagofacil, rapipago, you should add the following parameters:

Parameter	Type	Required	Description
nationalid	String	Yes	Consumer’s national id (up to 30 characters)
consumerref	String	No	Unique reference identifying the consumer, has to satisfy the following regular expression: [A-Za-z0-9.%,&/+*$-]{1,20}
email	String	Yes	RFC compliant email address of the account holder

When tag is in konbini, payeasy, you should add the following parameters:

Parameter	Type	Required	Description
phone	String	Yes	Consumer phone number without hyphens, country code or other characters (single-byte alphanumeric; must be between 10-11 digits)
email	String	Yes	RFC compliant email address of the account holder
iteminfo	String	Yes	Information about the item(s) being purchased, displayed on the payment page (up to 22 characters)

When tag is in doku, ovo, you should add the following parameters:

Parameter	Type	Required	Description
email	String	Yes	RFC compliant email address of the account holder
orderitems	String	Yes	The list of items being purchased formatted as a JSON array. Allowed characters: alphanumeric, blank space, a hyphen, underscore, and dot. Each item contains the following fields:   • name: The name of the item   • price: The price of the item in major units. The cents must be in 00.   • quantity: The number of items bought. Integer.   • totalcost: The price multiplied by the quantity, in major units. The cents must be in 00. Example: [{\"name\":\"table\",\"price\":\"1000.00\",\"quantity\":2,\"totalcost\":\"2000.00\"},{\"name\":\"Laptop\",\"price\":\"15000.00\",\"quantity\":2,\"totalcost\":\"30000.00\"}] The total transaction amount is 32000.00

When tag is klarna, you should add the following parameters:

Parameter	Type	Required	Description
taxamount	String	Yes	The total tax amount of the order in the currency's minor units. This information is essential to provide detailed purchase information to the consumer (e.g., on the invoice).
paymentmethodcategory	String	No	The payment method category. Options:   • DIRECT_DEBIT   • DIRECT_BANK_TRANSFER   • PAY_NOW   • PAY_LATER   • PAY_OVER_TIME
billingaddress	String	Yes	The billing address. It is passed as a JSON string. Example: {\"city\":\"Munich\",\"country\":\"DE\",\"email\":\"test.customer@mpay.int\",\"phone\":\"07792555555\",\"family_name\":\"Doe\",\"given_name\":\"John Doe\",\"postal_code\":\"EH12 3AB\",\"street_address\":\"Ocean Point\"}
orderitems	String	Yes	The list of items being purchased formatted as a JSON array. Example: [{\"name\":\"apple\",\"quantity\":1,\"tax_rate\":1000,\"total_amount\":100,\"total_discount_amount\":20,\"total_tax_amount\":9,\"unit_price\":120}] Field description:   • name: String. Descriptive name of the order line item.   • quantity: Integer. Quantity of the order line item. Must be a non-negative number.   • tax_rate: Integer. Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. I.e 1000 = 10%.   • total_amount: Integer. Total amount of the order line. Must be defined as non-negative minor units. Includes tax and discount. Eg: 2500=25 euros. Value = (quantity * unit_price) - total_discount_amount. (max value: 100000000)   • total_discount_amount: Integer. Non-negative minor units. Includes tax. Eg: 500=5 euros.   • total_tax_amount: Integer. Total tax amount of the order line. Must be within ±1 of total_amount - total_amount * 10000 / (10000 + tax_rate). Negative when type is discount.   • unit_price: Integer. Price for a single unit of the order line. Non-negative minor units. Includes tax, excludes discount. (max value: 100000000)

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

9. India_Netbanking

9.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
bank_code	String	Yes	bank list
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: IN
document_id	String	Yes	Consumer's Indian PAN. Must be string with 10 alphanumeric letters. 5 letters, followed by 4 numbers, followed by 1 letter or number. Example: ABCDE1234F

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

10. PAYPAL

10.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

11. Neosurf

11.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: DE

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

Test Pincode: 2639777698

12. DNC

12.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

12.2 Background mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"API"
cardno	String	Yes	Card number. Encrypted with RSA public key
ExpiryDate	String	Yes	Expiry date. Format: MM/YY. Encrypted with RSA public key
cvv2	String	Yes	CVV2. Encrypted with RSA public key

Test card

Card Number: 5204730000002555
Expiry Date: 1225
CVV2: 123

13. Ksher

13.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
sub_brand_code	String	Yes	"linepay": Rabbit LINE Pay Wallet. "airpay": Shopeepay Wallet. "promptpay":PromptPay QR code (Thailand standard bank transfer QR code). "truemoney": TrueMoney Wallet. Choose one of them.

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

14. FPX

14.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
bank_code	String	Yes	bank list
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: IN

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

15. India_UPI

15.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: IN
document_id	String	Yes	Consumer's Indian PAN. Must be string with 10 alphanumeric letters. 5 letters, followed by 4 numbers, followed by 1 letter or number. Example: ABCDE1234F
virtual_payment_address	String	Yes	Virtual Payment Address (VPA) of the customer, format: someone@bank

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

16. Boleto

16.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
consumer_reference	String	Yes	Consumer reference is a unique consumer identifier
document_id	String	Yes	Document ID of the consumer. Consumer's Brazilian Identification Number(CPF or CNPJ). Must be string between 11 and 14 digits and to have full cpf validation.
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: BR

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

17. Baloto

17.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
consumer_reference	String	Yes	Consumer reference is a unique consumer identifier
national_id	String	Yes	National ID of the consumer. Consumer's Colombian Identification Number(CC). Must be string between 6 to 10 digits.
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: CO

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

18. PIX

18.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
document_id	String	是	Document ID of the consumer. Consumer's Brazilian Identification Number(CPF or CNPJ). Must be string between 11 and 14 digits and to have full cpf validation.
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: BR

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

19. PSE

19.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
consumer_reference	String	Yes	Consumer reference is a unique consumer identifier
national_id	String	Yes	National ID of the consumer. Consumer's Colombian Identification Number(CC). Must be string between 6 to 10 digits.
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: CO

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

20. Webpay

20.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
consumer_reference	String	Yes	Consumer reference is a unique consumer identifier
national_id	String	Yes	National ID of the consumer. Consumer's Chilean Identification Number(CI/RUT). Must be string between 8 to 9 digits.
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: CL

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

21. OXXO

21.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
consumer_reference	String	Yes	Consumer reference is a unique consumer identifier
national_id	String	Yes	National ID of the consumer. Consumer's Mexican Identification Number(CURP). Must be string between 10 and 18 digits.
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: MX

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

22. SPEI

22.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
document_id	String	Yes	Document ID of the consumer. Consumer's Mexican Identification Number(CURP). Must be string between 10 and 18 digits.
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: MX

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

23. PagoEfectivo

23.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
document_id	String	Yes	Document ID of the consumer. Consumer's Peruvian Identification Number(DNI). Must be string between 8 and 9 digits.
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: PE

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

24. Interbank

24.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
document_id	String	Yes	Document ID of the consumer. Consumer's Peruvian Identification Number(DNI). Must be string between 8 and 9 digits.
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: PE

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

25 PayNow

25.1 QR code no jump mode

This mode returns the QR code string, and merchants need to generate the QR code themselves.

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"QRCODE"
email	String	Yes	Customer email
payer_name	String	Yes	Customer name

Response parameter "parameter" details

Parameter	Type	Required	Description
code_url	String	No	QR code string

26. P24

26.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: PL

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

27. Paysafecard

27.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
email	String	Yes	Must contain valid e-mail of customer
phone	String	Yes	Must contain valid phone number of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: DE

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

28. IDEAL

27.1 H5 mode

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
email	String	Yes	Must contain valid e-mail of customer
firstname	String	Yes	Customer first name
lastname	String	Yes	Customer last name
address	String	Yes	address
zip_code	String	Yes	ZIP code
city	String	Yes	City
country	String(2)	Yes	Country code in ISO 3166. Example: NL

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

29. Evonet

29.1 H5 mode

This mode returns the payment url, and the merchant page redirects to this url to display the payment page.

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"H5"
sub_brand_code	String	Yes	Options: "paypay", "linepay", "truemoney", "rabbit_line_pay", "krungsri_online", "bualuang_ibanking", "ktb_netbank", "scb_easy_net", "k_plus", "dana", "ovo", "shopeepay_idn", "bni_va", "mandiri_va", "maybank_va", "permata_va", "bri_va", "cimb_va"
mobilePhone	String	No	User's mobile phone number. Example: 08011111111. This parameter is mandatory when sub_brand_code is "truemoney".

Response parameter "parameter" details

Parameter	Type	Required	Description
payUrl	String	No	Cashier URL

29.2 Return parameter mode

This mode returns payment parameter information, and the merchant needs to return to the customer.

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"CODE-PRESENT"
sub_brand_code	String	Yes	Options: "konbini", "payeasy", "bank_transfer_jpn"
paymentShop	String	No	Convenience store name. Options: "Daily_Yamazaki", "Family_Mart_JPN", "Lawson_JPN", "Ministop_JPN", "Seicomart", "Seven_Eleven_JPN". This parameter is mandatory when sub_brand_code is "konbini".
mobilePhone	String	No	User's mobile phone number. Example: 08011111111. This parameter is mandatory when sub_brand_code is "payeasy" or "bank_transfer_jpn".
name	String	No	User name. Example: "name":"[{\"givenName\": \"太郎\", \"familyName\": \"山田\"}, {\"givenName\": \"タロウ\", \"familyName\": \"ヤマダ\"}]". This parameter is mandatory when sub_brand_code is "payeasy" or "bank_transfer_jpn".

Response parameter "parameter" details

Parameter	Type	Required	Description
code_params	Object	No	Payment parameter information

29.3 Qr code mode

This mode returns a QR code download link, which the merchant needs to download and display to the customer.

Request parameters

Parameter	Type	Required	Description
tradeFrom	String	Yes	"QRCODE"
sub_brand_code	String	Yes	"promptpay"

Response parameter "parameter" details

Parameter	Type	Required	Description
code_url	String	No	Qr code download link