Payment Request

Android: Constructors (context, apiEnvironment)
iOS: Constructors (apiEnvironment)

Context, 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.

Important:
• 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.

log

Boolean

O

PGW SDK log information.

Constructors (paymentCode, token)

PaymentCode, String

C

Init class constructor with payment code and customer token ID.

• SDK constructor.
• Refer to: Payment Code
• Token: Customer 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 customer token ID.

• SDK constructor.
• Refer to: Payment Option Detail Response API
• Token: Customer 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 use for update customer token expiry month.

expiryYear

Integer

O

Credit card expiry year.

* Only use for update customer 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.

installmentPayLaterPeriod

Integer

C

Installment pay later period.

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

customerNote

String

O

Customer's note.

loyaltyPoints

Array<LoyaltyPoint>

C

Loyalty points redeem list.

loyaltyPoints: Refer Loyalty Point

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

• If true, 2C2P Payment Gateway will return Customer Token on Payment Inquiry.

installmentInterestType

String

C

Installment interest type.

Refer to: Installment Interest Type Code

installmentPeriod

Integer

C

Installment period, in months.

installmentPayLaterPeriod

Integer

C

Installment pay later period.

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

customerNote

String

Customer's note.

loyaltyPoints

Array<LoyaltyPoint>

Loyalty points redeem list.

LoyaltyPoints: Refer Loyalty Point

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

customerNote

String

O

Customer's note.

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

customerNote

String

O

Customer's note.

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

customerNote

String

O

Customer's note.

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

customerNote

String

O

Customer's note.

cardNo

String

O

Credit card number.

expiryMonth

Integer

O

Credit card expiry month.

expiryYear

Integer

O

Credit card expiry year.

issuedMonth

Integer

O

Credit card issued month.

issuedYear

Integer

O

Credit card issued year.

securityCode

String

O

Credit card security code.

bank

String

O

Credit card issuer bank name.

country

String

O

Credit card issuer country code.

tokenize

Boolean

O

Allows customer to tokenize card information.

Allows merchant to indicate if the Store Card feature is enabled.

• false – No (default)
• true – Yes

• If true, 2C2P Payment Gateway will return Customer Token on Payment Inquiry .

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

tokenize

Boolean

O

Allows customer to tokenize card information.

Allows merchant to indicate if the Store Card feature is enabled.

• false – No (default)
• true – Yes

• If true, 2C2P Payment Gateway will return Customer Token on Payment Inquiry

customerNote

String

O

Customer's note

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

customerNote

String

O

Customer's note.

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

installmentPayLaterPeriod

Integer

O

Installment pay later period.

customerNote

String

O

Customer's note.

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 customer to tokenize card information.

Allows merchant to indicate if the Store Card feature is enabled.

• false – No (default)
• true – Yes

• If true, 2C2P Payment Gateway will return Customer Token on Payment Inquiry

installmentInterestType

String

O

Installment interest type.

Refer to: Installment Interest Type Code

installmentPeriod

Integer

O

Installment period, in months.

installmentPayLaterPeriod

Integer

O

Installment pay later period.

token

String

O

Token from customer 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

customerNote

String

O

Customer's note.

loyaltyPoints

Array<LoyaltyPoint>

O

Loyalty points redeem list

LoyaltyPoints: Refer Loyalty Point

issuedMonth

Integer

O

Credit card issued month.

issuedYear

Integer

O

Credit card issued year.

Constructors (paymentToken)

String

M

Init class constructor with payment token ID.

• SDK constructor.
• Payment token: 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.

Important:
• 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 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
• Deep Link Payment
• Online Direct Debit Payment
• Loyalty Point Payment
• Digital Currency Payment

Constructors ()

C

Init class constructor.

userBillingAddress

UserBillingAddress

O

Customer's billing address information.

userBillingAddress:
Refer to: User Billing Address

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

• SDK constructor.
• paymentCode: 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.
• channelCode, agentCode, agentChannelCode: refer Payment Option Detail Response API

fxRateId

String

O

Exchange rate ID.

fxRateId: 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: 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

customerNote

String

O

Customer's note.

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

• SDK constructor.
• paymentCode: 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.
• channelCode, agentCode, agentChannelCode: refer Payment Option Detail Response API

fxRateId

String

O

Exchange rate ID.

fxRateId: 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: 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

customerNote

String

O

Customer's note.

tokenize

Boolean

O

Allows customer to tokenize card information.

Allows merchant to indicate if the Store Card feature is enabled.

• false – No (default)
• true – Yes

• If true, 2C2P Payment Gateway will return Customer Token on Payment Inquiry

token

String

O

Token from customer token ID.

Constructors (paymentCode)

PaymentCode, String

C

Init class constructor with payment code.

• SDK constructor.
• paymentCode: refer Payment Code

Constructors (channelCode)

String, String

C

Init class constructor with payment channel code.

• SDK constructor.
• channelCode: 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

C

Allows customer to tokenize card information.

Allows merchant to indicate if the Store Card feature is enabled.

• false – No (default)
• true – Yes

• If true, 2C2P Payment Gateway will return Customer Token on Payment Inquiry

installmentInterestType

String

C

Installment interest type.

Refer to: Installment Interest Type Code

installmentPeriod

Integer

C

Installment period in month.

installmentPayLaterPeriod

Integer

C

Installment pay later period.

token

String

O

Token from customer token ID.

fxRateId

String

O

Exchange rate ID.

fxRateId: 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: 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

customerNote

String

O

Customer's note.

loyaltyPoints

Array<LoyaltyPoint>

C

Loyalty points redeem list.

loyaltyPoints: refer Loyalty Point

Constructors (paymentCode)

PaymentCode

C

Init class constructor with payment code.

• SDK constructor.
• paymentCode: refer Payment Code

Constructors (channelCode)

String

C

Init class constructor with payment channel code.

• SDK constructor.
• channelCode: refer Payment Option Detail Response API

fxRateId

String

O

Exchange rate ID.

fxRateId: 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: 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

customerNote

String

O

Customer's note.

Constructors (activity)

Activity

M

Init class constructor with Android activity.

• SDK constructor.
• activity: refer https://developer.android.com/reference/android/app/Activity

Constructors (uiViewController)

UIViewController

M

Init class constructor with iOS UI View controller.

• SDK constructor.
• uiViewController: refer https://developer.apple.com/documentation/uikit/uiviewcontroller