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

# Endpoint Overview

> A complete index of Yuno API endpoints organized by resource

This page provides a scannable catalog of all Yuno REST API endpoints. Use it to discover what operations are available before diving into individual reference pages.

For implementation details:

* [Authentication](/reference/getting-started/authentication) — How to authenticate API requests
* [Environments](/reference/getting-started/api-environments) — Sandbox and production base URLs
* [OpenAPI Specification](/openapi.json) — Machine-readable API definition

<Note>
  This overview is generated from the full OpenAPI specification (172 operations).
  A subset of 39 operations have been sandbox-tested and are available in `openapi/yuno_sandbox_tested.json`.
</Note>

## AI Caller

| Method | Endpoint                                   | Description                                         | Idempotent |
| ------ | ------------------------------------------ | --------------------------------------------------- | ---------- |
| POST   | `/smart-support/external/payments`         | Initiate Recovery Outreach for Abandoned User Flows | —          |
| POST   | `/smart-support/external/payments/recover` | Create recover                                      | —          |

## Accounts (Banking Connectivity)

| Method | Endpoint                           | Description                                | Idempotent |
| ------ | ---------------------------------- | ------------------------------------------ | ---------- |
| POST   | `/banking/accounts`                | Create Account (Banking Connectivity)      | —          |
| DELETE | `/banking/accounts/\{account_id\}` | Close Account (Banking Connectivity)       | —          |
| GET    | `/banking/accounts/\{account_id\}` | Get Account Details (Banking Connectivity) | —          |
| PATCH  | `/banking/accounts/\{account_id\}` | Update Account (Banking Connectivity)      | —          |

## Checkout Builder

| Method | Endpoint                       | Description                    | Idempotent |
| ------ | ------------------------------ | ------------------------------ | ---------- |
| GET    | `/checkouts`                   | List Checkouts                 | —          |
| POST   | `/checkouts`                   | Create Checkout                | Yes        |
| GET    | `/checkouts/\{checkout_code\}` | Fetch Checkout Configuration   | —          |
| PATCH  | `/checkouts/\{checkout_code\}` | Manage Checkout Lifecycle      | Yes        |
| PUT    | `/checkouts/\{checkout_code\}` | Publish Checkout Configuration | Yes        |

## Checkout Sessions

| Method | Endpoint                                                  | Description                           | Idempotent |
| ------ | --------------------------------------------------------- | ------------------------------------- | ---------- |
| POST   | `/checkout/sessions`                                      | Create Checkout Session               | —          |
| GET    | `/checkout/sessions/\{checkout_session\}`                 | Retrieve Checkout Session             | —          |
| PATCH  | `/checkout/sessions/\{checkout_session\}`                 | Update sessions                       | —          |
| GET    | `/checkout/sessions/\{checkout_session\}/payment-methods` | Retrieve Payment Methods for Checkout | —          |

## Communications Campaigns

| Method | Endpoint                                              | Description      | Idempotent |
| ------ | ----------------------------------------------------- | ---------------- | ---------- |
| GET    | `/campaigns`                                          | Get campaigns    | —          |
| POST   | `/campaigns`                                          | Create campaigns | —          |
| GET    | `/campaigns/\{campaign_id\}`                          | Get campaigns    | —          |
| PATCH  | `/campaigns/\{campaign_id\}`                          | Update campaigns | —          |
| POST   | `/campaigns/\{campaign_id\}/rules`                    | Create rules     | —          |
| GET    | `/campaigns/\{campaign_id\}/rules/\{rule_id\}`        | Get rules        | —          |
| PATCH  | `/campaigns/\{campaign_id\}/rules/\{rule_id\}`        | Update rules     | —          |
| PATCH  | `/campaigns/\{campaign_id\}/rules/\{rule_id\}/status` | Update status    | —          |

## Conversion Rate

