Payment Request

Init PGW SDK


Class PGWSDKParamsBuilder

Parameter

Data Type

Mandatory

Description

Constructors (apiEnvironment)

APIEnvironment

M

PGW SDK API endpoint environment

 

• SDK constructor
• Refer to: API Environment

clientId

String

O

Unique client ID

  • In UUID format

locale

String

O

Locale of API response

  • Based on ISO 639 codes

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 to: Payment Code
• Token: Card token (Generated and returned by the 2C2P payment gateway if the payment's storeCard option is set to 'true')

Constructors (channelCode, token)

String, String

C

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

• SDK constructor
• Refer to: Payment Option Detail Response API
• Token: Card token (Generated and returned by the 2C2P payment gateway if the payment's storeCard option is set to 'true')

expiryMonth

Integer

O

Credit card expiry month

  • Only used to update card token expiry month

expiryYear

Integer

O

Credit card expiry year

  • Only used to update card token expiry year.

securityCode

String

O

Credit card security code

pin

String

O

Credit card PIN

installmentInterestType

String

C

Installment interest type

Refer to: Installment Interest Type Code

installmentPeriod

Integer

C

Installment period, in months

fxRateId

String

O

Exchange rate ID

Refer to: Exchange Rate Response API

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry

The date/time when the customer must complete the payment. Payments 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 to: Payment Code

Constructors (channelCode, cardNo)

String, String

C

Init class constructor with payment channel code and credit card number

• SDK constructor
• Refer to: 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

Allows customer to tokenize card information

Allows merchant to indicate if the Store Card feature is enabled

• false – No (default)
• true – Yes

installmentInterestType

String

C

Installment interest type

Refer to: Installment Interest Type Code

installmentPeriod

Integer

C

Installment period, in months

fxRateId

String

O

Exchange rate ID

Refer to: Exchange Rate Response API

name

String

O

Customer’s name

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry

The date/time when the customer must complete the payment. Payments 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 to Payment Option Detail Response API

fxRateId

String

O

Exchange rate ID

Refer to: Exchange Rate Response API

name

String

O

Customer’s name

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry

The date/time when the customer must complete the payment. Payments 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 to: Payment Option Detail Response API

fxRateId

String

O

Exchange rate IF

 

Refer to: Exchange Rate Response API

name

String

O

Customer’s name

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry.

The date/time when the customer must complete the payment. Payments 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 to: Payment Option Detail Response API

fxRateId

String

O

Exchange rate ID

Refer to: Exchange Rate Response API

name

String

O

Customer’s name

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry

The date/time when the customer must complete the payment. Payments 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 to: Payment Option Detail Response API

fxRateId

String

O

Exchange rate ID

Refer to: Exchange Rate Response API

name

String

O

Customer’s name

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry

The date/time when the customer must complete the payment. Payments 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 to Exchange Rate Response API

name

String

O

Customer’s name

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry

The date/time when the customer must complete the payment. Payments 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 to: Payment Option Detail Response API

type

String

O

QR data type

Refer to: QR Type Code

fxRateId

String

O

Exchange rate ID

Refer to: Exchange Rate Response API

name

String

O

Customer’s name

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry

The date/time when the customer must complete the payment. Payments 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 to: Payment Code

Constructors (channelCode)

String

C

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

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

fxRateId

String

O

Exchange rate ID

Refer to: Exchange Rate Response API

name

String

O

Customer’s name

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry

The date/time when the customer must complete the payment. Payments 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 to: 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 to: 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

Allows merchant to indicate if the Store Card feature is enabled

• false – No (default)
• true – Yes

installmentInterestType

String

O

Installment interest type

Refer to: Installment Interest Type Code

installmentPeriod

Integer

O

Installment period, in months

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 to: QR Type Code

fxRateId

String

O

Exchange rate ID

Refer to: Exchange Rate Response API

name

String

O

Customer’s name

email

String

O

Customer’s email address

mobileNo

String

O

Customer’s mobile number

userAddress

UserAddress

O

Customer's address

userAddress:
Refer to: User Address

User Address Builder:
Refer to: User Address For Payment

paymentExpiry

String

O

Payment expiry

The date/time when the customer must complete the payment. Payments 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 codes

  • If locale is empty, the API will respond based on the payment token locale.

  • If locale is indicated, the API will respond with the requested locale

  • If the clientID is indicated, the API will respond with the user's selected locale

with

PaymentRequest

O

Payment request from payment builder
Refer to: 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 to: User Billing Address