Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation
Table of Contents


Info
titleAvailibility

UnionPay SecurePay is available starting on 2021-03-25.

About UnionPay SecurePay

General information about UnionPay SecurePay


Page properties
Logo

Info
Excerpt

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.

TypePayments by eWallet


Process flow chart

Image Removed
Multiexcerpt
MultiExcerptNameProcessFlow

draw.io Diagram
bordertrue
diagramNameProcessflow_Chinaunionpay_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1110

UnionPay SecurePay process flow


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording

Paygate

interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Payment with UnionPay SecurePay via form interface

In order to make a payment with UnionPay in China, please go to use the following URL:

https://www.computop-paygate.com/Chinaunionpay.aspx

Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
Chinaunionpay.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1655122859965_-1985569800
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameunionpay_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1655122859968_514587593
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

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

Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Key

Format

CND

Description

Beschreibung

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

code

, three digits DIN / ISO

-4217. Supported currencies

4217, e.g. EUR, USD, GBP. Only CHF allowed. Please find an overview here: A1 Currency table EN.

Supported currencies: USD, EUR, HKD, SGD, CAD, GBP, CHF, AUD, NZD, JPY, CNY.

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Nur CHF zulässig. Hier eine Übersicht: A1 Währungstabelle.

Unterstützte Währungen: USD, EUR, HKD, SGD, CAD, GBP, CHF, AUD, NZD, JPY, CNY.

Table Excerpt Include
statictrue
nameMAC
page

an64

MAC
type

M

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

URLSuccess

ans..256

M

Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData.

Response

a7

O

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

URLNotify

ans..256

M

Complete URL which Paygate 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, Paygate forwards the parameter with the payment result to the shop

ReqID

ans..32

O

page

Table Excerpt Include
statictrue
nameURLSuccess
pageURLSuccess
typepage

Table Excerpt Include
statictrue
nameURLFailure
pageURLFailure
typepage

Table Excerpt Include
statictrue
nameResponse
pageResponse
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

Beschreibung

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, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate 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.

Beschreibung der Waren und Preise. Verwendungszweck auf dem Kontoauszug.

Table Excerpt Include
statictrue
nameSellingPoint
pageSellingPoint

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.

typepage

Table Excerpt Include
statictrue
nameService
pageService
typepage

Table Excerpt Include
statictrue
nameChannel
pageChannel
typepage

Key

Format

CND

Description

Beschreibung

Languagea2O

2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumer.

Possible values:

CodeLanguage
CNSimplified Chinese
TWTraditional Chinese
USEnglish
JPJapanese
KRKorean

2-stelliger Sprachcode (z. B. de), der bei der Darstellung von Zahlungsseiten für den Kunden bevorzugt werden sollte.

Mögliche Werte:

CodeSprache
CNVerinfachtes Chinesisch
TWTraditionelles Chinesisch
USEnglisch
JPJapanisch
KRKoreanisch
AccOwner

ans..50

M

Name of account holder

Name des Kontoinhabers
AddrCountryCodea2O

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

Parameters for payments with UnionPay SecurePay

Ländercode der Rechnungsadresse des Kontoinhabers, 2 Zeichen gemäß ISO 3166. Nur 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 zulässig.

Hinweis: Wenn in der Anfrage nicht angegeben, wird der Standard-Ländercode „CN“ übermittelt.

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Parameters for payments with UnionPay SecurePay


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1655123761325_-1666997777
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameunionpay_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1655123761327_-1524188127
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

The following table describes the result parameters that the Paygate transmits to your URLSuccess, URLFailure or URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate 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 Paygate

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 Paygate Response Codes (A4 Error codes)

MAC

an64

M

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

UserData

ans..1024

O

If specified at request, Paygate 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

Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Table Excerpt Include
statictrue
nameStatus_OK_AUTHORIZE_REQUEST
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
namePaymentPurpose
pagePaymentPurpose
typepage

Table Excerpt Include
statictrue
namePaymentGuarantee
pagePaymentGuarantee
typepage

Table Excerpt Include
statictrue
nameErrorText_PPRO
pageErrorText
typepage

Key

Format

CND

Description

Beschreibung

Detailed PPRO error message.

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

TransactionID

an..20

O

Unique transaction number with PPRO

Eindeutige Transaktionsnummer bei PPRO

Table Excerpt Include
statictrue
namePlain
pagePlain

ans..50

O

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

typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

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

Return parameters for URLSuccess, URLFailure and URLNotify with UnionPay SecurePay

 


Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture.

To carry out a credit with a reference transaction, please use the following URL:

https://www.computop-paygate.com/credit.aspx

Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be credited

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
credit.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1655121268600_1697226209
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1655121268602_1149083573
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Credit
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

ID assigned by Merchant for the payment process to be credited

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 ISO-4217. Supported currencies:

Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Key

Format

CND

Description

Beschreibung

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Only CHF allowed. Please find an overview here: A1 Currency table EN.

Supported currencies: USD, EUR, HKD, SGD, CAD, GBP, CHF, AUD, NZD, JPY, CNY.

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Nur CHF zulässig. Hier eine Übersicht: A1 Währungstabelle.

Unterstützte Währungen: USD, EUR, HKD, SGD, CAD, GBP, CHF, AUD, NZD, JPY, CNY.

Table Excerpt Include
statictrue
nameMAC

an64

M

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

ReqID

pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId

OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the

typepage

transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for credit payments with UnionPay with UnionPay SecurePay via socket connection

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1655122007937_-1488644883
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1655122007939_-452232841
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate 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 Paygate

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 Paygate Response Codes (A4 Error codes)

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
Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Table Excerpt Include
statictrue
nameErrorText_PPRO
pageErrorText
typepage

Response parameters for credit payments with UnionPay with UnionPay SecurePay via socket connection