Payment Process API

Payment Inquiry Request Parameter
Refund Request Parameter
Void / Cancel Request Parameter
Settle / Capture Request Parameter
Refund Status Inquiry Request Parameter
Response Parameter

 

📘

Data Attribute Reference

Data Type
A - Alphabet, N - Numeric, AN - AlphaNumeric, C - Characters, D - Decimal, B - Boolean

Mandatory
M - Mandatory, C - Conditional, O - Optional

 

Payment Inquiry Request Parameter


<PaymentProcessRequest>
  <version>3.8</version>
  <timeStamp></timeStamp>
  <merchantID></merchantID>
  <processType>I</processType>
  <invoiceNo></invoiceNo>
  <actionAmount></actionAmount>
</PaymentProcessRequest>

Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Version of the Payment Request
Current : 3.8

timeStamp

C 22

O

Date and time of request Message.

Format "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

processType

C 2

M

Payment process command.
I = Inquiry

invoiceNo

C 20

M

Invoice No / order ID

actionAmount

D 10,2

O

amount in 2 decimal format.

 

Refund Request Parameter


<PaymentProcessRequest>
  <version>3.8</version>
  <timeStamp></timeStamp>
  <merchantID></merchantID>
  <processType>R</processType>
  <invoiceNo></invoiceNo>
  <actionAmount></actionAmount>
  <bankCode></bankCode>
  <accountName></accountName>
  <accountNumber></accountNumber>
  <subMerchantList>
   <subMerchant subMID="" subAmount="" />
   <subMerchant subMID="" subAmount="" />
  </subMerchantList>
  <notifyURL></notifyURL>
  <idempotencyID></idempotencyID>
</PaymentProcessRequest>

Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Version of the Payment Request
Current : 3.8

timeStamp

C 22

O

Date and time of request Message.

Format "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

processType

C 2

M

Payment process command.
R = Refund

invoiceNo

C 20

M

Invoice No / order ID

actionAmount

D 10,2

M

Amount in 2 decimal format.

The amount should
not exceed original
transaction amount.

If partial refund was made, the total refund
amount (previous+current
refund) should not exceed original transaction amount.

bankCode

C 10

O

Customer’s bank
account’s bank code.

Only applicable to APM transaction.

accountName

C 50

O

Customer’s bank account name.

Only applicable to APM transaction.

accountNumber

C 50

O

Customer’s bank account number.

Only applicable to APM transaction.

subMerchantList

Array

O

Only applicable to
MasterMerchant
Account

subMerchant.subMID

C 15

M

Sub Merchant ID

subMerchant.subAmount

D 10,2

M

Refund amount in 2
decimal format.

The total of subAmount(s)
must match the actionAmount.

notifyURL

C 250

O

URL to notify final refund status.

will notify with the same format as ‘PaymentProcessRe
sponse’

userDefined1

C 150

O

User defined data

userDefined2

C 150

O

User defined data

userDefined3

C 150

O

User defined data

userDefined4

C 150

O

User defined data

userDefined5

C 150

O

User defined data

idempotencyID

C 100

O

Repeat request with same idempotencyID will return same response as the original response.

 

Void / Cancel Request Parameter


<PaymentProcessRequest>
  <version>3.8</version>
  <timeStamp></timeStamp>
  <merchantID></merchantID>
  <processType>S</processType>
  <invoiceNo></invoiceNo>
  <actionAmount></actionAmount>
  <bankCode></bankCode>
  <accountName></accountName>
  <accountNumber></accountNumber>
  <subMerchantList>
   <subMerchant subMID="" subAmount="" />
   <subMerchant subMID="" subAmount="" />
  </subMerchantList>
  <idempotencyID></idempotencyID>
</PaymentProcessRequest>

Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Version of the Payment Request
Current : 3.8

timeStamp

C 22

O

Date and time of request Message.

Format "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

processType

C 2

M

Payment process command.
V = Void/Cancel

invoiceNo

C 20

M

Invoice No / order ID

actionAmount

D 10,2

O

Amount in 2 decimal format.

The amount should
not exceed original
transaction
amount.

subMerchantList

Array

O

Only applicable to
MasterMerchant
Account

userDefined1

C 150

O

User defined data.

userDefined2

C 150

O

User defined data.

userDefined3

C 150

O

User defined data.

userDefined4

C 150

O

User defined data.

userDefined5

C 150

O

User defined data.

idempotencyID

C 100

O

repeat request with same
idempotencyID will return same response as the original response.

 

Settle / Capture Request Parameter


<PaymentProcessRequest>
  <version>3.8</version>
  <timeStamp></timeStamp>
  <merchantID></merchantID>
  <processType>S</processType>
  <invoiceNo></invoiceNo>
  <actionAmount></actionAmount>
  <subMerchantList>
   <subMerchant subMID="" subAmount="" />
   <subMerchant subMID="" subAmount="" />
  </subMerchantList>
  <idempotencyID></idempotencyID>
</PaymentProcessRequest>

Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Version of the Payment Request
Current : 3.8

timeStamp

C 22

O

Date and time of request Message.

Format "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

processType

C 2

M

Payment process command.
S = Settlement

invoiceNo

