Payment Request

Init PGW SDK
Global/Local Card Token Payment (GCARD / LCARD)
Global/Local Card Payment (GCARD / LCARD / LCARDIPP)
Internet Banking (IMBANK)
Pay At Counter (COUNTER)
Self Service Machine (SSM)
Web Payment (WEBPAY)
Digital Payment (DPAY)
QR Payment (QR)
Buy Now Pay Later Payment (BNPL)
Universal Payment (Any type of payment)
Do Payment Request
User Address For Payment

 

Init PGW SDK


Class PGWSDKParamsBuilder

Parameter

Data Type

Mandatory

Description

Constructors (apiEnvironment)

APIEnvironment

M

PGW SDK API endpoint environment.

 

• SDK constructor
• Refer API Environment

clientId

String

O

Unique client id.

In UUID format.

locale

String

O

Locale of API response.
Based on ISO 639.

log

Boolean

O

PGW SDK log information.

 

Global/Local Card Token Payment (GCARD / LCARD)


Class CardTokenPaymentBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode, token)

PaymentCode, String

C

Init class constructor with payment code and card token id.

• SDK constructor
• Refer Payment Code
• Token: Card token (generated and returned by 2c2p payment gateway if payment send with storeCard option value is true)

Constructors (channelCode, token)

String, String

C

Init class constructor with payment channel code and card token id.

• SDK constructor
• Refer Payment Option Detail Response API
• token: Card token (generated and returned by 2c2p payment gateway if payment send with storeCard option value is true)

expiryMonth

Integer

O

Credit card expiry month.

Only use for update card token expiry month.

expiryYear

Integer

O

Credit card expiry year.

Only use for update card token expiry month.

securityCode

String

O

Credit card security code.

pin

String

O

Credit card pin.

installmentInterestType

String

C

Installment interest type.

Refer Installment Interest Type Code

installmentPeriod

Integer

C

Installment period in month.

fxRateId

String

O

Exchange rate id.

Refer Exchange Rate Response API

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

Global/Local Card Payment (GCARD / LCARD / LCARDIPP)


Class CardPaymentBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode, cardNo)

PaymentCode, String

C

Init class constructor with payment code and credit card number.

• SDK constructor
• Refer Payment Code

Constructors (channelCode, cardNo)

String, String

C

Init class constructor with payment channel code and credit card number.

• SDK constructor
• Refer Payment Option Detail Response API

expiryMonth

Integer

O

Credit card expiry month.

expiryYear

Integer

O

Credit card expiry year.

securityCode

String

O

Credit card security code.

pin

String

O

Credit card pin.

bank

String

O

Credit card issuer bank name.

country

String

O

Credit card issuer country code.

tokenize

Boolean

C

Allowing customer to tokenize card info.

Allowing merchant to specify if store card feature is enabled.

• false – No (default)
• true – Yes

installmentInterestType

String

C

Installment interest type.

Refer Installment Interest Type Code

installmentPeriod

Integer

C

Installment period in month.

fxRateId

String

O

Exchange rate id.

Refer Exchange Rate Response API

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

Internet Banking (IMBANK)


Class InternetBankingBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

• SDK constructor
• Refer Payment Code

Constructors (channelCode, agentCode, agentChannelCode)

String, String, String

C

Init class constructor with payment channel code, agent code and agent channel code.

• SDK constructor
• agentChannelCode: Refer Payment Option Detail Response API

fxRateId

String

O

Exchange rate id.

Refer Exchange Rate Response API

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

Pay At Counter (COUNTER)


Class PayAtCounterBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code

• SDK constructor
• Refer Payment Code

Constructors (channelCode, agentCode, agentChannelCode)

String, String, String

C

Init class constructor with payment channel code, agent code and agent channel code.

• SDK constructor
• agentChannelCode : Refer Payment Option Detail Response API

fxRateId

String

O

Exchange rate id.

 

Refer Exchange Rate Response API

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

Self Service Machine (SSM)


Class SelfServiceMachineBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

• SDK constructor
• Refer Payment Code

Constructors (channelCode, agentCode, agentChannelCode)

String, String, String

C

Init class constructor with payment channel code, agent code and agent channel code.

• SDK constructor
• agentChannelCode : Refer Payment Option Detail Response API

