Skip to main content

Documentation Index

Fetch the complete documentation index at: https://waffo.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Order statuses

StatusDescriptionTerminal
PAY_IN_PROGRESSOrder accepted; the user is making a paymentNo
AUTHORIZATION_REQUIREDThis payment method requires user authorizationNo
AUTHED_WAITING_CAPTUREAuthorized, pending capture (card payments)No
PAY_SUCCESSPayment successfulYes
ORDER_CLOSEOrder closed (cancelled/failed/timeout)Yes

Subscription statuses

StatusDescriptionTerminal
AUTHORIZATION_REQUIREDUser authorization requiredNo
IN_PROGRESSThe user is confirming the subscriptionNo
ACTIVESubscription active; charges are processed normallyNo
CLOSEClosed (timeout or failure)Yes
MERCHANT_CANCELLEDCancelled by the merchantYes
USER_CANCELLEDCancelled by the userYes
CHANNEL_CANCELLEDCancelled by the channelYes
EXPIREDExpiredYes

Subscription change statuses

StatusDescriptionTerminal
IN_PROGRESSChange in progressNo
AUTHORIZATION_REQUIREDUser authorization requiredNo
SUCCESSChange successfulYes
CLOSEDChange failed/closedYes

Refund statuses

StatusDescriptionTerminal
REFUND_IN_PROGRESSRefund in progressNo
ORDER_PARTIALLY_REFUNDEDPartial refund completedYes
ORDER_FULLY_REFUNDEDFull refund completedYes
ORDER_REFUND_FAILEDRefund failedYes

Payment method types

payMethodTypeDescription
CREDITCARDCredit card
DEBITCARDDebit card
EWALLETE-wallet
ONLINE_BANKINGOnline banking
DIGITAL_BANKINGDigital banking
OTCOffline payments (convenience stores, etc.)
BNPLBuy now, pay later
VAVirtual account
APPLEPAYApple Pay
GOOGLEPAYGoogle Pay

Common payment method names

payMethodNameTypeDescription
CC_VISACREDITCARDVisa credit card
CC_MASTERCARDCREDITCARDMastercard credit card
DC_VISADEBITCARDVisa debit card
DC_MASTERCARDDEBITCARDMastercard debit card
DANAEWALLETDANA e-wallet
GCASHEWALLETGCash e-wallet
LINKAJAEWALLETLinkAja e-wallet
MERCADOPAGOEWALLETMercadopago
APPLEPAYAPPLEPAYApple Pay
GOOGLEPAYGOOGLEPAYGoogle Pay
SPEIONLINE_BANKINGSPEI (Mexico)
JENIUSPAYONLINE_BANKINGJeniusPay (Indonesia)
AKULAKUBNPLAkulaku
KREDIVOBNPLKredivo
INDODANABNPLIndodana
OXXOOTCOXXO (Mexico)
OXXOPAYOTCOXXO Pay (Mexico)

User terminal types

userTerminalDescription
WEBWeb
APPMobile app
IN_WALLET_APPIn-wallet app
IN_MINI_PROGRAMMini program

Webhook event types

eventTypeDescription
PAYMENT_NOTIFICATIONPayment result notification
REFUND_NOTIFICATIONRefund result notification
SUBSCRIPTION_STATUS_NOTIFICATIONSubscription status change
SUBSCRIPTION_PERIOD_CHANGED_NOTIFICATIONSubscription period change
SUBSCRIPTION_CHANGE_NOTIFICATIONSubscription upgrade/downgrade completed

Refund sources

refundSourceDescription
MERCHANTRefund initiated by the merchant
RDRRapid Dispute Resolution (RDR)
ETHOCAEthoca dispute resolution

General conventions

ItemStandard
Time formatISO 8601, millisecond precision (for example 2023-04-01T03:00:00.000Z)
CurrencyISO 4217 (for example IDR, PHP, HKD, USD)
Country codeISO 3166-1 alpha-3 (for example IDN, PHL, HKG)
AmountString type, accurate to 2 decimal places (for example "2.27")
LanguageIETF BCP 47 (for example en-HK, zh-Hant-HK)
Success response code"0" (not "SUCCESS")
Response message fieldmsg (not message)