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

# Tools

> What an assistant connected over MCP can do.

Thirty-five tools, grouped below. All of them are read-only except `requery_payment`, which
is marked clearly. Everything is scoped to the project and environment carried by the token
— an assistant can never reach another project's data.

List tools are cursor-paginated: they accept `per_page` (default 20, maximum 100) and
`cursor`.

## Payments

| Tool                    | Parameters                                                                                   | What it does                                                                                  |
| ----------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `list_payment_intents`  | `status`, `channel`, `customer_id`, `created_at_gte`, `created_at_lte`, `per_page`, `cursor` | Browse payments, with filters.                                                                |
| `get_payment_intent`    | `payment_intent_id`                                                                          | One payment, with its active attempt and customer.                                            |
| `list_payment_attempts` | `payment_intent_id`, `per_page`, `cursor`                                                    | Every attempt made on a payment.                                                              |
| `get_payment_attempt`   | `payment_intent_id`, `attempt_id`                                                            | One attempt, with its failure reason.                                                         |
| `list_payment_refunds`  | `payment_intent_id`, `per_page`, `cursor`                                                    | Refunds on a payment.                                                                         |
| `get_payment_refund`    | `payment_intent_id`, `refund_id`                                                             | One refund.                                                                                   |
| `get_checkout_session`  | `checkout_id`                                                                                | A hosted checkout session and the payment behind it.                                          |
| `inspect_payment`       | `payment_intent_id`, `attempt_id`                                                            | The raw record the provider holds. Use it when Orchestrate and the provider seem to disagree. |

`inspect_payment` defaults to the active attempt. Its payload is provider-specific and
unstable — read it, do not build logic on it.

## Payouts

| Tool           | Parameters                                                                                              | What it does                                  |
| -------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| `list_payouts` | `status`, `method`, `currency`, `customer_id`, `created_at_gte`, `created_at_lte`, `per_page`, `cursor` | Browse payouts, with filters.                 |
| `get_payout`   | `payout_id`                                                                                             | One payout, with its instrument and customer. |

## Customers

| Tool                     | Parameters                          | What it does              |
| ------------------------ | ----------------------------------- | ------------------------- |
| `get_customer`           | `customer_id`                       | One customer.             |
| `list_customer_payments` | `customer_id`, `per_page`, `cursor` | That customer's payments. |
| `list_customer_payouts`  | `customer_id`, `per_page`, `cursor` | That customer's payouts.  |

## Your connected gateways

| Tool                            | Parameters           | What it does                                                                  |
| ------------------------------- | -------------------- | ----------------------------------------------------------------------------- |
| `list_payment_gateway_accounts` | `per_page`, `cursor` | The payment gateways your project has connected, with their status and usage. |
| `get_payment_gateway_account`   | `account_id`         | One connected payment gateway account.                                        |
| `list_payout_gateway_accounts`  | `per_page`, `cursor` | The payout gateways your project has connected.                               |
| `get_payout_gateway_account`    | `account_id`         | One connected payout gateway account.                                         |

Credentials are never returned.

## What your project can accept

These answer "where and how can I take money", scoped to your configuration and environment.

| Tool                     | Parameters           |
| ------------------------ | -------------------- |
| `list_payment_methods`   | `search`, `category` |
| `get_payment_method`     | `method_code`        |
| `list_payment_countries` | —                    |
| `get_payment_country`    | `country_code`       |
| `list_payment_gateways`  | —                    |
| `get_payment_gateway`    | `gateway_code`       |

## What your project can pay out

| Tool                   | Parameters           |
| ---------------------- | -------------------- |
| `list_payout_methods`  | `search`, `category` |
| `get_payout_method`    | `method_code`        |
| `get_payout_country`   | `country_code`       |
| `list_payout_gateways` | —                    |
| `get_payout_gateway`   | `gateway_code`       |

## Reference data

| Tool                            | Parameters      | What it does                                    |
| ------------------------------- | --------------- | ----------------------------------------------- |
| `get_exchange_rates`            | `base_currency` | Indicative rates, defaulting to USD.            |
| `list_exchange_rate_currencies` | —               | Currencies with published rates.                |
| `list_currencies`               | —               | Currency names, symbols and codes.              |
| `list_countries`                | `search`        | Country names, ISO codes, flags and dial codes. |

## Documentation

| Tool             | Parameters | What it does                 |
| ---------------- | ---------- | ---------------------------- |
| `list_doc_pages` | `section`  | The catalogue of these docs. |
| `get_doc_page`   | `slug`     | The full text of a page.     |

These let an assistant answer integration questions from the documentation instead of
guessing.

## Actions

<Warning>
  `requery_payment` is the only tool that changes anything.
</Warning>

| Tool              | Parameters          | What it does                                                                                                                                                                 |
| ----------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `requery_payment` | `payment_intent_id` | Re-checks a **failed** payment against its provider and reconciles the result. The active attempt goes back to processing while the provider is asked for the current truth. |

It only accepts a failed intent, and it is the same operation as
[`POST /payment/intents/{id}/requery`](/payments/requery). Use it to recover a payment that
failed on the Orchestrate side while the provider actually took the money — not as a routine
retry.
