APIs Interface

PGW SDK API Interface


Class PGWSDK

Methods

Data Type

Mandatory

Description

Constructors initialize(params)

PGWSDKParams

M

Init class constructor with PGW SDK params initialize

• SDK constructor
• Refer to: Init PGW SDK

instance/shared

PGWSDK

M

PGW SDK instance methods

pgwSDKParams

PGWSDKParams

M

PGW SDK params

clientId

String

O

Unique client ID

paymentOption
(request, response)

PaymentOptionRequest,
APIResponse

O

Payment option API method

Request: Refer to Payment Option Request API
Response: Refer to Payment Option Response API

paymentOptionDetail
(request, response)

PaymentOptionDetailRequest,
APIResponse

O

Payment option detail API method

Request: Refer to Payment Option Detail Request API
Response: Refer to Payment Option Detail Response API

proceedTransaction
(request, response)

TransactionResultRequest,
APIResponse

O

Do payment API method

Request: Refer to Do Payment Request API
Response: Refer to Do Payment Response API

cardTokenInfo
(request, response)

CardTokenInfoRequest,
APIResponse

O

Card token Info API method

Request: Refer to Card Token Info Request API
Response: Refer to Card Token Info Response API

exchangeRate
(request, response)

ExchangeRateRequest, APIResponse

O

Exchange rate API method

Request: Refer to Exchange Rate Request API
Response: Refer to Exchange Rate Response API

userPreference
(request, response)

UserPreferenceRequest, APIResponse

O

User preference API method

Request: Refer to User Preference Request API
Response: Refer to User Preference Response API

transactionStatus
(request, response)

TransactionStatusRequest, APIResponse

O

Transaction status API method

Request: Refer to Transaction Status Request API
Response: Refer to Transaction Status Response API

systemInitialization
(request, response)

SystemInitializationRequest,
APIResponse

O

System Initialization API method

Request: Refer to System Initialization Request API
Response: Refer to System Initialization Response API

paymentNotification
(request, response)

PaymentNotificationRequest,
APIResponse

O

Payment Notification API method

Request: Refer to Payment Notification Request API
Response: Refer to Payment Notification Response API

cancelTransaction
(request, response)

CancelTransactionRequest,
APIResponse

O

Cancel Transaction API method

Request: Refer to Cancel Transaction Request API
Response: Refer to Cancel Transaction Response API

 

Payment Option Request API


Class PaymentOptionRequest

Parameter

Data Type

Mandatory

Description

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
  • 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

 

Payment Option Response API


Class PaymentOptionResponse

Parameter

Data Type

Mandatory

Description

paymentToken

String

M

Payment token ID

merchantInfo

MerchantInfo

M

Merchant information

Refer to: Merchant Info

userInfo

UserInfo

C

User information

Refer to: User Info

User info can be passed via the Payment Token API

channels

PaymentChannelCategory

M

Payment channel category

Refer to: Payment Channel Category

transactionInfo

TransactionInfo

M

Transaction information.

Refer: Transaction Info

configurationInfo

ConfigurationInfo

M

Configuration information

Refer to: Configuration Info

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

Payment Option Detail Request API


Class PaymentOptionDetailRequest

Parameter

Data Type

Mandatory

Description

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

categoryCode

String

M

Payment channel category code

Refer to: Payment Option Response API

groupCode

String

M

Payment channel group code

Refer to: Payment Option Response API

 

Payment Option Detail Response API


Class PaymentOptionDetailResponse

Parameter

Data Type

Mandatory

Description

name

String

M

Payment channel title

categoryCode

String

M

Payment channel category code

groupCode

String

M

Payment channel group code

iconUrl

String

M

Payment channel icon URL

validation

CommonValidation

M

Payment channel global common validation

Refer to: Common Validation

channels

PaymentChannel

M

Payment channel list

Refer to: Payment Channel

totalChannel

Integer

M

Total channel count of payment channels

configurationInfo

ConfigurationInfo

O

Payment channel configuration information

Refer to: Configuration Info

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

Do Payment Request API


Class TransactionResultRequest

Parameter

Data Type

Mandatory

Description

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
  • 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

payment

PaymentRequest

M

Payment request of customer payment data

Refer to: Payment Request

 

Do Payment Response API


Class TransactionResultResponse

Parameter

Data Type

Mandatory

Description

channelCode

String

M

Payment channel code

Refer to: Payment Channels

invoiceNo

String

M

Transaction invoice number

  • Unique merchant order number
  • This is only returned when respCode is 2000 (transaction completed)

type

