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 |
instance/shared | PGWSDK | M | PGW SDK instance methods |
pgwSDKParams | PGWSDKParams | M | PGW SDK params |
clientId | String | O | Unique client ID |
paymentOption | PaymentOptionRequest, | O | Payment option API method |
paymentOptionDetail | PaymentOptionDetailRequest, | O | Payment option detail API method |
proceedTransaction | TransactionResultRequest, | O | Do payment API method |
cardTokenInfo | CardTokenInfoRequest, | O | Card token Info API method |
exchangeRate | ExchangeRateRequest, APIResponse | O | Exchange rate API method |
userPreference | UserPreferenceRequest, APIResponse | O | User preference API method |
transactionStatus | TransactionStatusRequest, APIResponse | O | Transaction status API method |
systemInitialization | SystemInitializationRequest, | O | System Initialization API method |
paymentNotification | PaymentNotificationRequest, | O | Payment Notification API method |
cancelTransaction | CancelTransactionRequest, | O | Cancel Transaction API method |
Payment Option Request API
Class PaymentOptionRequest |
Parameter | Data Type | Mandatory | Description |
---|---|---|---|
Constructors (paymentToken) | String | M | Init class constructor with payment token ID |
clientId | String | O | Unique client ID
|
locale | String | O | Locale of API response
|
Payment Option Response API
Class PaymentOptionResponse |
Parameter | Data Type | Mandatory | Description |
---|---|---|---|
paymentToken | String | M | Payment token ID |
merchantInfo | MerchantInfo | M | Merchant information |
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 |
transactionInfo | TransactionInfo | M | Transaction information. |
configurationInfo | ConfigurationInfo | M | Configuration information |
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
|
clientId | String | O | Unique client ID
|
locale | String | O | Locale of API response
|
categoryCode | String | M | Payment channel category code |
groupCode | String | M | Payment channel group code |
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 |
channels | PaymentChannel | M | Payment channel list |
totalChannel | Integer | M | Total channel count of payment channels |
configurationInfo | ConfigurationInfo | O | Payment channel configuration information |
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 |
clientId | String | O | Unique client ID
|
locale | String | O | Locale of API response.
|
payment | PaymentRequest | M | Payment request of customer payment data |
Do Payment Response API
Class TransactionResultResponse |
Parameter | Data Type | Mandatory | Description |
---|---|---|---|
channelCode | String | M | Payment channel code |
invoiceNo | String | M | Transaction invoice number
|
type | String | C | Payment data type |
data | String | M | Payment data information |
fallbackData | String | C | Payment fallback data information
|
expiryTimer | Integer | C | Expiry timer countdown, in milliseconds
|
expiryDescription | String | C | Payment expiry description
|
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
|
clientId | String | O | Unique client ID
|
locale | String | O | Locale of API response.
|
Card Token Info Response API
Class CardTokenInfoResponse |
Parameter | Data Type | Mandatory | Description |
---|---|---|---|
paymentToken | String | M | Payment token ID |
cardTokens | Array | M | Card token list |
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
|
clientId | String | O | Unique client ID
|
locale | String | O | Locale of API response.
|
bin | String | O | Credit card BIN |
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
|
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 |
clientId | String | O | Unique client ID
|
locale | String | O | Locale of API response
|
User Preference Response API
Class UserPreferenceResponse |
Parameter | Data Type | Mandatory | Description |
---|---|---|---|
paymentToken | String | M | Payment token ID |
info | UserPreferenceInfo | M | User preference information |
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 |
clientId | String | O | Unique client ID
|
locale | String | O | Locale of API response
|
additionalInfo | String | O | Additional transaction information |
Transaction Status Response API
Class TransactionStatusResponse |
Parameter | Data Type | Mandatory | Description |
---|---|---|---|
channelCode | String | M | Payment channel code |
invoiceNo | String | M | Transaction invoice number
|
additionalInfo | TransactionStatusAdditionalInfo | O | Additional transaction information |
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 |
clientId | String | O | Unique client ID
|
locale | String | O | Locale of API response
|
System Initialization Response API
Class SystemInitializationResponse |
Parameter | Data Type | Mandatory | Description |
---|---|---|---|
initialization | SystemInitialization | M | System Initialization information |
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 |
clientId | String | O | Unique client ID
|
locale | String | O | Locale of API response
|
platform | String | M | Platform type |
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 |
invoiceNo | String | M | Transaction invoice number
|
type | String | C | Payment data type
|
data | String | M | Payment data information |
fallbackData | String | C | Payment fallback data information
|
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 |
invoiceNo | String | M | Transaction invoice number
|
responseCode | String | M | API response code |
responseDescription | String | M | API response description |
Updated 11 months ago