Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata

About Asiapay

General information about Asiapay


Logo

Info

Asiapay has 3 platforms: PesoPay for payment in Philippines, SiamPay for payment in Thailand and PayDollar for payment in all the other countries. The platform can be configured in MAT.

TypePayments by eWallet EN

Further information can be found at the webpage of Asiapay (http://www.asiapay.com/).

On this page

Configuration within Asiapay merchant portal

For connecting with Computop Paygate the merchant has to define the link within the Asiapay merchant portal with the following steps.

Please login to the merchant portal.

Click on blue Tab "Profile" in the left and then click on "Payment Options" in the section "Profile Setting".

In the field "Datafeed" insert the link https://www.computop-paygate.com/AsiapayComplete.aspx and click on button "Update".


Process flow chart

Asiapay process flow


Paygate interface

Definitions

Data formats

Format

Description

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)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Payment with Asiapay via Paygate form interface

Enter the following URL to process an Asiapay payment via the Paygate form:


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

Merchant transaction number, which must be unique

RefNr

ns..30

O

Unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217

PayType

a..32

M

Payment method. Details see below in table PayType

MAC

an64

M

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

OrderDesc

ans..768

M

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

Language

a1

M

Language:

E – English
C – Traditional Chinese
X – simplyfied Chinese
J – Japanese
T – Thai
F – French
G – German
R – Russian
S – Spanish
V – Vietnamese

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

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.

InstallmentNumber

n..2

O

Number of monthly instalments

InstallmentData

bool

O

Mandatory check for instalment payments (true/false)

TicketNr

ans..13

O

Number of flight ticket

QuoteMode

a3

O

Multi-Currency Processing Service-Mode (MPS):

“NIL” or not specified – deactivate MPS (merchant does not use MPS)

“SCP” – activate MPS with ‘simple currency conversion’

“SCP” – activate MPS with ‘dynamic currency conversion’

“MCP” – activate MPS with ‘multi currency pricetags’

QuoteID

an..12

O

unique rate ID

Quote

n..14

O

Exchange rate between merchant's base currency and the foreign currency

LocalCurrency

a3

O

Code of foreign currency, three digits DIN / ISO 4217

LocalAmount

n..10

O

Calculation amount in foreign currency

Promotion

ans..128

O

Activate promotion (With this the merchant can use promotion campaigns of credit cards within the online shop):

Promotion-Code;PromotionRuleCode;PromotionOriginalAmt

CountryCode

a..3

O

Country code of the origin address according to ISO-3166-1, alphanumeric 2 or 3 characters, for example:

CHA – China

HKG – Hong Kong

USA – United States of America

sdCountryCode

a..3

O

Country code of the destination country according to ISO-3166-1, alphanumeric 2 or 3 characters, for example:

CHA – China

HKG – Hong Kong

USA – United States of America

Print

bool

O

Deactivate print function on page with payment result (true/false)

Retry

bool

O

Deactivate repeat function for rejected payments (true/false)

Timeout

n2

OC

For OCTOPUS payment only: Timeout for the payment in seconds from 180 to 7200

HideAmount

bool

O

Flag to control the display of the amount (true/false)

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 Asiapay


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 forwarded 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 assigned by Paygate for all single transactions (capture, credit), which are made for one payment.

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or AUTHORIZED (URLSuccess) as well as FAILED (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

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

Return parameters for URLSuccess, URLFailure and URLNotify with Asiapay


The following table provides an overview of the possible values for PayType:

PayType

Description of payment methode

ALL

All available payment methods

CC

Credit card

VISA

Visa

Master

MasterCard

JCB

JCB

AMEX

American Express

Diners

Diners Club

PPS

PayDollar PPS

PAYPAL

PayPal by PayDollar Payment

CHINAPAY

China UnionPay by PayDollar Payment

ALIPAY

ALIPAY by PayDollar Payment

TENPAY

TENPAY by PayDollar Payment

99BILL

99BILL by PayDollar Payment

MEPS

MEPS by PayDollar Payment

SCB

SCB (SCB Easy) by PayDollar Payment

BPM

Bill Payment by PayDollar Payment

KTB

Krung thai Bank (KTB Online) by PayDollar Payment

UOB

United Oversea bank by PayDollar Payment

KRUNGSRIONLINE

Bank of Ayudhya (KRUNGSRIONLINE) by PayDollar Payment

TMB

TMB Bank by PayDollar Payment

IBANKING

Bangkok Bank iBanking by PayDollar Payment

UPOP

UPOP by PayDollar Payment

M2U

M2U by PayDollar Payment

CIMBCLICK

CIMBCLICK by PayDollar Payment

OCTOPUS

OCTOPUS by PayDollar Payment

WECHAT

WECHAT by PayDollar Payment

ONEPAY

ONEPAY by PayDollar Payment

VCO

VISA Checkout

MP

MasterPass

Values for PayType in case of Asiapay



Capture

Captures are possible via a Server-to-Server connection. To carry out a Capture via a Server-to-Server connection please use the following URL:


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 captured

TransID

ans..64

MC

ID assigned by Merchant for the payment process to be captured

MAC

an64

M

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

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217

RefNr

ns..30

O

Merchant’s unique reference number

ReqIDans..32OTo 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.

Parameters for capture of a Asiapay payment


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..50

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

ns..30

M

Merchant’s unique reference number

Response parameters for capturing an Asiapay payment



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:


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

TransID

ans..64

M

ID assigned by Merchant for the payment process to be credited

Amount

n..10

M

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

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

Currency

a..3

M

Currency, three digits DIN / ISO 4217

MAC

an64

M

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

RefNr

ns..30

O

Merchant’s unique reference number

ReqIDans..32OTo 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.

Parameters for credits with Asiapay


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 transaction number, which must be unique

Status

a..50

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

ns..30

O

Merchant’s unique reference number

Response parameters for credits with Asiapay