UPI’s innovations enable its bank customers to offer consumers choices: pay now with debit, ahead of time with prepaid or later with credit products. From the world’s major cities to remote areas without banks, people are increasingly relying on digital currency along with mobile technology to use their money anytime and make purchases online, transfer funds and access basic financial services.

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)

CND

condition

M

mandatory

O

optional

C

conditional

https://paymentpage.axepta.bnpparibas/Chinaunionpay.aspx

MerchantID

ans..30

M

ID of merchant. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

Merchant transaction number, which must be unique

RefNr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only USD, EUR, HKD, SGD, CAD, GBP, CHF, AUD, NZD, JPY, CNY permissible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

URLSuccess

ans..256

M

Complete URL which calls up Payment platform if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Payment platform and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Payment platform if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Payment platform and shop, please use the parameter UserData.

Response

a7

O

Status response sent by Payment platform to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

ans..256

M

Complete URL which Payment platform calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

UserData

ans..1024

O

If specified at request, Payment platform forwards the parameter with the payment result to the shop

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

OrderDesc

ans..768

M

Description of goods and prices. Intended purpose on the statement of account

SellingPoint

ans..50

O

Selling point

Service

ans..50

O

Products or service sold

Channel

ans..64

O

Configuration channel of the PPRO contract (account and ContractID are stored in the system). If it exists, it may overwrite channels stored in the system.

2-letter language code that should be preferred when presenting payment pages to the consumer.

Possible values:
CN: Simplified Chinese
TW: Traditional Chinese
US: English
JP: Japanese
KR: Korean

AccOwner

ans..50

M

Name of account holder

Country code for the account holder’s invoicing address, 2 characters according to ISO 3166. Only AE, AG, AT, AU, AZ, BD, BE, BN, BY, CA, CN, DE, ES, FI, FR, GB, GE, HK, HU, ID, IE, IT, JP, KE, KG, KH, KR, KZ, LB, LI, LK, LT, LU, MG, MN, MO, MT, MU, MX, MY, NL, NP, NZ, PA, PF, PH, PT, RU, SC, SG, SI, SK, SR, TH, TJ, TZ, US, VN allowed.

Notice: If not provided in the request the default country code "CN" is submitted.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

MID

ans..30

M

ID of merchant

PayID

an32

M

ID assigned by Payment platform for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Payment platform

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

Status

a..30

M

OK in the case of URLSuccess and AUTHORIZE_REQUEST or FAILED in the case of URLFailure

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Payment platform Response Codes Excel file

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

If specified at request, Payment platform forwards the parameter with the payment result to the shop

PaymentPurpose

ans..26

M

Purpose of payment

PaymentGuarantee

a..12

C

NONE = no payment guarantee,

VALIDATED= customer account valid, but no payment guarantee,

FULL= payment guarantee

Notice: This parameter is only returned if the Status=OK.

ErrorText

ans..256

C

Detailed PPRO error message.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with support.

TransactionID

an..20

O

Unique transaction number with PPRO

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

https://paymentpage.axepta.bnpparibas/credit.aspx

MerchantID

ans..30

M

ID of merchant. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Payment platform for the payment to be credited

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a..3

M

Currency code, three digits DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

MID

ans..30

M

ID of merchant

PayID

an32

M

ID assigned by Payment platform for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Payment platform

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Payment platform Response Codes Excel file

RefNr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

ErrorText

ans..256

O

Detailed PPRO error message