Developer ZoneRecipesAPI ReferenceChangelog
Developer Zone

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
ParameterData TypeDescription
CustomerStringCustomer interest type.
MerchantStringMerchant interest type.

Payment Channel Code


Enum PaymentChannelCode
ParameterData TypeDescription
Category--Payment category.
GlobalCardPaymentStringGlobal card payment category.
LocalCardPaymentStringLocal card payment category.
LocalCardInstallmentPaymentPlanStringLocal card installment payment plan category.
DigitalPaymentStringDigital payment category.
QRPaymentStringQR payment category.
WebPaymentStringWeb payment category.
SelfServiceMachineStringSelf service machine payment category.
PayAtCounterStringPay at counter payment category.
InternetBankingStringInternet banking payment category.
GlobalBuyNowPayLaterStringGlobal Buy Now Pay Later (BNPL) category.
DeepLinkPaymentStringDeep link payment category.
OnlineDirectDebitStringOnline direct debit category.
DigitalCurrencyStringDigital currency category.
Group--Payment group.
CreditCardStringCredit card payment group.
ProprietaryCardStringProprietary card payment group.
GlobalInstallmentPaymentPlanStringGlobal installment payment plan payment group.
LocalInstallmentPaymentPlanStringLocal installment payment plan payment group.
GlobalThirdPartyPaymentStringGlobal third party payment group.
LocalThirdPartyPaymentStringLocal third party payment group.
EWalletPaymentStringE-Wallet payment group.
MasterPassStringMasterpass payment group.
QRCodePaymentStringQR code payment group.
CardSchemeQRPaymentStringCard scheme QR payment group.
ThaiQRPaymentStringThai QR payment group.
SingaporeQRPaymentStringSingapore QR payment group.
WebPaymentStringWeb payment group.
AutomatedTellerMachineStringAutomated teller machine payment group.
KioskStringKIOSK payment group.
BankCounterStringBank counter payment group.
OverTheCounterStringOver the counter payment group.
InternetBankingStringInternet banking payment group
BuyNowPayLaterStringBuy Now Pay Later (BNPL) payment group.
CardWalletPaymentStringCard wallet payment group.
DeepLinkPaymentStringDeep link payment group.
CardLoyaltyPointPaymentStringCard loyalty point payment group.
OnlineDirectDebitStringOnline direct debit group.
CryptoCurrencyStringCryptocurrency group.
Channel--Payment channel.
LinePayStringLine pay channel.
MoMoWalletStringMomo wallet channel.
ShopeePayStringShoppe pay channel.
OneTwoThreeString123 payment channel.
GooglePayStringGoogle pay channel.
CardLoyaltyPointPaymentStringCard loyalty point payment channel.
ApplePayStringApple pay channel.
ZaloPayStringZaloPay channel.
TripleAWalletStringTriple-A Wallet channel.
AgentChannel--Payment agent channel.
WebPaymentStringWeb payment agent channel.
AutomatedTellerMachineStringAutomated teller machine agent channel.
KioskStringKIOSK agent channel.
BankCounterStringBank counter agent channel.
OverTheCounterStringOver the counter agent channel.
InternetBankingStringInternet banking agent channel.
DeepLinkPaymentStringDeep link agent channel.
OnlineDirectDebitStringOnline direct debit agent channel.

Payment Input Code


Enum PaymentInputCode
ParameterData TypeDescription
MandatoryStringMandatory for payment input.
IgnoreStringIgnore for payment input.
OptionalStringOptional for payment input.

Payment Notification Platform Code


Enum PaymentNotificationPlatformCode
ParameterData TypeDescription
FacebookStringPayment notification to Facebook platform.
WhatsAppStringPayment notification to WhatsApp platform.
WeChatStringPayment notification to WeChat platform.
LineStringPayment notification to LINE platform.
EmailStringPayment notification to email platform.

QR Type Code


Enum QRTypeCode
ParameterData TypeDescription
RawStringQR raw data.
Base64StringQR base64 data.
URLStringQR 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.