| Method | Endpoint               | Description         | Idempotent |
| ------ | ---------------------- | ------------------- | ---------- |
| POST   | `/currency-conversion` | Get Conversion Rate | —          |

## Customer Sessions Enrollment

| Method | Endpoint              | Description             | Idempotent |
| ------ | --------------------- | ----------------------- | ---------- |
| POST   | `/customers/sessions` | Create Customer Session | —          |

## Customers

| Method | Endpoint                     | Description                      | Idempotent |
| ------ | ---------------------------- | -------------------------------- | ---------- |
| GET    | `/customers`                 | Retrieve Customer by External ID | —          |
| POST   | `/customers`                 | Create Customer                  | —          |
| DELETE | `/customers/\{customer_id\}` | Delete customers                 | —          |
| GET    | `/customers/\{customer_id\}` | Retrieve Customer                | —          |
| PATCH  | `/customers/\{customer_id\}` | Update Customer                  | —          |

## Dry Run

| Method | Endpoint                   | Description                                             | Idempotent |
| ------ | -------------------------- | ------------------------------------------------------- | ---------- |
| POST   | `/dry-run/provider-events` | Register provider request / response / webhook payloads | Yes        |

## Entities (Banking Connectivity)

| Method | Endpoint                          | Description                               | Idempotent |
| ------ | --------------------------------- | ----------------------------------------- | ---------- |
| POST   | `/banking/entities`               | Create Entity (Banking Connectivity)      | —          |
| GET    | `/banking/entities/\{entity_id\}` | Get Entity Details (Banking Connectivity) | —          |
| PATCH  | `/banking/entities/\{entity_id\}` | Update Entity (Banking Connectivity)      | —          |

## Entity Onboarding (Banking Connectivity)

| Method | Endpoint                                                               | Description                                         | Idempotent |
| ------ | ---------------------------------------------------------------------- | --------------------------------------------------- | ---------- |
| POST   | `/banking/entities/\{entity_id\}/onboardings`                          | Create Entity Onboarding (Banking Connectivity)     | —          |
| GET    | `/banking/entities/\{entity_id\}/onboardings/\{onboarding_id\}`        | Get Entity Onboarding Status (Banking Connectivity) | —          |
| PATCH  | `/banking/entities/\{entity_id\}/onboardings/\{onboarding_id\}`        | Update Entity Onboarding (Banking Connectivity)     | —          |
| POST   | `/banking/entities/\{entity_id\}/onboardings/\{onboarding_id\}/cancel` | Cancel Entity Onboarding (Banking Connectivity)     | —          |

## Entity Transfers (Banking Connectivity)

| Method | Endpoint                                                            | Description                                       | Idempotent |
| ------ | ------------------------------------------------------------------- | ------------------------------------------------- | ---------- |
| GET    | `/banking/accounts/\{account_id\}/transfers/\{transfer_id\}`        | Get Entity Transfer Status (Banking Connectivity) | —          |
| POST   | `/banking/accounts/\{account_id\}/transfers/\{transfer_id\}/cancel` | Cancel Entity Transfer (Banking Connectivity)     | —          |
| POST   | `/banking/transfers`                                                | Initiate Entity Transfer (Banking Connectivity)   | —          |

## Installments

| Method | Endpoint                                   | Description                 | Idempotent |
| ------ | ------------------------------------------ | --------------------------- | ---------- |
| GET    | `/installments-plans`                      | Get Installments Plans      | —          |
| POST   | `/installments-plans`                      | Create Installments Plan    | —          |
| DELETE | `/installments-plans/\{installment_code\}` | Delete Installments Plan    | —          |
| GET    | `/installments-plans/\{installment_code\}` | Get Installments Plan by ID | —          |
| PATCH  | `/installments-plans/\{installment_code\}` | Update Plan                 | —          |

## Network Tokens

| Method | Endpoint                      | Description                       | Idempotent |
| ------ | ----------------------------- | --------------------------------- | ---------- |
| POST   | `/network-tokens/cryptograms` | Generate Network Token Cryptogram | —          |

