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

# Postman collection

> Use the Postman collection to quickly test the Waffo API.

The Postman collection provides preconfigured requests for all Waffo APIs, making it easy to run tests quickly.

## How to obtain

Download the Postman Collection JSON file for the Sandbox environment:

<a href="/files/developer-docs/postman/Waffo-acquiring-api-demo-sandbox-onetimepayment.postman_collection.json" download="Waffo-acquiring-api-demo-sandbox-onetimepayment.postman_collection.json">Download Postman Collection</a>

If your browser still opens a preview, right-click the link, choose **Save link as**, and keep the `.postman_collection.json` file name.

## How to import

<Steps>
  <Step title="Open Postman">
    In Postman, select **Import → Upload Files**.
  </Step>

  <Step title="Upload the file">
    Select the downloaded Collection JSON file.
  </Step>

  <Step title="Configure environment variables">
    Configure the following environment variables.
  </Step>
</Steps>

## Environment variables

| Variable      | Description                                          | Example value                     |
| ------------- | ---------------------------------------------------- | --------------------------------- |
| `base_url`    | API base URL                                         | `https://api-sandbox.waffo.com`   |
| `api_key`     | API Key                                              | Obtain from the Dashboard         |
| `merchant_id` | Merchant ID                                          | `M000001`                         |
| `signature`   | SHA256WithRSA signature of the request body (Base64) | Generate before sending a request |

## Included endpoints

| Endpoint                             | Path                                       |
| ------------------------------------ | ------------------------------------------ |
| Create payment                       | `POST /api/v1/order/create`                |
| Query payment                        | `POST /api/v1/order/inquiry`               |
| Cancel order                         | `POST /api/v1/order/cancel`                |
| Request refund                       | `POST /api/v1/order/refund`                |
| Query refund                         | `POST /api/v1/refund/inquiry`              |
| Create subscription                  | `POST /api/v1/subscription/create`         |
| Query subscription                   | `POST /api/v1/subscription/inquiry`        |
| Cancel subscription                  | `POST /api/v1/subscription/cancel`         |
| Update subscription                  | `POST /api/v1/subscription/change`         |
| Query update                         | `POST /api/v1/subscription/change/inquiry` |
| Subscription management              | `POST /api/v1/subscription/manage`         |
| Merchant configuration inquiry       | `POST /api/v1/merchantconfig/inquiry`      |
| Payment method configuration inquiry | `POST /api/v1/paymethodconfig/inquiry`     |

## Signature configuration

The collection includes the `X-SIGNATURE: {{signature}}` header. Before sending a request, sign the raw JSON body with your merchant private key using SHA256WithRSA, then set the Base64 result as the `signature` variable.

Regenerate the signature whenever you change the request body. Do not store production private keys in the Postman collection file.
