> ## 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.

# Data reference

> A complete reference for Waffo status codes, enums, payment method types, and general conventions.

## Order statuses

| Status                   | Description                                     | Terminal |
| ------------------------ | ----------------------------------------------- | -------- |
| `PAY_IN_PROGRESS`        | Order accepted; the user is making a payment    | No       |
| `AUTHORIZATION_REQUIRED` | This payment method requires user authorization | No       |
| `AUTHED_WAITING_CAPTURE` | Authorized, pending capture (card payments)     | No       |
| `PAY_SUCCESS`            | Payment successful                              | Yes      |
| `ORDER_CLOSE`            | Order closed (cancelled/failed/timeout)         | Yes      |

## Subscription statuses

| Status                   | Description                                         | Terminal |
| ------------------------ | --------------------------------------------------- | -------- |
| `AUTHORIZATION_REQUIRED` | User authorization required                         | No       |
| `IN_PROGRESS`            | The user is confirming the subscription             | No       |
| `ACTIVE`                 | Subscription active; charges are processed normally | No       |
| `CLOSE`                  | Closed (timeout or failure)                         | Yes      |
| `MERCHANT_CANCELLED`     | Cancelled by the merchant                           | Yes      |
| `USER_CANCELLED`         | Cancelled by the user                               | Yes      |
| `CHANNEL_CANCELLED`      | Cancelled by the channel                            | Yes      |
| `EXPIRED`                | Expired                                             | Yes      |

## Subscription change statuses

| Status                   | Description                 | Terminal |
| ------------------------ | --------------------------- | -------- |
| `IN_PROGRESS`            | Change in progress          | No       |
| `AUTHORIZATION_REQUIRED` | User authorization required | No       |
| `SUCCESS`                | Change successful           | Yes      |
| `CLOSED`                 | Change failed/closed        | Yes      |

## Refund statuses

| Status                     | Description              | Terminal |
| -------------------------- | ------------------------ | -------- |
| `REFUND_IN_PROGRESS`       | Refund in progress       | No       |
| `ORDER_PARTIALLY_REFUNDED` | Partial refund completed | Yes      |
| `ORDER_FULLY_REFUNDED`     | Full refund completed    | Yes      |
| `ORDER_REFUND_FAILED`      | Refund failed            | Yes      |

## Payment method types

| payMethodType     | Description                                 |
| ----------------- | ------------------------------------------- |
| `CREDITCARD`      | Credit card                                 |
| `DEBITCARD`       | Debit card                                  |
| `EWALLET`         | E-wallet                                    |
| `ONLINE_BANKING`  | Online banking                              |
| `DIGITAL_BANKING` | Digital banking                             |
| `OTC`             | Offline payments (convenience stores, etc.) |
| `BNPL`            | Buy now, pay later                          |
| `VA`              | Virtual account                             |
| `APPLEPAY`        | Apple Pay                                   |
| `GOOGLEPAY`       | Google Pay                                  |

## Common payment method names

| payMethodName   | Type            | Description            |
| --------------- | --------------- | ---------------------- |
| `CC_VISA`       | CREDITCARD      | Visa credit card       |
| `CC_MASTERCARD` | CREDITCARD      | Mastercard credit card |
| `DC_VISA`       | DEBITCARD       | Visa debit card        |
| `DC_MASTERCARD` | DEBITCARD       | Mastercard debit card  |
| `DANA`          | EWALLET         | DANA e-wallet          |
| `GCASH`         | EWALLET         | GCash e-wallet         |
| `LINKAJA`       | EWALLET         | LinkAja e-wallet       |
| `MERCADOPAGO`   | EWALLET         | Mercadopago            |
| `APPLEPAY`      | APPLEPAY        | Apple Pay              |
| `GOOGLEPAY`     | GOOGLEPAY       | Google Pay             |
| `SPEI`          | ONLINE\_BANKING | SPEI (Mexico)          |
| `JENIUSPAY`     | ONLINE\_BANKING | JeniusPay (Indonesia)  |
| `AKULAKU`       | BNPL            | Akulaku                |
| `KREDIVO`       | BNPL            | Kredivo                |
| `INDODANA`      | BNPL            | Indodana               |
| `OXXO`          | OTC             | OXXO (Mexico)          |
| `OXXOPAY`       | OTC             | OXXO Pay (Mexico)      |

## User terminal types

| userTerminal      | Description   |
| ----------------- | ------------- |
| `WEB`             | Web           |
| `APP`             | Mobile app    |
| `IN_WALLET_APP`   | In-wallet app |
| `IN_MINI_PROGRAM` | Mini program  |

## Webhook event types

| eventType                                  | Description                              |
| ------------------------------------------ | ---------------------------------------- |
| `PAYMENT_NOTIFICATION`                     | Payment result notification              |
| `REFUND_NOTIFICATION`                      | Refund result notification               |
| `SUBSCRIPTION_STATUS_NOTIFICATION`         | Subscription status change               |
| `SUBSCRIPTION_PERIOD_CHANGED_NOTIFICATION` | Subscription period change               |
| `SUBSCRIPTION_CHANGE_NOTIFICATION`         | Subscription upgrade/downgrade completed |

## Refund sources

| refundSource | Description                      |
| ------------ | -------------------------------- |
| `MERCHANT`   | Refund initiated by the merchant |
| `RDR`        | Rapid Dispute Resolution (RDR)   |
| `ETHOCA`     | Ethoca dispute resolution        |

## General conventions

| Item                   | Standard                                                                                                           |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------ |
| Time format            | [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), millisecond precision (for example `2023-04-01T03:00:00.000Z`) |
| Currency               | [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) (for example `IDR`, `PHP`, `HKD`, `USD`)                        |
| Country code           | [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) (for example `IDN`, `PHL`, `HKG`)           |
| Amount                 | String type, accurate to 2 decimal places (for example `"2.27"`)                                                   |
| Language               | IETF BCP 47 (for example `en-HK`, `zh-Hant-HK`)                                                                    |
| Success response code  | `"0"` (not `"SUCCESS"`)                                                                                            |
| Response message field | `msg` (not `message`)                                                                                              |