## Organizations

| Method | Endpoint                                                                          | Description                             | Idempotent |
| ------ | --------------------------------------------------------------------------------- | --------------------------------------- | ---------- |
| POST   | `/connections`                                                                    | Create a Connection                     | Yes        |
| GET    | `/connections/\{connection_id\}`                                                  | Retrieve a Connection                   | —          |
| GET    | `/connections/catalog/\{provider_id\}`                                            | Get Provider Catalog                    | —          |
| GET    | `/organizations/account-groups`                                                   | List Account Groups                     | —          |
| POST   | `/organizations/account-groups`                                                   | Create Account Group                    | —          |
| DELETE | `/organizations/account-groups/\{account_group_id\}`                              | Delete Account Group                    | —          |
| GET    | `/organizations/account-groups/\{account_group_id\}`                              | Retrieve Account Group                  | —          |
| PATCH  | `/organizations/account-groups/\{account_group_id\}`                              | Update Account Group                    | —          |
| GET    | `/organizations/account-groups/\{account_group_id\}/accounts`                     | List Accounts of Group                  | —          |
| POST   | `/organizations/account-groups/\{account_group_id\}/accounts`                     | Create Account                          | —          |
| GET    | `/organizations/accounts`                                                         | List Accounts                           | —          |
| DELETE | `/organizations/accounts/\{account_id\}`                                          | Delete Account                          | —          |
| GET    | `/organizations/accounts/\{account_id\}`                                          | Retrieve Account                        | —          |
| PATCH  | `/organizations/accounts/\{account_id\}`                                          | Update Account                          | —          |
| POST   | `/organizations/authenticate`                                                     | Authenticate Whitelabel User            | —          |
| GET    | `/organizations/permissions-catalog`                                              | List Permissions Catalog                | —          |
| GET    | `/organizations/roles`                                                            | List Roles                              | —          |
| POST   | `/organizations/roles`                                                            | Create Role                             | —          |
| DELETE | `/organizations/roles/\{role_id\}`                                                | Delete Role                             | —          |
| PATCH  | `/organizations/roles/\{role_id\}`                                                | Update Role                             | —          |
| GET    | `/organizations/users`                                                            | List Users                              | —          |
| POST   | `/organizations/users`                                                            | Create User                             | —          |
| DELETE | `/organizations/users/\{user_id\}`                                                | Delete User                             | —          |
| GET    | `/organizations/users/\{user_id\}`                                                | Retrieve User                           | —          |
| PATCH  | `/organizations/users/\{user_id\}`                                                | Update User                             | —          |
| GET    | `/organizations/users/\{user_id\}/account-group-permissions`                      | Retrieve User Account Group Permissions | —          |
| PATCH  | `/organizations/users/\{user_id\}/account-group-permissions`                      | Update User Account Group Permissions   | —          |
| PUT    | `/organizations/users/\{user_id\}/account-group-permissions`                      | Replace User Account Group Permissions  | —          |
| DELETE | `/organizations/users/\{user_id\}/account-group-permissions/\{account_group_id\}` | Delete User Account Group Permission    | —          |
| GET    | `/organizations/users/\{user_id\}/account-permissions`                            | Retrieve User Account Permissions       | —          |
| PATCH  | `/organizations/users/\{user_id\}/account-permissions`                            | Update User Account Permissions         | —          |
| PUT    | `/organizations/users/\{user_id\}/account-permissions`                            | Replace User Account Permissions        | —          |
| DELETE | `/organizations/users/\{user_id\}/account-permissions/\{account_id\}`             | Delete User Account Permission          | —          |
| GET    | `/routing`                                                                        | List Routings                           | —          |
| POST   | `/routing`                                                                        | Create a Routing                        | Yes        |
| GET    | `/routing/\{routing_id\}`                                                         | Retrieve a Routing                      | —          |
| PATCH  | `/routing/\{routing_id\}`                                                         | Update a Routing                        | Yes        |
| POST   | `/routing/recommendations`                                                        | Get a Routing Recommendation            | —          |

