# API reference (https://docs.tryacme.com/reference)

> For AI agents: the documentation index is at [llms.txt](https://docs.tryacme.com/llms.txt), with every page in one file at [llms-full.txt](https://docs.tryacme.com/llms-full.txt). Each page is also available as Markdown by appending `.md` to its URL.

Every endpoint of the Acme API, by section.

The Acme API is a REST API. Send JSON over HTTPS to `https://api.tryacme.com`, with your API key as
a Bearer token. See [Authentication](https://docs.tryacme.com/guides/authentication), and
[Getting started](https://docs.tryacme.com/guides/getting-started) for your first request.

## Browse by section [#browse-by-section]

- [Accounts & Utilities](#accounts-and-utilities): Internal Accounts, Bank Account Verifications, Payment Proxy Address
- [Transactions & Reporting](#transactions-and-reporting): Transactions, Statements, Report Files, Balances
- [Payments & Fund Transfers](#payments-and-fund-transfers): Payments, Batch Payments, Refunds
- [Collections](#collections): Direct Debit, Hosted Payments
- [Virtual Accounts](#virtual-accounts): List Virtual Accounts, Create a Virtual Account, Get a Virtual Account, Delete a Virtual Account
- [Foreign exchange (FX)](#foreign-exchange-fx): Look Up Forex Rates, Create a Forex Booking
- [Digital Assets](#digital-assets): Transfer, Balances

## Accounts & Utilities [#accounts-and-utilities]

### Internal Accounts [#internal-accounts]

| Endpoint | Request |
| --- | --- |
| [List Internal Accounts](https://docs.tryacme.com/reference/list-internal-accounts) | `GET /v1/internal-accounts` |
| [Get an Internal Account](https://docs.tryacme.com/reference/get-internal-accounts-id) | `GET /v1/internal-accounts/{id}` |

### Bank Account Verifications [#bank-account-verifications]

| Endpoint | Request |
| --- | --- |
| [Verify identity of bank account holder](https://docs.tryacme.com/reference/post-bank-account-verifications) | `POST /v1/bank-account-verifications` |

### Payment Proxy Address [#payment-proxy-address]

| Endpoint | Request |
| --- | --- |
| [Look up a payment proxy address](https://docs.tryacme.com/reference/post-payment-proxy-lookup) | `POST /v1/payment-proxy/lookup` |

## Transactions & Reporting [#transactions-and-reporting]

### Transactions [#transactions]

| Endpoint | Request |
| --- | --- |
| [List Transactions](https://docs.tryacme.com/reference/get-transactions) | `GET /v1/transactions` |
| [Create a test transaction](https://docs.tryacme.com/reference/post-transactions) | `POST /v1/transactions` |
| [Get a Transaction](https://docs.tryacme.com/reference/get-transactions-id) | `GET /v1/transactions/{id}` |

### Statements [#statements]

| Endpoint | Request |
| --- | --- |
| [List Statements](https://docs.tryacme.com/reference/get-statements) | `GET /v1/statements` |
| [Get a Statement](https://docs.tryacme.com/reference/get-statements-id) | `GET /v1/statements/{id}` |
| [Create a test statement](https://docs.tryacme.com/reference/post-statements) | `POST /v1/statements` |

### Report Files [#report-files]

| Endpoint | Request |
| --- | --- |
| [List Report Files](https://docs.tryacme.com/reference/get-report-files) | `GET /v1/report-files` |
| [Download a Report File](https://docs.tryacme.com/reference/post-report-files-id-download) | `POST /v1/report-files/{id}/download` |

### Balances [#balances]

| Endpoint | Request |
| --- | --- |
| [Look up account balance](https://docs.tryacme.com/reference/post-internal-accounts-id-balance) | `POST /v1/internal-accounts/{id}/balance` |

Webhooks: [Transaction and Statement Webhooks](https://docs.tryacme.com/reference/webhooks-transactions)

## Payments & Fund Transfers [#payments-and-fund-transfers]

### Payments [#payments]

| Endpoint | Request |
| --- | --- |
| [List Payments](https://docs.tryacme.com/reference/get-payments) | `GET /v1/payments` |
| [Create a Payment](https://docs.tryacme.com/reference/post-payments) | `POST /v1/payments` |
| [Get a Payment](https://docs.tryacme.com/reference/get-payments-id) | `GET /v1/payments/{id}` |

#### Actions for Maker-Checker [#actions-for-maker-checker]

| Endpoint | Request |
| --- | --- |
| [Approve a Payment](https://docs.tryacme.com/reference/post-payments-id-approve) | `POST /v1/payments/{id}/approve` |
| [Reject a Payment](https://docs.tryacme.com/reference/post-payments-id-reject) | `POST /v1/payments/{id}/reject` |

### Batch Payments [#batch-payments]

| Endpoint | Request |
| --- | --- |
| [List Batch Payments](https://docs.tryacme.com/reference/list-batch-payments) | `GET /v1/payment-batches` |
| [Create a Batch Payment](https://docs.tryacme.com/reference/post-batch-payments) | `POST /v1/payment-batches` |
| [Get a Batch Payment](https://docs.tryacme.com/reference/get-batch-payments-id) | `GET /v1/payment-batches/{id}` |
| [Close a Batch Payment](https://docs.tryacme.com/reference/post-batch-payments-id-close) | `POST /v1/payment-batches/{id}/close` |
| [Create a Bank Payment File](https://docs.tryacme.com/reference/post-bank-payments-file) | `POST /v1/payment-files` |

### Refunds [#refunds]

| Endpoint | Request |
| --- | --- |
| [List Refunds](https://docs.tryacme.com/reference/get-refunds) | `GET /v1/refunds` |
| [Create a Refund](https://docs.tryacme.com/reference/post-refunds) | `POST /v1/refunds` |
| [Get a Refund](https://docs.tryacme.com/reference/get-refunds-id) | `GET /v1/refunds/{id}` |

Webhooks: [Payment Webhooks](https://docs.tryacme.com/reference/webhooks-payments)

## Collections [#collections]

### Direct Debit [#direct-debit]

#### Authorizations [#authorizations]

| Endpoint | Request |
| --- | --- |
| [List Direct Debit Authorizations](https://docs.tryacme.com/reference/get-direct-debit-authorizations) | `GET /v1/direct-debit-authorizations` |
| [Create a Direct Debit Authorization](https://docs.tryacme.com/reference/post-direct-debit-authorizations) | `POST /v1/direct-debit-authorizations` |
| [Get a Direct Debit Authorization](https://docs.tryacme.com/reference/get-direct-debit-authorizations-id) | `GET /v1/direct-debit-authorizations/{id}` |
| [Cancel a Direct Debit Authorization](https://docs.tryacme.com/reference/post-direct-debit-authorizations-id-cancel) | `POST /v1/direct-debit-authorizations/{id}/cancel` |
| [Confirm a Direct Debit Authorization OTP](https://docs.tryacme.com/reference/post-direct-debit-authorizations-id-otp-confirmation) | `POST /v1/direct-debit-authorizations/{id}/otp-confirmation` |
| [Regenerate a Direct Debit Authorization OTP](https://docs.tryacme.com/reference/post-direct-debit-authorizations-id-otp-regeneration) | `POST /v1/direct-debit-authorizations/{id}/otp-regeneration` |

#### Collections [#collections]

| Endpoint | Request |
| --- | --- |
| [List Direct Debit Collections](https://docs.tryacme.com/reference/get-direct-debit-payments) | `GET /v1/direct-debit-payments` |
| [Create a Direct Debit Collection](https://docs.tryacme.com/reference/post-direct-debit-payments) | `POST /v1/direct-debit-payments` |
| [Get a Direct Debit Collection](https://docs.tryacme.com/reference/get-direct-debit-payments-id) | `GET /v1/direct-debit-payments/{id}` |

#### Batch Collections [#batch-collections]

| Endpoint | Request |
| --- | --- |
| [Create a Batch Direct Debit Collection](https://docs.tryacme.com/reference/post-direct-debit-payment-batches) | `POST /v1/direct-debit-payment-batches` |
| [List Batch Direct Debit Collections](https://docs.tryacme.com/reference/get-direct-debit-payment-batches) | `GET /v1/direct-debit-payment-batches` |
| [Get a Batch Direct Debit Collection](https://docs.tryacme.com/reference/get-direct-debit-payment-batch-id) | `GET /v1/direct-debit-payment-batches/{id}` |

#### Banks [#banks]

| Endpoint | Request |
| --- | --- |
| [List Direct Debit Banks](https://docs.tryacme.com/reference/get-direct-debit-banks) | `GET /v1/direct-debit-banks` |

Webhooks: [Direct Debit Webhooks](https://docs.tryacme.com/reference/webhooks-direct-debit)

### Hosted Payments [#hosted-payments]

#### Payments [#payments-1]

| Endpoint | Request |
| --- | --- |
| [List Hosted Payments](https://docs.tryacme.com/reference/get-hosted-payments) | `GET /v1/hosted-payments` |
| [Create a Hosted Payment](https://docs.tryacme.com/reference/post-hosted-payments) | `POST /v1/hosted-payments` |
| [Get a Hosted Payment](https://docs.tryacme.com/reference/get-hosted-payments-id) | `GET /v1/hosted-payments/{id}` |

#### Refunds [#refunds-1]

| Endpoint | Request |
| --- | --- |
| [List Hosted Refunds](https://docs.tryacme.com/reference/get-hosted-refunds) | `GET /v1/hosted-refunds` |
| [Create a Hosted Refund](https://docs.tryacme.com/reference/post-hosted-refunds) | `POST /v1/hosted-refunds` |
| [Get a Hosted Refund](https://docs.tryacme.com/reference/get-hosted-refunds-id) | `GET /v1/hosted-refunds/{id}` |

#### Payment QR Codes [#payment-qr-codes]

| Endpoint | Request |
| --- | --- |
| [Create a payment QR code](https://docs.tryacme.com/reference/post-payment-qr-codes) | `POST /v1/payment-qr-code` |

#### Tracked Payment QR Codes [#tracked-payment-qr-codes]

| Endpoint | Request |
| --- | --- |
| [List tracked QR code payments](https://docs.tryacme.com/reference/list-tracked-payment-qr-codes) | `GET /v1/tracked-payment-qr-codes` |
| [Create a tracked QR code](https://docs.tryacme.com/reference/post-tracked-payment-qr-codes) | `POST /v1/tracked-payment-qr-codes` |
| [Get a tracked QR code payment](https://docs.tryacme.com/reference/get-tracked-payment-qr-codes) | `GET /v1/tracked-payment-qr-codes/{id}` |
| [Perform a direct lookup of a tracked QR code](https://docs.tryacme.com/reference/lookup-tracked-payment-qr-codes) | `POST /v1/tracked-payment-qr-codes/lookup` |

Webhooks: [Hosted Payment Webhooks](https://docs.tryacme.com/reference/webhooks-hosted-payments)

## Virtual Accounts [#virtual-accounts]

| Endpoint | Request |
| --- | --- |
| [List Virtual Accounts](https://docs.tryacme.com/reference/get-virtual-accounts) | `GET /v1/virtual-accounts` |
| [Create a Virtual Account](https://docs.tryacme.com/reference/create-virtual-account) | `POST /v1/virtual-accounts` |
| [Get a Virtual Account](https://docs.tryacme.com/reference/get-virtual-account) | `GET /v1/virtual-accounts/{id}` |
| [Delete a Virtual Account](https://docs.tryacme.com/reference/delete-virtual-account) | `POST /v1/virtual-accounts/{id}/delete` |

Webhooks: [Virtual Account Webhooks](https://docs.tryacme.com/reference/webhooks-virtual-accounts)

## Foreign exchange (FX) [#foreign-exchange-fx]

| Endpoint | Request |
| --- | --- |
| [Look Up Forex Rates](https://docs.tryacme.com/reference/forex-rate-lookup) | `POST /v1/forex/rate-lookup` |
| [Create a Forex Booking](https://docs.tryacme.com/reference/create-a-forex-booking) | `POST /v1/forex/booking` |

## Digital Assets [#digital-assets]

### Transfer [#transfer]

| Endpoint | Request |
| --- | --- |
| [Create a Digital Asset Transfer](https://docs.tryacme.com/reference/digital-assets-transfer) | `POST /v1/digital-assets/transfer` |
| [Look up Digital Asset Transfer status](https://docs.tryacme.com/reference/digital-assets-transfer-status) | `POST /v1/digital-assets/transfer-status` |

### Balances [#balances-1]

| Endpoint | Request |
| --- | --- |
| [Look up Digital Asset Balance](https://docs.tryacme.com/reference/digital-assets-balance) | `POST /v1/digital-assets/balance` |