String

C

Payment data type

data

String

M

Payment data information

Refer to: API Response Code

fallbackData

String

C

Payment fallback data information

  • For payment flow 1004 only
  • If users don't have the specific native app installed, this fallback will allow users to pay via web payment

expiryTimer

Integer

C

Expiry timer countdown, in milliseconds

  • For payment flow 1005 only

expiryDescription

String

C

Payment expiry description

  • For payment flow 1005 only

additionalInfo

TransactionResultAdditionalInfo

C

Refer to Transaction Result Additional Info

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

Card Token Info Request API


Class CardTokenInfoRequest

Parameter

Data Type

Mandatory

Description

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 fromat

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

 

Card Token Info Response API


Class CardTokenInfoResponse

Parameter

Data Type

Mandatory

Description

paymentToken

String

M

Payment token ID

cardTokens

Array

M

Card token list

Refer to: Card Token Info

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

Exchange Rate Request API


Class ExchangeRateRequest

Parameter

Data Type

Mandatory

Description

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
  • 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

bin

String

O

Credit card BIN

BIN to retrieve Dynamic Currency Conversion currency data

 

Exchange Rate Response API


Class ExchangeRateResponse

Parameter

Data Type

Mandatory

Description

paymentToken

String

M

Payment token ID

providerCode

String

M

Exchange rate provider code

expire

Integer

M

Exchange rate offer expiry time

  • In Unix timestamp

fxRates

Array

M

Exchange rate list

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

User Preference Request API


Class UserPreferenceRequest

Parameter

Data Type

Mandatory

Description

Constructors (paymentToken)

String

M

Init class constructor with payment token

• 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
  • 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

 

User Preference Response API


Class UserPreferenceResponse

Parameter

Data Type

Mandatory

Description

paymentToken

String

M

Payment token ID

info

UserPreferenceInfo

M

User preference information

Refer to: User Preference Info

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

Transaction Status Request API


Class TransactionStatusRequest

Parameter

Data Type

Mandatory

Description

Constructors (paymentToken)

String

M

Init class constructor with payment token.

• 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
  • 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

additionalInfo

String

O

Additional transaction information

default = false

If set to true, the API will return more information as part of the response

 

Transaction Status Response API


Class TransactionStatusResponse

Parameter

Data Type

Mandatory

Description

channelCode

String

M

Payment channel code

invoiceNo

String

M

Transaction invoice number

  • Unique merchant order number
  • This is only returned when respCode is 2000 (transaction completed)

additionalInfo

TransactionStatusAdditionalInfo

O

Additional transaction information

Refer to: Transaction Status Additional Info

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

System Initialization Request API


Class SystemInitializationRequest

Parameter

Data Type

Mandatory

Description

Constructors (paymentToken)

String

M

Init class constructor with payment token

• 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
  • 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

 

System Initialization Response API


Class SystemInitializationResponse

Parameter

Data Type

Mandatory

Description

initialization

SystemInitialization

M

System Initialization information

Refer to: System Initialization

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

Payment Notification Request API


Class PaymentNotificationRequest

Parameter

Data Type

Mandatory

Description

Constructors (paymentToken)

String

M

Init class constructor with payment token

• 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
  • 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

platform

String

M

Platform type

Refer to: Payment Notification Platform Code

recipientId

String

M

User ID obtained from platform

recipientName

String

M

User name obtained from platform

 

Payment Notification Response API


Class PaymentNotificationResponse

Parameter

Data Type

Mandatory

Description

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

Cancel Transaction Request API


Class CancelTransactionRequest

Parameter

Data Type

Mandatory

Description

channelCode

String

M

Payment channel code
Refer to: Payment Channels

invoiceNo

String

M

Transaction invoice number

  • Unique merchant order number
  • This is only returned when respCode is 2000 (transaction completed)

type

String

C

Payment data type

  • For QR = QR data type

data

String

M

Payment data information

Refer to: API Response Code

fallbackData

String

C

Payment fallback data information

  • For payment flow 1004 only
  • If users don't have the specific native app installed, this fallback will allow users to pay via web payment

responseCode

String

M

API response code

responseDescription

String

M

API response description

 

Cancel Transaction Response API


Class CancelTransactionResponse

Parameter

Data Type

Mandatory

Description

channelCode

String

M

Payment channel code
Refer to: Payment Channels

invoiceNo

String

M

Transaction invoice number

  • Unique merchant order number
  • This is only returned when respCode is 2000 (transaction completed)

responseCode

String

M

API response code

responseDescription

String

M

API response description