Payment Enums
API Environment
Enum APIEnvironment |
Parameter | Data Type | Description |
---|---|---|
Production | String | Production API environment endpoint. • For all countries excluding Indonesia. |
ProductionIndonesia | String | Indonesia production API environment endpoint. • Only for Indonesia. |
Sandbox | String | Sandbox API environment endpoint. • For testing. |
API Response Codes
Enum APIResponseCode |
Parameter | Data Type | Description |
---|---|---|
APISuccess | String | General API success. |
TransactionAuthenticateRedirect | String | Load redirect URL with iframe or webview. • Client should close the iframe when the URL is loading the result URL and read the BODY message. |
TransactionAuthenticateFullRedirect | String | Full redirect to third-party web page. |
TransactionExternalBrowser | String | Load redirect URL within new tab in external web browser. or Load redirect scheme URL to open third-party application that does not do callbacks. • Mobile: On app RESUME, call Transaction Status API. Refer to: Transaction Status API • Web: Do a looping query or long post to get transaction status. Refer to: PGW SDK API Interface of Transaction status method. |
TransactionPaymentSlip | String | Get Alternative Payment Method (APM) payment slip information and set transaction status to PENDING. • Get payment slip info and display payment slip. |
TransactionExternalApplication | String | Redirect to external app with app scheme, and back with app call back. • Mobile: receive call back from third-party application. • Web: N/A. |
TransactionQRPayment | String | Display generated QR information for scan. • After the QR code is displayed, do a looping query or long post to get transaction status. Refer to: Transaction Status API |
TransactionCompleted | String | Transaction completed, perform payment inquiry to get payment status and full response. • Get payment result, and display result to customer. |
TransactionInProgress | String | Transaction in progress. • Recursively inquires for transaction status until API returns payment result Refer to: PGW SDK API Interface |
TransactionNotFound | String | Transaction not found. • Displays result to customer |
TransactionInquiryFailed | String | Transaction inquiry failed. • Displays result to customer |
Installment Interest Type Code
Enum InstallmentInterestTypeCode |
Parameter | Data Type | Description |
---|---|---|
Customer | String | Customer interest type. |
Merchant | String | Merchant interest type. |
Payment Channel Code
Enum PaymentChannelCode |
Parameter | Data Type | Description | |
---|---|---|---|
Category | - | - | Payment category. |
GlobalCardPayment | String | Global card payment category. | |
LocalCardPayment | String | Local card payment category. | |
LocalCardInstallmentPaymentPlan | String | Local card installment payment plan category. | |
DigitalPayment | String | Digital payment category. | |
QRPayment | String | QR payment category. | |
WebPayment | String | Web payment category. | |
SelfServiceMachine | String | Self service machine payment category. | |
PayAtCounter | String | Pay at counter payment category. | |
InternetBanking | String | Internet banking payment category. | |
GlobalBuyNowPayLater | String | Global Buy Now Pay Later (BNPL) category. | |
DeepLinkPayment | String | Deep link payment category. | |
OnlineDirectDebit | String | Online direct debit category. | |
DigitalCurrency | String | Digital currency category. | |
Group | - | - | Payment group. |
CreditCard | String | Credit card payment group. | |
ProprietaryCard | String | Proprietary card payment group. | |
GlobalInstallmentPaymentPlan | String | Global installment payment plan payment group. | |
LocalInstallmentPaymentPlan | String | Local installment payment plan payment group. | |
GlobalThirdPartyPayment | String | Global third party payment group. | |
LocalThirdPartyPayment | String | Local third party payment group. | |
EWalletPayment | String | E-Wallet payment group. | |
MasterPass | String | Masterpass payment group. | |
QRCodePayment | String | QR code payment group. | |
CardSchemeQRPayment | String | Card scheme QR payment group. | |
ThaiQRPayment | String | Thai QR payment group. | |
SingaporeQRPayment | String | Singapore QR payment group. | |
WebPayment | String | Web payment group. | |
AutomatedTellerMachine | String | Automated teller machine payment group. | |
Kiosk | String | KIOSK payment group. | |
BankCounter | String | Bank counter payment group. | |
OverTheCounter | String | Over the counter payment group. | |
InternetBanking | String | Internet banking payment group | |
BuyNowPayLater | String | Buy Now Pay Later (BNPL) payment group. | |
CardWalletPayment | String | Card wallet payment group. | |
DeepLinkPayment | String | Deep link payment group. | |
CardLoyaltyPointPayment | String | Card loyalty point payment group. | |
OnlineDirectDebit | String | Online direct debit group. | |
CryptoCurrency | String | Cryptocurrency group. | |
Channel | - | - | Payment channel. |
LinePay | String | Line pay channel. | |
MoMoWallet | String | Momo wallet channel. | |
ShopeePay | String | Shoppe pay channel. | |
OneTwoThree | String | 123 payment channel. | |
GooglePay | String | Google pay channel. | |
CardLoyaltyPointPayment | String | Card loyalty point payment channel. | |
ApplePay | String | Apple pay channel. | |
ZaloPay | String | ZaloPay channel. | |
TripleAWallet | String | Triple-A Wallet channel. | |
AgentChannel | - | - | Payment agent channel. |
WebPayment | String | Web payment agent channel. | |
AutomatedTellerMachine | String | Automated teller machine agent channel. | |
Kiosk | String | KIOSK agent channel. | |
BankCounter | String | Bank counter agent channel. | |
OverTheCounter | String | Over the counter agent channel. | |
InternetBanking | String | Internet banking agent channel. | |
DeepLinkPayment | String | Deep link agent channel. | |
OnlineDirectDebit | String | Online direct debit agent channel. |
Payment Input Code
Enum PaymentInputCode |
Parameter | Data Type | Description |
---|---|---|
Mandatory | String | Mandatory for payment input. |
Ignore | String | Ignore for payment input. |
Optional | String | Optional for payment input. |
Payment Notification Platform Code
Enum PaymentNotificationPlatformCode |
Parameter | Data Type | Description |
---|---|---|
String | Payment notification to Facebook platform. | |
String | Payment notification to WhatsApp platform. | |
String | Payment notification to WeChat platform. | |
Line | String | Payment notification to LINE platform. |
String | Payment notification to email platform. |
QR Type Code
Enum QRTypeCode |
Parameter | Data Type | Description |
---|---|---|
Raw | String | QR raw data. |
Base64 | String | QR base64 data. |
URL | String | QR URL data. |
Payment Custom Data Code
Enum PaymentCustomDataCode |
Parameter | Data Type | Description |
---|---|---|
Text | String | Custom text data. • Text for display. |
ImageUrl | String | Custom image URL data. • Image for display. |
WebUrl | String | Custom web URL data. • Hyperlink for redirection. |
FileUrl | String | Custom file URL data. • File for download. |
Payment UI Response Code
Enum PaymentUIResponseCode |
Parameter | Platform | Code | Description |
---|---|---|---|
TransactionCompleted TransactionCompletedDescription | iOS / Android | 0000 | The transaction completed, please use payment token for request transaction status inquiry API. |
TransactionCancelled TransactionCancelledDescription | iOS / Android | 0001 | The transaction cancelled by user manually. |
TransactionFailed TransactionFailedDescription | iOS / Android | 0002 | The transaction failed, error: {values}. |
TransactionRetryFailed TransactionRetryFailedDescription | iOS / Android | 0003 | The transaction retry failed, please re-submit the ui payment request again. |
ValidationFailed ValidationFailedDescription | iOS / Android | 0099 | Validation failed due to invalid value for {values}, these value are required for the payment. |
InitializationFailed InitializationFailedDescription | iOS | 0099 | The payment ui initialization failed. |
Updated 25 days ago