## Payment Links

| Method | Endpoint                         | Description           | Idempotent |
| ------ | -------------------------------- | --------------------- | ---------- |
| POST   | `/payment-links`                 | Create Payment Link   | —          |
| GET    | `/payment-links/\{code\}`        | Retrieve Payment Link | —          |
| POST   | `/payment-links/\{code\}/cancel` | Cancel Payment Link   | —          |

## Payment Methods Checkout

| Method | Endpoint                                                            | Description                        | Idempotent |
| ------ | ------------------------------------------------------------------- | ---------------------------------- | ---------- |
| GET    | `/checkout/customers/sessions/\{customer_session\}/payment-methods` | Retrieve Payment Methods To Enroll | —          |
| POST   | `/customers/payment-methods/\{payment_method_id\}/unenroll`         | Unenroll Payment Method            | —          |
| POST   | `/customers/sessions/\{customer_session\}/payment-methods`          | Enroll Payment Method              | —          |
| GET    | `/payment-methods/\{payment_method_id\}`                            | Retrieve Payment Method By ID      | —          |

## Payment Methods Direct Workflow

| Method | Endpoint                                                                    | Description                                   | Idempotent |
| ------ | --------------------------------------------------------------------------- | --------------------------------------------- | ---------- |
| GET    | `/customers/\{customer_id\}/payment-methods`                                | Retrieve Enrolled Payment Methods             | —          |
| POST   | `/customers/\{customer_id\}/payment-methods`                                | Enroll Payment Method                         | —          |
| GET    | `/customers/\{customer_id\}/payment-methods/\{payment_method_id\}`          | Retrieve Enrolled Payment Method by Id        | —          |
| POST   | `/customers/\{customer_id\}/payment-methods/\{payment_method_id\}/unenroll` | Unenroll Payment Method                       | —          |
| PATCH  | `/payment-methods/\{payment_method_id\}`                                    | Reassign a Payment Method to Another Customer | —          |
| POST   | `/payment-methods/account-updater`                                          | Register Stored Cards for Account Updater     | —          |

## Payments

| Method | Endpoint                                                                    | Description                                 | Idempotent |
| ------ | --------------------------------------------------------------------------- | ------------------------------------------- | ---------- |
| GET    | `/issuers`                                                                  | Retrieve Issuers                            | —          |
| GET    | `/payments`                                                                 | Retrieve Payment by Merchant Order ID       | —          |
| POST   | `/payments`                                                                 | Create Payment                              | Yes        |
| POST   | `/payments/\{id\}/transactions/\{transaction_id\}/refund`                   | Refund Payment                              | —          |
| GET    | `/payments/\{payment_id\}`                                                  | Retrieve Payment by ID                      | —          |
| POST   | `/payments/\{payment_id\}/cancel-or-refund`                                 | Cancel or Refund a Payment                  | —          |
| POST   | `/payments/\{payment_id\}/fulfillments`                                     | Notify Fulfillment                          | —          |
| POST   | `/payments/\{payment_id\}/transactions/\{transaction_id\}/cancel`           | Cancel Payment                              | —          |
| POST   | `/payments/\{payment_id\}/transactions/\{transaction_id\}/cancel-or-refund` | Cancel or Refund a Payment with transaction | —          |
| POST   | `/payments/\{payment_id\}/transactions/\{transaction_id\}/capture`          | Capture Authorization                       | —          |
| PATCH  | `/payments/\{payment_id\}/transactions/\{transaction_id\}/dispute`          | Update dispute                              | —          |
| POST   | `/payments/\{payment_id\}/transactions/\{transaction_id\}/dispute`          | Dispute a chargeback                        | —          |

## Payouts

