# Melio Payouts API ## Docs - [Introduction](https://developers.staging01.melio.com/docs/Introduction.md): Move money to any business with the Melio Payouts API - onboard an entity, attach accounts, and make payments. - [Getting Started](https://developers.staging01.melio.com/docs/getting-started.md) - [Authentication](https://developers.staging01.melio.com/docs/authentication.md): Pass your API key in the api-key request header to authenticate every call to the Melio Payouts API. Learn how to handle auth errors. - [Entities](https://developers.staging01.melio.com/docs/entities.md) - [Accounts](https://developers.staging01.melio.com/docs/accounts.md): Accounts represent funding sources (internal) and delivery methods (external). Learn account types, verification, and how to link accounts to payments. - [Payments](https://developers.staging01.melio.com/docs/payments.md) - [Payment lifecycle](https://developers.staging01.melio.com/docs/payment-lifecycle.md) - [Payment failures](https://developers.staging01.melio.com/docs/payment-failure.md) - [Pagination](https://developers.staging01.melio.com/docs/pagination.md) - [Idempotency](https://developers.staging01.melio.com/docs/idempotency.md): How to safely retry write requests to the Payouts API using idempotency keys. - [External IDs](https://developers.staging01.melio.com/docs/external-ids.md) - [Metadata](https://developers.staging01.melio.com/docs/metadata.md) - [Timestamps](https://developers.staging01.melio.com/docs/timestamps.md) - [Errors](https://developers.staging01.melio.com/docs/errors.md) - [Status Codes](https://developers.staging01.melio.com/docs/status-codes.md) - [Webhooks](https://developers.staging01.melio.com/docs/webhooks.md) - [Limitations](https://developers.staging01.melio.com/docs/Limitations.md) - [Risk and compliance](https://developers.staging01.melio.com/docs/risk-and-compliance.md) - [Legal & UI requirements](https://developers.staging01.melio.com/docs/ui-requirements.md) - [Sonar session token](https://developers.staging01.melio.com/docs/sonar-session-token.md): Mint a Sonar session and forward it as the Melio-Sonar-Token header so legitimate payments aren't wrongly declined. - [Going live](https://developers.staging01.melio.com/docs/going-live.md) - [API Simulator](https://developers.staging01.melio.com/docs/Simulator.md) - [Fee Calculator](https://developers.staging01.melio.com/docs/fee-calculator.md) - [Fast payment eligibility](https://developers.staging01.melio.com/docs/eligibility.md) - [Delivery ETA](https://developers.staging01.melio.com/docs/delivery-eta.md) - [Email communication](https://developers.staging01.melio.com/docs/email-communication.md): The emails Melio sends to the business in different cases, and how you can configure them. - [MCP](https://developers.staging01.melio.com/docs/MCP.md) - [List entities](https://developers.staging01.melio.com/docs/api-reference/entities/list-entities.md): Returns your entities, newest first. Use the filters below to narrow the list. - [Create an entity](https://developers.staging01.melio.com/docs/api-reference/entities/create-an-entity.md): Creates an entity (a business). A direct partner manages a single entity; a platform partner can create as many as it needs. - [Get an entity](https://developers.staging01.melio.com/docs/api-reference/entities/get-an-entity.md) - [Update an entity](https://developers.staging01.melio.com/docs/api-reference/entities/update-an-entity.md): Updates an entity. Only the fields you send are changed. Some compliance fields (`legalName`, `legalAddress`, `taxInfo`) are fixed once the entity is created. - [Get limitations](https://developers.staging01.melio.com/docs/api-reference/entities/get-limitations.md): Returns the entity's per-operation capabilities. Each operation (named `resource.subtype:action`) is either allowed or, if not, lists the reasons why (for example, missing information). Only write operations can be limited; read operations are always allowed and are not listed. - [List accounts](https://developers.staging01.melio.com/docs/api-reference/accounts/list-accounts.md): Returns the entity's accounts. Any internal Plaid account that isn't yet verified has its verification status refreshed from Plaid before the response is returned. - [Create an account](https://developers.staging01.melio.com/docs/api-reference/accounts/create-an-account.md): Creates an account for the entity. An internal account is one the entity pays from (a bank account added through Plaid or, for selected partners, by its account and routing numbers). An external account is a payee the entity pays to, reachable by ACH, paper check, domestic wire, or virtual card. Aut… - [Create a link to add a Plaid or card account](https://developers.staging01.melio.com/docs/api-reference/accounts/create-a-link-to-add-a-plaid-or-card-account.md): Returns a short-lived link you hand to the entity. Opening it takes them to a Melio-hosted page that runs the Plaid or card flow and adds the internal account for them, so bank and card details never pass through your servers. Authenticate with your api-key. - [Get an account](https://developers.staging01.melio.com/docs/api-reference/accounts/get-an-account.md): Returns a single account. If it's an internal Plaid account that isn't yet verified, its verification status is refreshed from Plaid before the response is returned. - [Delete an account](https://developers.staging01.melio.com/docs/api-reference/accounts/delete-an-account.md): Deletes an account. An account referenced by any payment can't be deleted. - [Create a link to verify a Plaid account](https://developers.staging01.melio.com/docs/api-reference/accounts/create-a-link-to-verify-a-plaid-account.md): For an unverified internal Plaid account, returns a short-lived link you hand to the entity. Opening it takes them to a Melio-hosted page where they complete same-day micro-deposit verification in Plaid. Authenticate with your api-key. - [List payments](https://developers.staging01.melio.com/docs/api-reference/payments/list-payments.md): Returns the entity's payments, newest first. Use the filters below to narrow the list; they can be combined with each other and with pagination. - [Create a payment](https://developers.staging01.melio.com/docs/api-reference/payments/create-a-payment.md): Creates a payment from one of the entity's internal accounts to one of its external accounts. An `Idempotency-Key` header is required so the request is safe to retry. - [Get a payment](https://developers.staging01.melio.com/docs/api-reference/payments/get-a-payment.md): Returns a single payment by its Melio id (`pay_`). To look one up by your own identifier instead, list payments with `?externalId=`. - [Update a payment](https://developers.staging01.melio.com/docs/api-reference/payments/update-a-payment.md): Updates a payment while its `status` is still `scheduled`. Once processing has begun, the request returns `409 PAYMENT_NOT_EDITABLE`. Only the fields you send are changed. - [Cancel a payment](https://developers.staging01.melio.com/docs/api-reference/payments/cancel-a-payment.md): Cancels a payment while its `status` is still `scheduled` — i.e. before it begins processing. The payment moves to `status: canceled`. Once processing has begun, the request returns `409 PAYMENT_NOT_CANCELABLE`. - [Simulate a payment action](https://developers.staging01.melio.com/docs/api-reference/payments/simulate-a-payment-action.md): Advances a payment through its lifecycle for testing: approve or decline the risk review, collect or deliver the funds, or simulate a collection or delivery failure. The action runs against the real payment, so the status change and any webhooks fire just as in production. Available in non-productio… - [Calculate fees](https://developers.staging01.melio.com/docs/api-reference/tools/calculate-fees.md): Estimates the fees for a payment between two of the entity's accounts, without creating one. Fees depend on the originating account, the receiving account, the `deliveryPreference`, and the `amount`. All amounts are in minor units (cents). - [Check fast payment eligibility](https://developers.staging01.melio.com/docs/api-reference/tools/check-fast-payment-eligibility.md): Checks which faster-than-standard delivery options a payment between two of the entity's accounts is eligible for, without creating one. Eligibility depends on the originating account, the receiving account, and the `amount` (minor units, cents). The response has one entry per fast option valid for… - [Estimate delivery dates](https://developers.staging01.melio.com/docs/api-reference/tools/estimate-delivery-dates.md): Estimates when a payment between two of the entity's accounts would be delivered, without creating one. The response has one estimate per delivery option valid for the receiving account, for example `standard-ach`, `same-day-ach`, and `rtp` for ACH. `deductionDate` is the debit date used for the est… - [Get the webhook endpoint](https://developers.staging01.melio.com/docs/api-reference/webhooks/get-the-webhook-endpoint.md): Returns your webhook endpoint and the events it's subscribed to. - [Delete the webhook endpoint](https://developers.staging01.melio.com/docs/api-reference/webhooks/delete-the-webhook-endpoint.md): Removes your webhook endpoint. Melio stops sending deliveries. - [Create or update the webhook endpoint](https://developers.staging01.melio.com/docs/api-reference/webhooks/create-or-update-the-webhook-endpoint.md): Configures your single webhook endpoint. Only the fields you send are changed; `url` and `events` are required the first time. Sending `events` replaces the whole subscription list (include at least one). Each delivery is signed with HMAC-SHA256 in the `X-Melio-Signature` header. - [List webhook events](https://developers.staging01.melio.com/docs/api-reference/webhooks/list-webhook-events.md): Returns the event types you can subscribe a webhook endpoint to. ## OpenAPI Specs - [openapi](https://developers.staging01.melio.com/docs/openapi.json)