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.

API integration is suitable when you need full control over the payment flow. You call the Waffo REST API directly and connect payment, subscription, refund, and Webhook handling to your own system.

​
Applicable scenarios

  • Server-to-server payment processing
  • You already have your own hosted checkout page or payment form
  • Custom integration requiring maximum flexibility

​
Integration roadmap

1

Choose the product

Choose one-time payment for single-charge orders, or subscription payment for recurring billing.
2

Integrate required APIs

One-time payment requires order create, order inquiry, and payment notification. Subscription requires subscription create, subscription inquiry, subscription status notification, and subscription payment notification.
3

Add conditional APIs as needed

Add cancel, refund, refund inquiry, refund notification, subscription manage, or subscription change only when your business flow needs them.
4

Use API Reference for field details

Request fields, response fields, enums, and signing rules are maintained in API Reference. Do not copy field definitions from offline PDFs.
5

Test in sandbox

Use Sandbox and testing, including Apple Pay and Google Pay checks if needed.
6

Submit acceptance materials

Download the one-time payment acceptance template or subscription acceptance template, fill in the executed cases, and submit the result to the Waffo technical support group.

​
Base URL

EnvironmentURL
Sandboxhttps://api-sandbox.waffo.com
Productionhttps://api.waffo.com

​
Request format

  • Content-Type: application/json (UTF-8 encoding)
  • All requests use HTTP POST
  • Request headers must include X-API-KEY and X-SIGNATURE

​
Response format

{
  "code": "0",
  "msg": "Success",
  "data": { ... }
}
  • code is "0" indicates success
  • On failure, code is an error code (for example "A0003"), and data is empty
  • Response header X-SIGNATURE contains the Waffo signature and must be verified

​
Core APIs

​
One-time payment

APIRequiredDescription
POST /api/v1/order/createRequiredCreate a one-time payment order
POST /api/v1/order/inquiryRequiredQuery order status, including redirect loss, timeout, and Unknown Status recovery
Payment order notificationRequiredReceive terminal payment results and update the merchant order state
POST /api/v1/order/cancelConditionalCancel unpaid orders when your business supports cancellation
POST /api/v1/order/refundConditionalInitiate refunds when your business supports refunds
POST /api/v1/refund/inquiry or refund notificationConditionalQuery or receive refund processing results
POST /api/v1/order/captureConditionalRequired only for Auth-Capture manual capture mode

​
Subscription payment

APIRequiredDescription
POST /api/v1/subscription/createRequiredCreate a subscription
POST /api/v1/subscription/inquiryRequiredQuery subscription status and main payment information
Subscription status notificationRequiredReceive subscription activation, cancellation, and status changes
Subscription payment order notificationRequiredReceive first-payment and renewal payment results
POST /api/v1/subscription/cancelConditionalCancel subscriptions from the merchant side
POST /api/v1/subscription/manageConditionalGenerate a management URL for user-side subscription management
POST /api/v1/subscription/changeConditionalSupport plan upgrades or downgrades
POST /api/v1/order/inquiryConditionalQuery detailed failure reasons for subscription payment orders

​
Configuration lookup

APIRequiredDescription
POST /api/v1/merchantconfig/inquiryRecommendedQuery merchant limits and configuration
POST /api/v1/paymethodconfig/inquiryRecommendedQuery available payment methods and payment limits

​
Acceptance templates

After API integration and sandbox testing, download and fill in the matching template: Submit the completed acceptance result to the Waffo technical support group. See Integration acceptance criteria before going live.