> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.yoco.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.yoco.com/_mcp/server.

# Tool reference

Once you've [connected your assistant](/mcp/connecting), it can use the tools below. Tools are
grouped by what they work with, and each group lists the permission it needs. Your assistant only
sees the tools you've [granted access to](/mcp/authentication).

Tools marked **`Write`** change your business, such as creating or deleting a payment link. Your
assistant asks you to confirm before running them.

The **API reference** column links to the matching Yoco API operation, where you'll find full
request and response details.

## Payments

Permission required: `business/orders:read`

| Tool            | Description               | API reference                                                                |
| --------------- | ------------------------- | ---------------------------------------------------------------------------- |
| `list_payments` | List and filter payments  | [GET /v1/payments/](https://developer.yoco.com/api-reference/yoco-api/payments/list-payments-v-1-payments-get)                           |
| `get_payment`   | Retrieve a single payment | [GET /v1/payments/\{payment_id}](https://developer.yoco.com/api-reference/yoco-api/payments/fetch-payment-v-1-payments-payment-id-get) |

## Orders

Read tools require `business/orders:read`. **Write** tools also require `business/orders:write`.

| Tool                       | Description             | API reference                                                        |
| -------------------------- | ----------------------- | -------------------------------------------------------------------- |
| `list_orders`              | List and filter orders  | [GET /v1/orders/](https://developer.yoco.com/api-reference/yoco-api/orders/list-orders-v-1-orders-get)                       |
| `get_order`                | Retrieve a single order | [GET /v1/orders/\{order_id}](https://developer.yoco.com/api-reference/yoco-api/orders/fetch-order-v-1-orders-order-id-get) |
| `create_order` **`Write`** | Create an order         | [POST /v1/orders/](https://developer.yoco.com/api-reference/yoco-api/orders/create-order-v-1-orders-post)                     |

## Refunds

Permission required: `business/orders:read`

| Tool           | Description              | API reference                                                            |
| -------------- | ------------------------ | ------------------------------------------------------------------------ |
| `list_refunds` | List and filter refunds  | [GET /v1/refunds/](https://developer.yoco.com/api-reference/yoco-api/refunds/list-refunds-v-1-refunds-get)                         |
| `get_refund`   | Retrieve a single refund | [GET /v1/refunds/\{refund_id}](https://developer.yoco.com/api-reference/yoco-api/refunds/fetch-refund-v-1-refunds-refund-id-get) |

## Payment Links

Read tools require `business/orders:read`. **Write** tools also require `business/orders:write`.

| Tool                              | Description                     | API reference                                                                                          |
| --------------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `list_payment_links`              | List and filter payment links   | [GET /v1/payment_links/](https://developer.yoco.com/api-reference/yoco-api/payment-links/list-payment-links-v-1-payment-links-get)                                           |
| `get_payment_link`                | Retrieve a single payment link  | [GET /v1/payment_links/\{payment_link_id}](https://developer.yoco.com/api-reference/yoco-api/payment-links/fetch-payment-link-v-1-payment-links-payment-link-id-get)       |
| `create_payment_link` **`Write`** | Create a shareable payment link | [POST /v1/payment_links/](https://developer.yoco.com/api-reference/yoco-api/payment-links/create-payment-link-v-1-payment-links-post)                                         |
| `delete_payment_link` **`Write`** | Delete a payment link           | [DELETE /v1/payment_links/\{payment_link_id}](https://developer.yoco.com/api-reference/yoco-api/payment-links/delete-payment-link-v-1-payment-links-payment-link-id-delete) |

## Payouts

Permission required: `business/payouts:read`

| Tool                  | Description                            | API reference                                                                                          |
| --------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `list_payouts`        | List and filter payouts                | [GET /v1/payouts/](https://developer.yoco.com/api-reference/yoco-api/payouts/list-payouts-v-1-payouts-get)                                                       |
| `get_payout`          | Retrieve a single payout               | [GET /v1/payouts/\{payout_id}](https://developer.yoco.com/api-reference/yoco-api/payouts/fetch-payout-v-1-payouts-payout-id-get)                               |
| `list_payout_entries` | List the entries that make up a payout | [GET /v1/payouts/\{payout_id}/payout_entries](https://developer.yoco.com/api-reference/yoco-api/payouts/list-payout-entries-v-1-payouts-payout-id-payout-entries-get) |

## Catalogue

Read tools require `business/catalogue:read`. **Write** tools also require `business/catalogue:write`.

| Tool                                | Description                                                                      | API reference                                                                                                  |
| ----------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `list_items`                        | List and filter catalogue items, including availability and prices at a location | [GET /v1/items/](https://developer.yoco.com/api-reference/yoco-api/items/list-items-v-1-items-get)                                                                   |
| `get_item`                          | Retrieve a single item                                                           | [GET /v1/items/\{item_id}](https://developer.yoco.com/api-reference/yoco-api/items/fetch-item-v-1-items-item-id-get)                                               |
| `create_item` **`Write`**           | Create an item                                                                   | [POST /v1/items/](https://developer.yoco.com/api-reference/yoco-api/items/create-item-v-1-items-post)                                                                 |
| `update_item` **`Write`**           | Replace an item                                                                  | [PUT /v1/items/\{item_id}](https://developer.yoco.com/api-reference/yoco-api/items/update-item-v-1-items-item-id-put)                                               |
| `delete_item` **`Write`**           | Delete an item                                                                   | [DELETE /v1/items/\{item_id}](https://developer.yoco.com/api-reference/yoco-api/items/delete-item-v-1-items-item-id-delete)                                         |
| `list_item_categories`              | List catalogue categories                                                        | [GET /v1/item_categories/](https://developer.yoco.com/api-reference/yoco-api/item-categories/list-item-categories-v-1-item-categories-get)                                               |
| `get_item_category`                 | Retrieve a single category                                                       | [GET /v1/item_categories/\{item_category_id}](https://developer.yoco.com/api-reference/yoco-api/item-categories/fetch-item-category-v-1-item-categories-item-category-id-get)         |
| `create_item_category` **`Write`**  | Create a category                                                                | [POST /v1/item_categories/](https://developer.yoco.com/api-reference/yoco-api/item-categories/create-item-category-v-1-item-categories-post)                                             |
| `update_item_category` **`Write`**  | Replace a category                                                               | [PUT /v1/item_categories/\{item_category_id}](https://developer.yoco.com/api-reference/yoco-api/item-categories/update-item-category-v-1-item-categories-item-category-id-put)         |
| `delete_item_category` **`Write`**  | Delete a category                                                                | [DELETE /v1/item_categories/\{item_category_id}](https://developer.yoco.com/api-reference/yoco-api/item-categories/delete-item-category-v-1-item-categories-item-category-id-delete)   |
| `list_item_brands`                  | List catalogue brands                                                            | [GET /v1/item_brands/](https://developer.yoco.com/api-reference/yoco-api/item-brands/list-item-brands-v-1-item-brands-get)                                                       |
| `get_item_brand`                    | Retrieve a single brand                                                          | [GET /v1/item_brands/\{item_brand_id}](https://developer.yoco.com/api-reference/yoco-api/item-brands/fetch-item-brand-v-1-item-brands-item-brand-id-get)                       |
| `create_item_brand` **`Write`**     | Create a brand                                                                   | [POST /v1/item_brands/](https://developer.yoco.com/api-reference/yoco-api/item-brands/create-item-brand-v-1-item-brands-post)                                                     |
| `update_item_brand` **`Write`**     | Replace a brand                                                                  | [PUT /v1/item_brands/\{item_brand_id}](https://developer.yoco.com/api-reference/yoco-api/item-brands/update-item-brand-v-1-item-brands-item-brand-id-put)                       |
| `delete_item_brand` **`Write`**     | Delete a brand                                                                   | [DELETE /v1/item_brands/\{item_brand_id}](https://developer.yoco.com/api-reference/yoco-api/item-brands/delete-item-brand-v-1-item-brands-item-brand-id-delete)                 |
| `list_modifier_groups`              | List modifier groups                                                             | [GET /v1/modifier_groups/](https://developer.yoco.com/api-reference/yoco-api/modifier-groups/list-modifier-groups-v-1-modifier-groups-get)                                               |
| `get_modifier_group`                | Retrieve a single modifier group                                                 | [GET /v1/modifier_groups/\{modifier_group_id}](https://developer.yoco.com/api-reference/yoco-api/modifier-groups/fetch-modifier-group-v-1-modifier-groups-modifier-group-id-get)       |
| `create_modifier_group` **`Write`** | Create a modifier group                                                          | [POST /v1/modifier_groups/](https://developer.yoco.com/api-reference/yoco-api/modifier-groups/create-modifier-group-v-1-modifier-groups-post)                                             |
| `update_modifier_group` **`Write`** | Replace a modifier group                                                         | [PUT /v1/modifier_groups/\{modifier_group_id}](https://developer.yoco.com/api-reference/yoco-api/modifier-groups/update-modifier-group-v-1-modifier-groups-modifier-group-id-put)       |
| `delete_modifier_group` **`Write`** | Delete a modifier group                                                          | [DELETE /v1/modifier_groups/\{modifier_group_id}](https://developer.yoco.com/api-reference/yoco-api/modifier-groups/delete-modifier-group-v-1-modifier-groups-modifier-group-id-delete) |
| `upload_media` **`Write`**          | Upload an image for an item, brand or category                                   | [POST /v1/media/](https://developer.yoco.com/api-reference/yoco-api/media/upload-media-v-1-media-post)                                                                 |
| `list_taxes`                        | List your business taxes                                                         | [GET /v1/taxes/](https://developer.yoco.com/api-reference/yoco-api/taxes/list-taxes-v-1-taxes-get)                                                                   |
| `get_tax`                           | Retrieve a single tax                                                            | [GET /v1/taxes/\{tax_id}](https://developer.yoco.com/api-reference/yoco-api/taxes/fetch-tax-v-1-taxes-tax-id-get)                                                 |

## Locations

Permission required: `business/locations:read`

| Tool             | Description                             | API reference                                                                    |
| ---------------- | --------------------------------------- | -------------------------------------------------------------------------------- |
| `list_locations` | List and filter your business locations | [GET /v1/locations/](https://developer.yoco.com/api-reference/yoco-api/locations/list-locations-v-1-locations-get)                             |
| `get_location`   | Retrieve a single location              | [GET /v1/locations/\{location_id}](https://developer.yoco.com/api-reference/yoco-api/locations/fetch-location-v-1-locations-location-id-get) |

## Staff

Permission required: `business/staff:read`

| Tool         | Description                         | API reference                                                      |
| ------------ | ----------------------------------- | ------------------------------------------------------------------ |
| `list_staff` | List and filter your business staff | [GET /v1/staff/](https://developer.yoco.com/api-reference/yoco-api/staff/list-staff-v-1-staff-get)                       |
| `get_staff`  | Retrieve a single staff member      | [GET /v1/staff/\{staff_id}](https://developer.yoco.com/api-reference/yoco-api/staff/fetch-staff-v-1-staff-staff-id-get) |