About MasaPay

General information about MasaPay

Logo

Info

Shanghai MasaPay Information Technology Co., Ltd. is a third-party transnational e-payment service provider which was established in July 2012. Her headquarter is based in Lujiazui Financial Service District, Shanghai, China.

MasaPay offers an Online Payment Gateway, which supports credit card payment of Visa, MasterCard, JCB, AMEX, Discover, Diners etc. MasaPay makes it possible that the cross-border payments from outside China are acquired in China.

Type

Payments by Credit Card

Further information can be found on the webpage of MasaPay (https://www.masapay.com/).

Card Scheme
MasterCard
VISA
AMEX
Diners
Discover
JCB

Process flow charts

If the synchronous response from MasaPay returns the payment result as 00 (Accepted) or 12 (Pending), MasaPay will send the final status in the asynchronous notification subsequent to the synchronous response. It’s also possible for the synchronous result 11 (Failed). Only 10 (Successful) is the final status either in the synchronous or in the asynchronous response.

MasaPay process flow over payssl.aspx

MasaPay process flow over direct.aspx

interface

Payment with MasaPay via form interface

To process a payment with MasaPay, please use the following URL:

payssl.aspx

Key	Format	CND	Description	Beschreibung
Currency	a3	M	Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. For merchants in China (inland) only CNY is permitted; CNY is not permitted for cross-border merchants. Please find an overview here: A1 Currency table	Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Für Händler in China (Inland) ist nur CNY erlaubt; CNY ist für grenzüberschreitende Händler nicht erlaubt. Hier eine Übersicht: A1 Währungstabelle

Key

Format

CND

Description

Beschreibung

Language

a2

(enum)

O

Accepted language code at MasaPay: "CN" Chinese, "EN" English, "FR" French, "DE" German, "ES" Spanish, "IT" Italian, "JA" Japanese, "RU" Russian, "KO" Korean, "TH" Thai, "SV" Swedish.

No detail means the language is EN. If the submitted Language is not supported by MasaPay, EN will be forwarded.

Code der akzeptierten Sprache bei MasaPay: "CN" Chinesisch, "EN" Englisch, "FR" Französisch, "DE" Deutsch, "ES" Spanisch, "IT" Italienisch, "JA" Japanisch, "RU" Russisch, "KO" Koreanisch, "TH" Thai, "SV" Schwedisch.

Ohne Angabe ist die Sprache EN. Wenn die übermittelte Language von MasaPay nicht unterstützt wird, wird EN weitergegeben.

OrderDesc

ans..768

M

Description of purchased goods. The special characters “#”, ”&”, ”%” and “+” are not permitted here.

Beschreibung der gekauften Waren. Die Sonderzeichen “#”, ”&”, ”%” und “+” sind hier nicht zulässig.

ArticleList

ans..2000

M

Article list, describes the individual items of the purchase goods.

Structure: <Product name>;<Article number>;<Gross individual price>;<Quantity>>;<Web link of article>

(<Web link of article> is optional)

<;> separates the fields of an article data set
<+> separates the article data sets

Data type (size):

Product name = ans..10
Article number = ans..30
Gross unit price = n..12 in the smallest currency unit (e.g. EUR Cent)
Quantity = n..5
Web link of article = ans..100

Example: Product1;11111;100;11; https://www.books.com/book1.bok+Product2;22222;150;12; https://www.books.com/book2.bok

Die Artikelliste beschreibt die einzelnen Elemente der gekauften Waren.

Aufbau: <Produktname>;<Artikelnummer>;<Bruttoeinzelpreis>;<Menge>>;<Webllink des Artikels>

(<Weblink des Artikels> ist optional)

<;> trennt Felder innerhalb eines Artikeldatensatzes
<+> trennt mehrere Artikeldatensätze

Datentyp (Größe):

Produktname = ans..10
Artikelnummer = ans..30
Bruttoeinzelpreis = n..12 in der kleinsten Währungseinheit (z.B. EUR Cent)
Menge = n..5
Weblink des Artikels = ans..100

Beispiel: Product1;11111;100;11; https://www.books.com/book1.bok+Product2;22222;150;12; https://www.books.com/book2.bok

Key	Format	CND	Description	Beschreibung
expirationTime	ans19	O	Timestamp for the end time of the transaction processing, specified in UTC. Format: YYYY-MM-ddTHH:mm:ss	Zeitstempel für den Endzeitpunkt der Transaktionsverarbeitung, Angabe in UTC. Format: YYYY-MM-ddTHH:mm:ss
CreditCardHolder	ans..100	O	Name of the credit card holder	Name des Kreditkarteninhabers

Key	Format	CND	Description	Beschreibung
			Billing data	Rechnungsdaten
bdFirstName	ans..50	M	First name in the invoicing address	Vorname in der Rechnungsadresse
bdLastName	ans..50	M	Last name in the invoicing address	Name in der Rechnungsadresse
bdStreet	ans..128	M	Street name in the invoicing address	Straßenname in der Rechnungsadresse
bdStreetNr	ans..10	M	Street number of the invoicing address	Hausnummer in der Rechnungsadresse
bdStreet2	ans..50	O	Address c/o of the invoicing address	Adresszusatz in der Rechnungsadresse
bdZip	ans..20	M	Postcode in the invoicing address	Postleitzahl in der Rechnungsadresse
bdCompany	ans..200	O	Company name in the invoicing address	Firmenname in der Rechnungsadresse
bdCountryCode	a2	M	Country code in the invoicing address (e.g. ‘de’)	Ländercode in der Rechnungsadresse (z.B. ‘de’)
bdState	ans..20	M	State/country in the invoicing address	Bundesland/Bezirk in der Rechnungsadresse
bdCity	ans..20	M	Town/city in the invoicing address	Stadt/Ort in der Rechnungsadresse
bdEmail	ans..100	M	Email address in the invoicing address	E-Mail-Adresse des Kunden
bdPhone	ans..20	M	Phone number in the invoicing address	Telefonummer des Kunden
bdMobileNr	ans..20	O	Mobile phone number in the invoicing address	Mobiltelefonnummer des Kunden
			Shipping data: If Shipping data are different to Billing data, all the parameters below (at least all the OC-parameters) should be submitted, otherwise the Billing data will be taken for the Shipping data!	Lieferdaten: Wenn sich die Lieferdaten von den Rechnungsdaten unterscheiden, sollten alle nachstehenden Parameter (mindestens alle OC-Parameter) übermittelt werden. Anderenfalls werden die Rechnungsdaten aus den Lieferdaten genommen!
sdFirstName	ans..50	OC	First name in the delivery address	Vorname in der Lieferadresse
sdLastName	ans..50	OC	Surname in the delivery address	Name in der Lieferadresse
sdStreet	ans..128	OC	Street in the delivery address	Straße in der Lieferadresse
sdStreetNr	ans..10	OC	Street number of the delivery address	Hausnummer in der Lieferadresse
sdStreet2	ans..50	O	Address addition in the delivery address	Adresszusatz in der Lieferadresse
sdZIP	ans..20	OC	Postcode in the delivery address	Postleitzahl in der Lieferadresse
sdCompany	ans..200	O	Company name in the delivery address	Firmenname in der Lieferadresse
sdCountryCode	a2	OC	Country code in the delivery address	Ländercode in der Lieferadresse
sdState	ans..20	OC	Federal state in the delivery address	Bundesland in der Lieferadresse
sdCity	ans..20	OC	Town/city in the delivery address	Stadt/Ort in der Lieferadresse
sdEmail	ans..100	OC	E-mail address in the delivery address	E-Mail-Adresse in der Lieferadresse
sdPhone	ans..20	OC	Phone number in the delivery address	Telefonnummer in der Lieferadresse
			Risk control: If the customer was registered at the merchant, the following registration parameters should be submitted.	Riskosteuerung: Falls der Kunde beim Händler registriert ist, sollten folgende Registrierungsparameter übermittelt werden.
Email	ans..60	O	E-mail address of the customer on registration at the merchant	E-Mail-Adresse des Kunden bei der Registrierung beim Händler
CustomerID	ans..20	O	Customer ID or customer number	Kunden-ID oder Kundennummer
Channel	a4	O	Used terminal by the time of ordering (MOTO: Mobile phone, ECOM: PC), it supersedes the configured default value.	Benutzer-Terminal für die Bestellung (MOTO: Mobiltelefon, ECOM: PC), das überschreibt den konfigurierten Standardwert.
IPAddr	ns..15	O	Fraud prevention: IP address when ordering	Betrugsprävention: IP-Adresse bei der Bestellung
RegistrationDate	ans19	O	Date and time when the customer has created the account	Datum und Uhrzeit, wann der Kunde sein Konto angelegt hat
RegistrationIP	ns..15	O	Customer registered IP address	Registrierte IP-Adresse des Kunden
RegistrationDevice	a4	O	Used terminal when the customer was registered (MOTO: Mobile phone, ECOM: PC), if not given the value of Channel will be taken.	Benutzer-Terminal für die Registrierung des Kunden (MOTO: Mobiltelefon, ECOM: PC), wenn nicht angegeben, wird der Wert von Channel verwendet.

Parameters for credit card payments with MasaPay

Key	Format	CND	Description	Beschreibung
Amount	n..10	M	Amount has to be equal to original authorized amount (cf. payment parameter Amount above)	Amount has to be equal to original authorized amount (cf. payment parameter Amount above)

Key	Format	CND	Description	Beschreibung
CCBrand	a..22	OC	In combination with PCNr: Name of credit card brand. Please note the spelling according to table of credit card brands!	In Verbindung mit PCNr: Bezeichnung der Kreditkartenmarke. Bitte beachten Sie die Schreibweise gemäß Tabelle der Kreditkartenmarken!
CCExpiry	n6	OC	In combination with PCNr: Expiry date of the credit card in the format YYYYMM (201706)	In Verbindung mit PCNr: Ablaufdatum der Kreditkarte im Format YYYYMM (201706)
CodeExt	ans..10	O	MasaPay error Code	Fehlercode von MasaPay
ErrorText	ans..128	O	Detailed MasaPay error message	Ausführliche Fehlermeldung von MasaPay

Return parameters for URLSuccess, URLFailure and URLNotify with MasaPay

Payment with MasaPay via Server-to-Server connection

To carry out a TLS credit card payment with MasaPay via a Server-to-Server connection, please use the following URL:

direct.aspx

Key	Format	CND	Description	Beschreibung
Currency	a3	M	Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. For merchants in China (inland) only CNY is permitted; CNY is not permitted for cross-border merchants. Please find an overview here: A1 Currency table	Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Für Händler in China (Inland) ist nur CNY erlaubt; CNY ist für grenzüberschreitende Händler nicht erlaubt. Hier eine Übersicht: A1 Währungstabelle

Key

Format

CND

Description

Beschreibung

CCCVC

n..4

M

Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express.

Kartenprüfnummer: Die letzten 3 Ziffern auf dem Unterschriftsfeld der Kreditkarte. Bei American Express 4 Ziffern.

CCExpiry

n6

M

Expiry date of the credit card in the format YYYYMM, e.g. 201707

Ablaufdatum der Kreditkarte im Format YYYYMM, z.B. 201707

CCBrand

a..22

M

Credit card brand. Please note the spelling according to table of credit card brands!

Only VISA, MasterCard, JCB, AMEX, Diners and DISCOVER are supported by MasaPay.

Kreditkartenmarke. Bitte beachten Sie die Schreibweise gemäß Tabelle der Kreditkartenmarken!

Von MasaPay werden nur VISA, MasterCard, JCB, AMEX, Diners und DISCOVER unterstützt.

Key

Format

CND

Description

Beschreibung

Language

a2

(enum)

O

Accepted language code at MasaPay: "CN" Chinese, "EN" English, "FR" French, "DE" German, "ES" Spanish, "IT" Italian, "JA" Japanese, "RU" Russian, "KO" Korean, "TH" Thai, "SV" Swedish.

No detail means the language is EN. If the submitted Language is not supported by MasaPay, EN will be forwarded.

Code der akzeptierten Sprache bei MasaPay: "CN" Chinesisch, "EN" Englisch, "FR" Französisch, "DE" Deutsch, "ES" Spanisch, "IT" Italienisch, "JA" Japanisch, "RU" Russisch, "KO" Koreanisch, "TH" Thai, "SV" Schwedisch.

Ohne Angabe ist die Sprache EN. Wenn die übermittelte Language von MasaPay nicht unterstützt wird, wird EN weitergegeben.

OrderDesc

ans..768

M

Description of purchased goods. The special characters “#”, ”&”, ”%” and “+” are not permitted here.

Beschreibung der gekauften Waren. Die Sonderzeichen “#”, ”&”, ”%” und “+” sind hier nicht zulässig.

ArticleList

ans..2000

M

Article list, describes the individual items of the purchase goods.

Structure: <Product name>;<Article number>;<Gross individual price>;<Quantity>>;<Web link of article>

(<Web link of article> is optional)

<;> separates the fields of an article data set
<+> separates the article data sets

Data type (size):

Product name = ans..10
Article number = ans..30
Gross unit price = n..12 in the smallest currency unit (e.g. EUR Cent)
Quantity = n..5
Web link of article = ans..100

Example: Product1;11111;100;11; https://www.books.com/book1.bok+Product2;22222;150;12; https://www.books.com/book2.bok

Die Artikelliste beschreibt die einzelnen Elemente der gekauften Waren.

Aufbau: <Produktname>;<Artikelnummer>;<Bruttoeinzelpreis>;<Menge>>;<Webllink des Artikels>

(<Weblink des Artikels> ist optional)

<;> trennt Felder innerhalb eines Artikeldatensatzes
<+> trennt mehrere Artikeldatensätze

Datentyp (Größe):

Produktname = ans..10
Artikelnummer = ans..30
Bruttoeinzelpreis = n..12 in der kleinsten Währungseinheit (z.B. EUR Cent)
Menge = n..5
Weblink des Artikels = ans..100

Beispiel: Product1;11111;100;11; https://www.books.com/book1.bok+Product2;22222;150;12; https://www.books.com/book2.bok

Key	Format	CND	Description	Beschreibung
expirationTime	ans19	O	Timestamp for the end time of the transaction processing, specified in UTC. Format: YYYY-MM-ddTHH:mm:ss	Zeitstempel für den Endzeitpunkt der Transaktionsverarbeitung, Angabe in UTC. Format: YYYY-MM-ddTHH:mm:ss
CreditCardHolder	ans..100	O	Name of the credit card holder	Name des Kreditkarteninhabers
			Billing data	Rechnungsdaten
bdFirstName	ans..50	M	First name in the invoicing address	Vorname in der Rechnungsadresse
bdLastName	ans..50	M	Last name in the invoicing address	Name in der Rechnungsadresse
bdStreet	ans..128	M	Street name in the invoicing address	Straßenname in der Rechnungsadresse
bdStreetNr	ans..10	M	Street number of the invoicing address	Hausnummer in der Rechnungsadresse
bdStreet2	ans..50	O	Address c/o of the invoicing address	Adresszusatz in der Rechnungsadresse
bdZip	ans..20	M	Postcode in the invoicing address	Postleitzahl in der Rechnungsadresse
bdCompany	ans..200	O	Company name in the invoicing address	Firmenname in der Rechnungsadresse
bdCountryCode	a2	M	Country code in the invoicing address (e.g. ‘de’)	Ländercode in der Rechnungsadresse (z.B. ‘de’)
bdState	ans..20	M	State/country in the invoicing address	Bundesland/Bezirk in der Rechnungsadresse
bdCity	ans..20	M	Town/city in the invoicing address	Stadt/Ort in der Rechnungsadresse
bdEmail	ans..100	M	Email address in the invoicing address	E-Mail-Adresse des Kunden
bdPhone	ans..20	M	Phone number in the invoicing address	Telefonummer des Kunden
bdMobileNr	ans..20	O	Mobile phone number in the invoicing address	Mobiltelefonnummer des Kunden
			Shipping data: If Shipping data are different to Billing data, all the parameters below (at least all the OC-parameters) should be submitted, otherwise the Billing data will be taken for the Shipping data!	Lieferdaten: Wenn sich die Lieferdaten von den Rechnungsdaten unterscheiden, sollten alle nachstehenden Parameter (mindestens alle OC-Parameter) übermittelt werden. Anderenfalls werden die Rechnungsdaten aus den Lieferdaten genommen!
sdFirstName	ans..50	OC	First name in the delivery address	Vorname in der Lieferadresse
sdLastName	ans..50	OC	Surname in the delivery address	Name in der Lieferadresse
sdStreet	ans..128	OC	Street in the delivery address	Straße in der Lieferadresse
sdStreetNr	ans..10	OC	Street number of the delivery address	Hausnummer in der Lieferadresse
sdStreet2	ans..50	O	Address addition in the delivery address	Adresszusatz in der Lieferadresse
sdZIP	ans..20	OC	Postcode in the delivery address	Postleitzahl in der Lieferadresse
sdCompany	ans..200	O	Company name in the delivery address	Firmenname in der Lieferadresse
sdCountryCode	a2	OC	Country code in the delivery address	Ländercode in der Lieferadresse
sdState	ans..20	OC	Federal state in the delivery address	Bundesland in der Lieferadresse
sdCity	ans..20	OC	Town/city in the delivery address	Stadt/Ort in der Lieferadresse
sdEmail	ans..100	OC	E-mail address in the delivery address	E-Mail-Adresse in der Lieferadresse
sdPhone	ans..20	OC	Phone number in the delivery address	Telefonnummer in der Lieferadresse
			Risk control: If the customer was registered at the merchant, the following registration parameters should be submitted.	Riskosteuerung: Falls der Kunde beim Händler registriert ist, sollten folgende Registrierungsparameter übermittelt werden.
Email	ans..60	O	E-mail address of the customer on registration at the merchant	E-Mail-Adresse des Kunden bei der Registrierung beim Händler
CustomerID	ans..20	O	Customer ID or customer number	Kunden-ID oder Kundennummer
Channel	a4	O	Used terminal by the time of ordering (MOTO: Mobile phone, ECOM: PC), it supersedes the configured default value.	Benutzer-Terminal für die Bestellung (MOTO: Mobiltelefon, ECOM: PC), das überschreibt den konfigurierten Standardwert.
IPAddr	ns..15	O	Fraud prevention: IP address when ordering	Betrugsprävention: IP-Adresse bei der Bestellung
RegistrationDate	ans19	O	Date and time when the customer has created the account	Datum und Uhrzeit, wann der Kunde sein Konto angelegt hat
RegistrationIP	ns..15	O	Customer registered IP address	Registrierte IP-Adresse des Kunden
RegistrationDevice	a4	O	Used terminal when the customer was registered (MOTO: Mobile phone, ECOM: PC), if not given the value of Channel will be taken.	Benutzer-Terminal für die Registrierung des Kunden (MOTO: Mobiltelefon, ECOM: PC), wenn nicht angegeben, wird der Wert von Channel verwendet.

Request parameters of credit card payment with MasaPay per server to server

The following table describes the result parameters that the sends back as response in a server-to-server connection, or transmits to your URLNotify when asynchronous notification from MasaPay has arrived. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

pls. be prepared to receive additional parameters at any time and do not check the order of parameters

the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Key	Format	CND	Description	Beschreibung
CCBrand	a..22	OC	In combination with PCNr: Name of credit card brand. Please note the spelling according to table of credit card brands!	In Verbindung mit PCNr: Bezeichnung der Kreditkartenmarke. Bitte beachten Sie die Schreibweise gemäß Tabelle der Kreditkartenmarken!
CCExpiry	n6	OC	In combination with PCNr: Expiry date of the credit card in the format YYYYMM (201706)	In Verbindung mit PCNr: Ablaufdatum der Kreditkarte im Format YYYYMM (201706)
CodeExt	ans..10	O	MasaPay error Code	Fehlercode von MasaPay
ErrorText	ans..128	O	Detailed MasaPay error message	Ausführliche Fehlermeldung von MasaPay

Response parameters of credit card payment with MasaPay per server to server connection

Capture

Captures are possible via a Server-to-Server connection. To perform a capture via a Server-to-Server connection please use the following URL:

capture.aspx

Key	Format	CND	Description	Beschreibung
Amount	n..10	M	Amount has to be equal to original authorized amount (cf. payment parameter Amount above)	Amount has to be equal to original authorized amount (cf. payment parameter Amount above)

Request parameters for capture of credit card payment with MasaPay

The following table describes the result parameters that the sends back as response in a server-to-server connection, or transmits to your URLNotify when asynchronous notification from MasaPay has arrived. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

pls. be prepared to receive additional parameters at any time and do not check the order of parameters

the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Key	Format	CND	Description	Beschreibung
Amount	n..10	M	Amount has to be equal to original authorized amount (cf. payment parameter Amount above)	Amount has to be equal to original authorized amount (cf. payment parameter Amount above)

Key	Format	CND	Description	Beschreibung
CodeExt	ans..10	O	MasaPay error Code	Fehlercode von MasaPay
ErrorText	ans..128	O	Detailed MasaPay error message	Ausführliche Fehlermeldung von MasaPay

Response parameters for capture of credit card payment with MasaPay

Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. If you refer to a capture for a Credit, 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:

credit.aspx

Request parameters for credit of credit card payment with MasaPay

The following table describes the result parameters that the sends back as response in a server-to-server connection, or transmits to your URLNotify when asynchronous notification from MasaPay has arrived. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

pls. be prepared to receive additional parameters at any time and do not check the order of parameters

the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Key	Format	CND	Description	Beschreibung
CodeExt	ans..10	O	MasaPay error Code	Fehlercode von MasaPay
ErrorText	ans..128	O	Detailed MasaPay error message	Ausführliche Fehlermeldung von MasaPay

Response parameters for credit of credit card payment with MasaPay

Reversal

A credit card authorisation lowers the customer's credit line. can reverse an authorisation so that it no longer block the limit any more. Reversals are possible via a Server-to-Server connection with the following URL:

reverse.aspx

Notice: Reverse.aspx does not only reverse authorisations, but any LAST TRANSACTION STAGE!! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use is at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx.

Key	Format	CND	Description	Beschreibung
Amount	n..10	O	Amount has to be equal to original authorized amount (cf. payment parameter Amount above)	Amount has to be equal to original authorized amount (cf. payment parameter Amount above)

Request parameters for reversal of credit card payment with MasaPay

The following table describes the result parameters that the sends back as response in a server-to-server connection, or transmits to your URLNotify when asynchronous notification from MasaPay has arrived. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

pls. be prepared to receive additional parameters at any time and do not check the order of parameters

the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Key	Format	CND	Description	Beschreibung
CodeExt	ans..10	O	MasaPay error Code	Fehlercode von MasaPay
ErrorText	ans..128	O	Detailed MasaPay error message	Ausführliche Fehlermeldung von MasaPay

Response parameters for reversal of credit card payment with MasaPay