These docs are for v4.0.2. Click to read the latest docs for v4.3.0.

Payment Enums

API Environment


Enum AmountValidation

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
  • 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 (123) payment slip information and set transaction status to PENDING

  • Get payment slip info
  • 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

TransactionCompleted

String

Transaction completed

  • Perform payment inquiry to get payment status and full response
  • Gets payment result and displays 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

Parameter

Data Type

Description

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

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

 

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