# Endl API

> Official API documentation for the Endl platform.

- [Endl Partner documentation](https://docs.endl.io/index.md): Move money programmatically — wallets, quotes, recipients, accounts, transactions, and webhooks
- [API reference overview](https://docs.endl.io/api-reference/introduction.md): REST API for Endl partners: wallets, quotes, recipients, accounts, and transactions
- [Authentication](https://docs.endl.io/api-reference/authentication.md): Authenticate every Partner API request with your key and secret
- [Errors and the response envelope](https://docs.endl.io/api-reference/errors.md): One response shape across the Partner API, and what each status code means
- [List wallets](https://docs.endl.io/api-reference/wallets/list-wallets.md): Returns every wallet belonging to the user.
- [Create wallet](https://docs.endl.io/api-reference/wallets/create-wallet.md): Creates a wallet for the user on the given network.
- [Get wallet](https://docs.endl.io/api-reference/wallets/get-wallet.md): Returns a single wallet by id.
- [Update wallet](https://docs.endl.io/api-reference/wallets/update-wallet.md): Updates mutable wallet attributes such as its name. Omitted fields are left unchanged.
- [Delete wallet](https://docs.endl.io/api-reference/wallets/delete-wallet.md): Deletes a wallet.
- [Create wallet on network](https://docs.endl.io/api-reference/wallets/create-wallet-on-network.md): Provisions an existing wallet on an additional blockchain network.
- [Generate quote](https://docs.endl.io/api-reference/quotes/generate-quote.md): Prices a transfer and returns a quote. Requires the `quotes` permission.
- [Get quote](https://docs.endl.io/api-reference/quotes/get-quote.md): Returns a previously generated quote.
- [Add recipient](https://docs.endl.io/api-reference/recipients/add-recipient.md): Creates a recipient the user can pay out to. Requires the `recipients` permission.
- [List recipients](https://docs.endl.io/api-reference/recipients/list-recipients.md): Returns the user's recipients. Pass `size: 0` to return all of them in one response.
- [Get recipient](https://docs.endl.io/api-reference/recipients/get-recipient.md): Returns a single recipient.
- [Update recipient](https://docs.endl.io/api-reference/recipients/update-recipient.md): Updates a recipient. Include the recipient's `id` in the body; omitted fields are left unchanged.
- [Delete recipient](https://docs.endl.io/api-reference/recipients/delete-recipient.md): Soft-deletes a recipient. History is retained and the recipient stops appearing in listings.
- [List supported rails](https://docs.endl.io/api-reference/recipients/list-supported-rails.md): Returns the payout rails available for the user's country.
- [Get counterparty checks](https://docs.endl.io/api-reference/recipients/get-counterparty-checks.md): Returns the counterparty verification status recorded for a recipient.
- [Open account](https://docs.endl.io/api-reference/accounts/open-account.md): Opens an account for the user. Requires the `accounts` permission.
- [List accounts](https://docs.endl.io/api-reference/accounts/list-accounts.md): Returns the user's accounts.
- [List accounts available for opening](https://docs.endl.io/api-reference/accounts/list-accounts-available-for-opening.md): Returns the account types the user is still eligible to open.
- [Get account](https://docs.endl.io/api-reference/accounts/get-account.md): Returns one account, including its deposit instructions.
- [Get account balance](https://docs.endl.io/api-reference/accounts/get-account-balance.md): Returns the current balance of the account.
- [Get account activity](https://docs.endl.io/api-reference/accounts/get-account-activity.md): Returns the account's activity history.
- [Activate account](https://docs.endl.io/api-reference/accounts/activate-account.md): Reactivates a deactivated account.
- [Deactivate account](https://docs.endl.io/api-reference/accounts/deactivate-account.md): Deactivates an account. Deactivated accounts stop accepting deposits.
- [Create pre-transaction](https://docs.endl.io/api-reference/transactions/create-pre-transaction.md): Confirms a quote and returns the deposit instructions for funding the transfer. Call this after [Generate quote](/api-reference/quotes/generate-quote) and before [Submit transaction](/api-reference/transactions/submit-transaction).
- [Submit transaction](https://docs.endl.io/api-reference/transactions/submit-transaction.md): Creates the transaction and begins processing it.
- [Get transaction](https://docs.endl.io/api-reference/transactions/get-transaction.md): Returns one transaction and its current status.
- [List transactions](https://docs.endl.io/api-reference/transactions/list-transactions.md): Returns the user's transactions. Pass `size: 0` to return all of them in one response.
- [Get transaction metadata](https://docs.endl.io/api-reference/transactions/get-transaction-metadata.md): Returns summary metadata for the user's transactions, such as balances and counts.
- [List purpose codes](https://docs.endl.io/api-reference/transactions/list-purpose-codes.md): Returns the purpose-of-transfer codes accepted on transfers.
- [Upload invoice](https://docs.endl.io/api-reference/transactions/upload-invoice.md): Attaches one or more invoice files to the user's transaction record. Send the files as `multipart/form-data` under the `file` key.
- [List currencies](https://docs.endl.io/api-reference/reference/list-currencies.md): Returns the currencies Endl supports.
- [List countries](https://docs.endl.io/api-reference/reference/list-countries.md): Returns the countries Endl supports.
- [Get USD FX rates](https://docs.endl.io/api-reference/reference/get-usd-fx-rates.md): Returns reference FX rates quoted against USD.
- [List occupations](https://docs.endl.io/api-reference/reference/list-occupations.md): Returns the occupation catalogue, based on the ISCO-08 standard classification.
- [List rails](https://docs.endl.io/api-reference/reference/list-rails.md): Returns the payout rails available for a user, optionally narrowed to one destination country.
- [Get recipient required fields](https://docs.endl.io/api-reference/reference/get-recipient-required-fields.md): Returns the fields required to create a recipient for a given currency, together with their validation rules. Call this before [Add recipient](/api-reference/recipients/add-recipient) so you collect exactly what the rail needs.
- [List wallets](https://docs.endl.io/api-reference/wallets/list-wallets.md): Returns every wallet belonging to the user.
- [Create wallet](https://docs.endl.io/api-reference/wallets/create-wallet.md): Creates a wallet for the user on the given network.
- [Get wallet](https://docs.endl.io/api-reference/wallets/get-wallet.md): Returns a single wallet by id.
- [Delete wallet](https://docs.endl.io/api-reference/wallets/delete-wallet.md): Deletes a wallet.
- [Update wallet](https://docs.endl.io/api-reference/wallets/update-wallet.md): Updates mutable wallet attributes such as its name. Omitted fields are left unchanged.
- [Create wallet on network](https://docs.endl.io/api-reference/wallets/create-wallet-on-network.md): Provisions an existing wallet on an additional blockchain network.
- [Generate quote](https://docs.endl.io/api-reference/quotes/generate-quote.md): Prices a transfer and returns a quote. Requires the `quotes` permission.
- [Get quote](https://docs.endl.io/api-reference/quotes/get-quote.md): Returns a previously generated quote.
- [List currencies](https://docs.endl.io/api-reference/reference/list-currencies.md): Returns the currencies Endl supports.
- [List countries](https://docs.endl.io/api-reference/reference/list-countries.md): Returns the countries Endl supports.
- [Get USD FX rates](https://docs.endl.io/api-reference/reference/get-usd-fx-rates.md): Returns reference FX rates quoted against USD.
- [List occupations](https://docs.endl.io/api-reference/reference/list-occupations.md): Returns the occupation catalogue, based on the ISCO-08 standard classification.
- [List rails](https://docs.endl.io/api-reference/reference/list-rails.md): Returns the payout rails available for a user, optionally narrowed to one destination country.
- [Get recipient required fields](https://docs.endl.io/api-reference/reference/get-recipient-required-fields.md): Returns the fields required to create a recipient for a given currency, together with their validation rules. Call this before [Add recipient](/api-reference/recipients/add-recipient) so you collect exactly what the rail needs.
- [Update recipient](https://docs.endl.io/api-reference/recipients/update-recipient.md): Updates a recipient. Include the recipient's `id` in the body; omitted fields are left unchanged.
- [Add recipient](https://docs.endl.io/api-reference/recipients/add-recipient.md): Creates a recipient the user can pay out to. Requires the `recipients` permission.
- [Get recipient](https://docs.endl.io/api-reference/recipients/get-recipient.md): Returns a single recipient.
- [Delete recipient](https://docs.endl.io/api-reference/recipients/delete-recipient.md): Soft-deletes a recipient. History is retained and the recipient stops appearing in listings.
- [List recipients](https://docs.endl.io/api-reference/recipients/list-recipients.md): Returns the user's recipients. Pass `size: 0` to return all of them in one response.
- [List supported rails](https://docs.endl.io/api-reference/recipients/list-supported-rails.md): Returns the payout rails available for the user's country.
- [Get counterparty checks](https://docs.endl.io/api-reference/recipients/get-counterparty-checks.md): Returns the counterparty verification status recorded for a recipient.
- [List accounts](https://docs.endl.io/api-reference/accounts/list-accounts.md): Returns the user's accounts.
- [Open account](https://docs.endl.io/api-reference/accounts/open-account.md): Opens an account for the user. Requires the `accounts` permission.
- [List accounts available for opening](https://docs.endl.io/api-reference/accounts/list-accounts-available-for-opening.md): Returns the account types the user is still eligible to open.
- [Get account](https://docs.endl.io/api-reference/accounts/get-account.md): Returns one account, including its deposit instructions.
- [Get account balance](https://docs.endl.io/api-reference/accounts/get-account-balance.md): Returns the current balance of the account.
- [Get account activity](https://docs.endl.io/api-reference/accounts/get-account-activity.md): Returns the account's activity history.
- [Activate account](https://docs.endl.io/api-reference/accounts/activate-account.md): Reactivates a deactivated account.
- [Deactivate account](https://docs.endl.io/api-reference/accounts/deactivate-account.md): Deactivates an account. Deactivated accounts stop accepting deposits.
- [Create pre-transaction](https://docs.endl.io/api-reference/transactions/create-pre-transaction.md): Confirms a quote and returns the deposit instructions for funding the transfer. Call this after [Generate quote](/api-reference/quotes/generate-quote) and before [Submit transaction](/api-reference/transactions/submit-transaction).
- [Submit transaction](https://docs.endl.io/api-reference/transactions/submit-transaction.md): Creates the transaction and begins processing it.
- [Get transaction](https://docs.endl.io/api-reference/transactions/get-transaction.md): Returns one transaction and its current status.
- [List transactions](https://docs.endl.io/api-reference/transactions/list-transactions.md): Returns the user's transactions. Pass `size: 0` to return all of them in one response.
- [Get transaction metadata](https://docs.endl.io/api-reference/transactions/get-transaction-metadata.md): Returns summary metadata for the user's transactions, such as balances and counts.
- [List purpose codes](https://docs.endl.io/api-reference/transactions/list-purpose-codes.md): Returns the purpose-of-transfer codes accepted on transfers.
- [Upload invoice](https://docs.endl.io/api-reference/transactions/upload-invoice.md): Attaches one or more invoice files to the user's transaction record. Send the files as `multipart/form-data` under the `file` key.
- [Webhooks overview](https://docs.endl.io/webhooks/overview.md): Receive real-time events from Endl over signed webhooks, or poll for them
- [Authentication](https://docs.endl.io/webhooks/authentication.md): Authenticate every webhooks API request with your partner key and secret
- [Verifying signatures](https://docs.endl.io/webhooks/signature-verification.md): Prove a webhook delivery came from Endl before you act on it
- [Subscriptions](https://docs.endl.io/webhooks/subscriptions.md): Register and manage the endpoints that receive your events
- [Deliveries](https://docs.endl.io/webhooks/deliveries.md): Inspect every attempt Endl made to deliver an event, and retry the ones that failed
- [Pull feed](https://docs.endl.io/webhooks/pull-feed.md): Poll for your events instead of hosting a webhook receiver
- [Pagination](https://docs.endl.io/webhooks/pagination.md): Follow opaque forward-only cursors through deliveries and the event feed
- [Errors and the response envelope](https://docs.endl.io/webhooks/errors.md): One response shape, and the status codes the webhooks API returns
- [Reference](https://docs.endl.io/webhooks/reference.md): Event types, delivery modes, statuses, error classes, and limits

## OpenAPI Specs

- [endl-partner-api](/api-reference/endl-partner-api.json)