| Method | Endpoint                 | Description                           | Idempotent |
| ------ | ------------------------ | ------------------------------------- | ---------- |
| GET    | `/payouts`               | Retrieve Payout by Merchant Reference | —          |
| POST   | `/payouts`               | Create Payout                         | —          |
| GET    | `/payouts/\{payout_id\}` | Retrieve Payout by ID                 | —          |

## Pci Proxy

| Method | Endpoint                                 | Description          | Idempotent |
| ------ | ---------------------------------------- | -------------------- | ---------- |
| GET    | `/pci-proxy/destinations`                | List Destinations    | —          |
| POST   | `/pci-proxy/destinations`                | Register Destination | —          |
| DELETE | `/pci-proxy/destinations/\{id\}`         | Remove Destination   | —          |
| POST   | `/pci-proxy/destinations/\{id\}/disable` | Disable Destination  | —          |
| POST   | `/pci-proxy/destinations/\{id\}/enable`  | Enable Destination   | —          |
| POST   | `/pci-proxy/forward`                     | Invoke Forward Proxy | —          |

## Plans

| Method | Endpoint                    | Description   | Idempotent |
| ------ | --------------------------- | ------------- | ---------- |
| GET    | `/plans`                    | List Plans    | —          |
| POST   | `/plans`                    | Create Plan   | —          |
| GET    | `/plans/\{plan_id\}`        | Retrieve Plan | —          |
| POST   | `/plans/\{plan_id\}/status` | Cancel Plan   | —          |

## Pre Debit Notifications

| Method | Endpoint                                         | Description                                           | Idempotent |
| ------ | ------------------------------------------------ | ----------------------------------------------------- | ---------- |
| GET    | `/predebit-notify`                               | Retrieve Pre-Debit Notification by Merchant Reference | —          |
| POST   | `/predebit-notify`                               | Create Pre-Debit Notification                         | Yes        |
| GET    | `/predebit-notify/\{pre_debit_notification_id\}` | Retrieve Pre-Debit Notification by ID                 | —          |

## Recipients For Marketplace

| Method | Endpoint                                                                                       | Description              | Idempotent |
| ------ | ---------------------------------------------------------------------------------------------- | ------------------------ | ---------- |
| GET    | `/onboardings/\{onboarding_id\}/transfers`                                                     | Get transfers            | —          |
| POST   | `/payments/\{payment_id\}/transactions/\{transaction_id\}/split-marketplace/transfer-reversal` | Create transfer reversal | Yes        |
| GET    | `/recipients`                                                                                  | List Recipients          | —          |
| POST   | `/recipients`                                                                                  | Create Recipient         | —          |
| DELETE | `/recipients/\{recipient_id\}`                                                                 | Delete Recipient         | —          |
| GET    | `/recipients/\{recipient_id\}`                                                                 | Get Recipient            | —          |
| PATCH  | `/recipients/\{recipient_id\}`                                                                 | Update Recipient         | —          |
| POST   | `/recipients/\{recipient_id\}/onboardings`                                                     | Create Onboarding        | —          |
| GET    | `/recipients/\{recipient_id\}/onboardings/\{onboarding_id\}`                                   | Get Onboarding           | —          |
| PATCH  | `/recipients/\{recipient_id\}/onboardings/\{onboarding_id\}`                                   | Update onboarding        | —          |
| POST   | `/recipients/\{recipient_id\}/onboardings/\{onboarding_id\}/block`                             | Block Recipient          | —          |
| POST   | `/recipients/\{recipient_id\}/onboardings/\{onboarding_id\}/cancel`                            | Cancel Onboarding        | —          |
| POST   | `/recipients/\{recipient_id\}/onboardings/\{onboarding_id\}/continue`                          | Continue Onboarding      | —          |
| POST   | `/recipients/\{recipient_id\}/onboardings/\{onboarding_id\}/transfer`                          | Create transfer          | Yes        |
| POST   | `/recipients/\{recipient_id\}/onboardings/\{onboarding_id\}/unblock`                           | Unblock Recipient        | —          |
| GET    | `/recipients/\{recipient_id\}/transfers`                                                       | Get transfers            | —          |
| POST   | `/recipients/onboardings/reverse-transfer/\{transfer_id\}`                                     | Create reverse transfer  | Yes        |
| GET    | `/transfers/\{transfer_id\}`                                                                   | Get transfers            | —          |

