Developer ZoneRecipesAPI ReferenceChangelog
Developer Zone
These docs are for v4.0.2. Click to read the latest docs for v4.3.0.

APIs Interface

PGW SDK API Interface


Class PGWSDK
MethodsData TypeMandatoryDescription
Constructors initialize(params)PGWSDKParamsM

Init class constructor with PGW SDK params initialize
• SDK constructor
• Refer to: Init PGW SDK

instance/sharedPGWSDKMPGW SDK instance methods
pgwSDKParamsPGWSDKParamsMPGW SDK params
clientIdStringOUnique client ID
paymentOption (request, response)PaymentOptionRequest,
APIResponse<PaymentOptionResponse>
O

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

paymentOptionDetail (request, response)PaymentOptionDetailRequest,
APIResponse<PaymentOptionDetailResponse>
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<TransactionResultResponse>
O

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

cardTokenInfo (request, response)CardTokenInfoRequest,
APIResponse<CardTokenInfoResponse>
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<ExchangeRateResponse>
O

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

userPreference (request, response)UserPreferenceRequest,
APIResponse<UserPreferenceResponse>
O

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

transactionStatus (request, response)TransactionStatusRequest,
APIResponse<TransactionStatusResponse>
O

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

systemInitialization (request, response)SystemInitializationRequest,
APIResponse<SystemInitializationResponse>
O

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

paymentNotification (request, response)PaymentNotificationRequest,
APIResponse<PaymentNotificationResponse>
O

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

cancelTransaction (request, response)CancelTransactionRequest,
APIResponse<CancelTransactionResponse>
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
ParameterData TypeMandatoryDescription
paymentTokenStringMPayment token ID
merchantInfoMerchantInfoM

Merchant information
Refer to: Merchant Info

userInfoUserInfoC

User information
Refer to: User Info
User info can be passed via the Payment Token API

channelsPaymentChannelCategoryM

Payment channel category
Refer to: Payment Channel Category

transactionInfoTransactionInfoM

Transaction information
Refer to: Transaction Info

configurationInfoConfigurationInfoM

Configuration information
Refer to: Configuration Info

responseCodeStringMAPI response code
responseDescriptionStringMAPI response description

 

Payment Option Detail Request API


Class PaymentOptionDetailRequest
ParameterData TypeMandatoryDescription
Constructors (paymentToken)StringM

Init class constructor with payment token ID

  • SDK constructor
  • Payment token: Retrieve from Payment Token API
clientIdStringO

Unique client ID

  • In UUID format
localeStringO

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
categoryCodeStringM

Payment channel category code
Refer to: Payment Option Response API

groupCodeStringM

Payment channel group code
Refer to: Payment Option Response API

 

Payment Option Detail Response API


Class PaymentOptionDetailResponse
ParameterData TypeMandatoryDescription
nameStringMPayment channel title
categoryCodeStringMPayment channel category code
groupCodeStringMPayment channel group code
iconUrlStringMPayment channel icon URL
validationCommonValidationM

Payment channel global common validation
Refer to: Common Validation

channelsPaymentChannelM

Payment channel list
Refer to: Payment Channel

totalChannelIntegerMTotal channel count of payment channels
configurationInfoConfigurationInfoO

Payment channel configuration information
Refer to: Configuration Info

responseCodeStringMAPI response code
responseDescriptionStringMAPI response description

 

Do Payment Request API


Class TransactionResultRequest
ParameterData TypeMandatoryDescription

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
paymentPaymentRequestM

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
additionalInfoTransactionResultAdditionalInfoCRefer to Transaction Result Additional Info
responseCodeStringMAPI response code
responseDescriptionStringMAPI 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
ParameterData TypeMandatoryDescription
paymentTokenStringMPayment token ID
cardTokensArray<CardTokenInfo>M

Card token list
Refer to: Card Token Info

responseCodeStringMAPI response code
responseDescriptionStringMAPI response description

 

Exchange Rate Request API


Class ExchangeRateRequest
ParameterData TypeMandatoryDescription
Constructors (paymentToken)StringM

Init class constructor with payment token ID

  • SDK constructor
  • Payment token: Retrieve from Payment Token API
clientIdStringO

Unique client ID

  • In UUID format
localeStringO

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
binStringO

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
fxRatesArray<FXRate>MExchange rate list
responseCodeStringMAPI response code
responseDescriptionStringMAPI 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
ParameterData TypeMandatoryDescription
paymentTokenStringMPayment token ID
infoUserPreferenceInfoM

User preference information
Refer to: User Preference Info

responseCodeStringMAPI response code
responseDescriptionStringMAPI response description

 

Transaction Status Request API


Class TransactionStatusRequest
ParameterData TypeMandatoryDescription
Constructors (paymentToken)StringM

Init class constructor with payment token.
• SDK constructor
• Payment token: Retrieve from Payment Token API

clientIdStringO

Unique client ID

  • In UUID format

localeStringO

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
additionalInfoStringO

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
ParameterData TypeMandatoryDescription
channelCodeStringMPayment channel code
invoiceNoStringM

Transaction invoice number

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

Additional transaction information
Refer to: Transaction Status Additional Info

responseCodeStringMAPI response code
responseDescriptionStringMAPI 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
ParameterData TypeMandatoryDescription
initializationSystemInitializationM

System Initialization information
Refer to: System Initialization

responseCodeStringMAPI response code
responseDescriptionStringMAPI response description

 

Payment Notification Request API


Class PaymentNotificationRequest
ParameterData TypeMandatoryDescription
Constructors (paymentToken)StringM

Init class constructor with payment token
• SDK constructor
• Payment token: Retrieve from Payment Token API

clientIdStringO

Unique client ID

  • In UUID format

localeStringO

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
platformStringM

Platform type
Refer to: Payment Notification Platform Code

recipientIdStringMUser ID obtained from platform
recipientNameStringMUser name obtained from platform

 

Payment Notification Response API


Class PaymentNotificationResponse
ParameterData TypeMandatoryDescription
responseCodeStringMAPI response code
responseDescriptionStringMAPI 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
responseCodeStringMAPI response code
responseDescriptionStringMAPI 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)
responseCodeStringMAPI response code
responseDescriptionStringMAPI response description