fxRateId

String

O

Exchange rate id.

Refer Exchange Rate Response API

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

Web Payment (WEBPAY)


Class WebPaymentBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

 
• SDK constructor
• Refer Payment Code

Constructors (channelCode, agentCode, agentChannelCode)

String, String, String

C

Init class constructor with payment channel code, agent code and agent channel code.

• SDK constructor
• agentChannelCode : Refer Payment Option Detail Response API

fxRateId

String

O

Exchange rate id.

Refer Exchange Rate Response API

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

Digital Payment (DPAY)


Class DigitalPaymentBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

• SDK constructor
• Refer Payment Code

Constructors (channelCode)

String

C

Init class constructor with payment channel code.

• SDK constructor
• agentChannelCode: Refer Payment Option Detail Response API

accountNo

String

O

Customer’s account number.

token

String

O

Digital payment token.

fxRateId

String

O

Exchange rate id.
refer 2.11 Exchange Rate Response API

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

QR Payment (QR)


Class QRPaymentBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

• SDK constructor
• Refer Payment Code

Constructors (channelCode)

String

C

Init class constructor with payment channel code.

• SDK constructor
• agentChannelCode: Refer Payment Option Detail Response API

type

String

O

QR data type.

Refer QR Type Code

fxRateId

String

O

Exchange rate id.

Refer Exchange Rate Response API

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

Buy Now Pay Later Payment (BNPL)


Class BuyNowPayLaterPaymentBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

• SDK constructor
• Refer Payment Code

Constructors (channelCode)

String

C

Init class constructor with payment channel code, agent code and agent channel code.

• SDK constructor
• agentChannelCode: Refer Payment Option Detail Response API

fxRateId

String

O

Exchange rate id.

Refer Exchange Rate Response API

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

Universal Payment (Any type of payment)


Class UniversalPaymentBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

• SDK constructor
• Refer Payment Code

Constructors (channelCode, agentCode, agentChannelCode)

String, String, String

C

Init class constructor with payment channel code, agent code and agent channel code.

• SDK constructor
• agentChannelCode: Refer Payment Option Detail Response API

cardNo

String

O

Credit card number.

expiryMonth

Integer

O

Credit card expiry month.

expiryYear

Integer

O

Credit card expiry year.

securityCode

String

O

Credit card security code.

pin

String

O

Credit card pin.

bank

String

O

Credit card issuer bank name.

country

String

O

Credit card issuer country code.

tokenize

Boolean

O

Allowing merchant to specify if store card feature is enabled.

• false – No (default)
• true – Yes

installmentInterestType

String

O

Installment interest type.

Refer Installment Interest Type Code

installmentPeriod

Integer

O

Installment period in month.

token

String

O

Token from card token id or digital payment.

accountNo

String

O

Customer’s account number.

qrType

String

O

QR data type.

Refer QR Type Code

fxRateId

String

O

Exchange rate id.

Refer Exchange Rate Response API

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

userAddress

UserAddress

O

Customer's address.

userAddress:
Refer User Address

User address Builder:
Refer User Address For Payment

paymentExpiry

String

O

Payment expiry.

Date/time which the customer allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

 

Do Payment Request


Class TransactionResultRequestBuilder

Parameter

Data Type

Mandatory

Description

Constructors (paymentToken)

String

M

Init class constructor with payment token id.

• SDK constructor
• retrieve from Payment Token API

clientId

String

O

Unique client id.
In UUID format.

locale

String

O

Locale of API response.

Based on ISO 639.
if locale is empty, api will response based on payment token locale.

if locale is exist, api will response with requested locale.

if clientID exist, api will response with user preference locale

with

PaymentRequest

O

Payment request from payment builder. Refer Refer Payment Request.

Payment request builder:
Global/Local Card Token Payment
Global/Local Card Payment
Internet Banking
Pay At Counter
Self Service Machine
Web Payment
Digital Payment
QR Payment
Buy Now Pay Later Payment
Universal Payment

 

User Address For Payment


Class UserAddressBuilder

Parameter

Data Type

Mandatory

Description

Constructors ()

C

Init class constructor.

userBillingAddress

UserBillingAddress

O

Customer's billing address information.

userBillingAddress:
Refer User Billing Address