> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rails.wayex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman collection

> Run the tenant-bound Wayex API surface with chained direct-route and Treasury examples.

The Wayex Postman collection follows the public API reference. It includes direct customer payment
routes and the isolated, prefunded Treasury workflow.

<CardGroup cols={2}>
  <Card title="Download the collection" icon="download" href="/postman/wayex-api.postman_collection.json">
    Client API requests, tests, and chained resource variables.
  </Card>

  <Card title="Download the environment" icon="gear" href="/postman/wayex-sandbox.postman_environment.json">
    Base URL and local credential placeholders.
  </Card>
</CardGroup>

## Set it up

<Steps>
  <Step title="Import both files">
    Import the collection and environment, then select **Wayex — Sandbox (client)**.
  </Step>

  <Step title="Add one tenant account key">
    Paste the intended account's secret key (`sk_…`) into the local `apiKey` environment value. The
    collection sends it as `Authorization: Bearer {{ apiKey }}`.
  </Step>

  <Step title="Run Start here">
    Confirm authentication and base URL before running a workflow folder.
  </Step>

  <Step title="Run one workflow in order">
    Customer and route requests chain their IDs. Treasury requests capture beneficiaries, quotes,
    and operations for the same tenant account.
  </Step>
</Steps>

<Warning>
  Keep a separate Postman environment for every tenant account. Do not paste two keys into one run
  or reuse captured resource IDs across accounts. A key, wallet, configuration, webhook set, and
  resource ID all belong to one tenant account.
</Warning>

## Folders

| Folder                          | What it covers                                                                                          |
| ------------------------------- | ------------------------------------------------------------------------------------------------------- |
| **Start here**                  | Authentication and a read-only connectivity check.                                                      |
| **Rates**                       | Indicative AUD/stablecoin rates.                                                                        |
| **Customers and verification**  | Customer onboarding, hosted verification, and entitlements.                                             |
| **Payment routes**              | Direct on-ramp/off-ramp route creation and reusable funding instructions.                               |
| **Transfers and activity**      | Direct-route conversion lifecycle and search.                                                           |
| **Fees, invoices, and revenue** | Developer pricing and billing reports.                                                                  |
| **Webhooks**                    | Subscription creation and delivery inspection.                                                          |
| **API keys**                    | Key lifecycle and restrictions.                                                                         |
| **Errors and idempotency**      | Error envelope, conflict handling, and safe replay.                                                     |
| **Treasury**                    | Funding, optional evidence, review-and-confirm money actions, cursor reporting, and bounded CSV export. |

## Run Treasury safely

Before running a Treasury write:

* confirm the key has `treasury:write` and belongs to the intended tenant account;
* read the effective settings and current balances;
* provision and fund the account, then wait for the net credit to become `available`;
* keep every generated `Idempotency-Key` stable if you manually retry the same request;
* treat `accepted` as durable reservation, not external settlement;
* poll the resource or consume its webhook until the final outcome.

Payout and withdrawal folders call a non-money-moving preview before create. The two requests use
different idempotency keys because keys are tenant-global. Conversion quotes serve as the conversion
preview and must be accepted before expiry.

Operation and transaction searches return opaque cursors. Pass `nextCursor` unchanged with the same
filters. The CSV request returns `text/csv`, is bounded to 5,000 rows, neutralises spreadsheet-formula
text, and excludes beneficiary, bank-account, and saved destination-address PII.

The optional Sumsub share token is submitted with beneficiary creation. It is input-only,
single-use, and must remain a local secret. Do not save it in a shared Postman workspace.

<Note>
  The collection is a runnable companion to the [Treasury guide](/treasury/overview). Each generated
  endpoint page explains its purpose, prerequisites, balance effect, statuses, and retry behavior.
</Note>

## Existing resources

To run against a resource you already created, set its ID as a local environment value. Only use IDs
created under the same account as `apiKey`; cross-tenant resources return not found or forbidden.

## Environment safety

Do not assume the sandbox URL means every instruction is simulated. Wayex may enable controlled
live-provider testing for a tenant. Confirm the environment and agreed limits before running a
funding or money-moving folder.