## Reporting

| Method | Endpoint                  | Description                  | Idempotent |
| ------ | ------------------------- | ---------------------------- | ---------- |
| POST   | `/reporting/transactions` | Report Off-Yuno Transactions | —          |

## Reports

| Method | Endpoint                          | Description       | Idempotent |
| ------ | --------------------------------- | ----------------- | ---------- |
| POST   | `/reports`                        | Create a Report   | —          |
| GET    | `/reports/\{report_id\}`          | Retrieve a Report | —          |
| GET    | `/reports/\{report_id\}/download` | Download a Report | —          |
| GET    | `/reports/list`                   | List All Reports  | —          |

## Sellers

| Method | Endpoint                          | Description   | Idempotent |
| ------ | --------------------------------- | ------------- | ---------- |
| POST   | `/sellers`                        | Create Seller | —          |
| DELETE | `/sellers/\{merchant_seller_id\}` | Delete Seller | —          |
| GET    | `/sellers/\{merchant_seller_id\}` | Get Seller    | —          |
| PUT    | `/sellers/\{merchant_seller_id\}` | Update Seller | —          |

## Subscriptions

| Method | Endpoint                                      | Description                | Idempotent |
| ------ | --------------------------------------------- | -------------------------- | ---------- |
| GET    | `/subscriptions`                              | List Subscriptions         | —          |
| POST   | `/subscriptions`                              | Create Subscription        | —          |
| POST   | `/subscriptions/\{id\}/retry`                 | Retry Subscription         | —          |
| GET    | `/subscriptions/\{subscription_id\}`          | Retrieve Subscription      | —          |
| PATCH  | `/subscriptions/\{subscription_id\}`          | Update Subscription        | —          |
| POST   | `/subscriptions/\{subscription_id\}/cancel`   | Cancel Subscription        | —          |
| POST   | `/subscriptions/\{subscription_id\}/pause`    | Pause Subscription         | —          |
| GET    | `/subscriptions/\{subscription_id\}/payments` | List Subscription Payments | —          |
| POST   | `/subscriptions/\{subscription_id\}/plan`     | Change Subscription Plan   | —          |
| POST   | `/subscriptions/\{subscription_id\}/resume`   | Resume Subscription        | —          |

## Three D Secure Setups

| Method | Endpoint                 | Description       | Idempotent |
| ------ | ------------------------ | ----------------- | ---------- |
| POST   | `/three-d-secure/setups` | Create 3DS2 Setup | —          |

## Transfers

| Method | Endpoint                                               | Description                 | Idempotent |
| ------ | ------------------------------------------------------ | --------------------------- | ---------- |
| POST   | `/split-marketplace/transfers`                         | Create Standalone Transfer  | Yes        |
| GET    | `/split-marketplace/transfers/\{transfer_id\}`         | Get Standalone Transfer     | —          |
| POST   | `/split-marketplace/transfers/\{transfer_id\}/reverse` | Reverse Standalone Transfer | Yes        |

## Webhooks

| Method | Endpoint                   | Description        | Idempotent |
| ------ | -------------------------- | ------------------ | ---------- |
| GET    | `/webhooks`                | List Webhooks      | —          |
| POST   | `/webhooks`                | Create a Webhook   | —          |
| DELETE | `/webhooks/\{webhook_id\}` | Delete a Webhook   | —          |
| GET    | `/webhooks/\{webhook_id\}` | Retrieve a Webhook | —          |
| PATCH  | `/webhooks/\{webhook_id\}` | Update a Webhook   | —          |