C 20

M

Invoice No / order ID

actionAmount

D 10,2

M

Amount in 2
decimal format.

The amount should
not exceed original
transaction amount.

subMerchantList

Array

O

Only applicable to
MasterMerchant
Account

subMerchant.subMID

C 15

M

Sub Merchant ID

subMerchant.subAmount

D 10,2

M

Settle amount in 2 decimal format.

The total of subAmount(s)
must match the actionAmount.

userDefined1

C 150

O

User defined data.

userDefined2

C 150

O

User defined data.

userDefined3

C 150

O

User defined data.

userDefined4

C 150

O

User defined data.

userDefined5

C 150

O

User defined data.

idempotencyID

C 100

O

repeat request with same
idempotencyID will return same response as the original response.

 

Refund Status Inquiry Request Parameter


Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Version of the Payment Request
Current : 3.8

timeStamp

C 22

O

Date and time of request Message.

Format "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

processType

C 2

M

Payment process command.
RS = Refund Status

invoiceNo

C 20

M

Invoice No / order ID

actionAmount

D 10,2

O

amount in 2 decimal format.

 

Response Parameter


<PaymentProcessResponse>
  <version></version>
  <timeStamp></timeStamp>
  <respCode></respCode>
  <respDesc></respDesc>
  <processType></processType>
  <invoiceNo></invoiceNo>
  <amount></amount>
  <status></status>
  <approvalCode></approvalCode>
  <referenceNo></referenceNo>
  <transactionDateTime></transactionDateTime>
  <paidAgent></paidAgent>
  <paidChannel></paidChannel>
  <maskedPan></maskedPan>
  <eci></eci>
  <subMerchantList>
   <subMerchant subMID="" subAmount="" />
   <subMerchant subMID="" subAmount="" />
  </subMerchantList>
  <refundList>
   <refund referenceNo="" status="" amount="" dateTime=””
  userDefined1="" userDefined2="" userDefined3="" userDefined4=""
  userDefined5="" />
   <refund referenceNo="" status="" amount="" dateTime=””
  userDefined1="" userDefined2="" userDefined3="" userDefined4=""
  userDefined5=""/>
  </refundList>
  <paymentScheme></paymentScheme>
  <processBy></processBy>
  <idempotencyID></idempotencyID>
</PaymentProcessResponse>

Parameter

Data Type / Length

Mandatory

Description

version

AN 5

M

Version of the Payment Action Request.

Current version 3.8

timeStamp

C 22

M

Date and time of request Message.

format of "ddMMyyHHmmss".

respCode

C 2

M

Response code

Refer to Response Code List

respDesc

C 100

M

Response code description

processType

C 2

M

Payment process
command.
I = Inquiry
S = Settlement
V = Void/Cancel
R = Refund
RS = Refund Status

invoiceNo

C 20

M

Transaction unique invoice number
generated by merchant.

amount

D 10,2

M

Payment amount made by customer, or refund /
captured amount.

status

C 3

M

Status of the transaction
requested.

Refer to Status Code List

approvalCode

C 6

O

Transaction Approval Code.

Provided by Credit
Card Host or from
WebPay provider.

referenceNo

C 30

O

Reference number.

refundReferenceNo

C 30

O

Refund Reference
number.

transactionDateTime

C 14

O

Transaction Date Time value.

format of "yyyyMMddHHmmss".

paidAgent

C 30

O

Agent Code that customer made payment with.

Refer to Agent List

paidChannel

C 30

O

Channel Code that customer made payment with.

Refer to Channel List

maskedPan

C 16

O

Masked Credit Card Number.

eci

C 3

O

3DS E-Commerce
Indicator.

Only for card payment.

subMerchantList

[Array]

O

Only applicable to
MasterMerchant Account.

subMerchant.subMID

C 15

M

Sub Merchant ID.

Required only for
Master Merchant Account.

subMerchant.subAmount

D 10,2

M

Refunded / settled
amount in 2 decimal format.

Required only for
Master Merchant Account.

refundList

[Array]

O

Only applicable to Refund Status request.

refund.referenceNo

C 30

M

Refund reference number.

Returned by PGW when
refund request was completed.

refund.status

C 3

M

Refund status.

Refer to Status List.

refund.amount

D 10,2

M

Payment amount made by customer, or refund /
captured amount.

refund.dateTime

C 14

M

Refund approval Date Time.

Format of
"yyyyMMddHHmmss"

refund.userDefined1

C 150

O

User defined data.

refund.userDefined2

C 150

O

User defined data.

refund.userDefined3

C 150

O

User defined data.

refund.userDefined4

C 150

O

User defined data.

refund.userDefined5

C 150

O

User defined data.

paymentScheme

C 2

O

Card brand / Payment Scheme.

Refer to Card Scheme List.

processBy

C 2

O

Payment Process By code.

Refer to Process By List.

userDefined1

C 150

O

User defined data.

userDefined2

C 150

O

User defined data.

userDefined3

C 150

O

User defined data.

userDefined4

C 150

O

User defined data.

userDefined5

C 150

O

User defined data.

idempotencyID

C 100

O

Repeat request with same idempotencyID will
return same response as the original response.