API reference
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, and
Getting started for your first request.
Browse by section
Accounts & Utilities
Internal Accounts, Bank Account Verifications, Payment Proxy Address
Transactions & Reporting
Transactions, Statements, Report Files, Balances
Payments & Fund Transfers
Payments, Batch Payments, Refunds
Collections
Direct Debit, Hosted Payments
Virtual Accounts
List Virtual Accounts, Create a Virtual Account, Get a Virtual Account, Delete a Virtual Account
Foreign exchange (FX)
Look Up Forex Rates, Create a Forex Booking
Digital Assets
Transfer, Balances
Accounts & Utilities
Internal Accounts
| Endpoint | Request |
|---|---|
| List Internal Accounts | GET /v1/internal-accounts |
| Get an Internal Account | GET /v1/internal-accounts/{id} |
Bank Account Verifications
| Endpoint | Request |
|---|---|
| Verify identity of bank account holder | POST /v1/bank-account-verifications |
Payment Proxy Address
| Endpoint | Request |
|---|---|
| Look up a payment proxy address | POST /v1/payment-proxy/lookup |
Transactions & Reporting
Transactions
| Endpoint | Request |
|---|---|
| List Transactions | GET /v1/transactions |
| Create a test transaction | POST /v1/transactions |
| Get a Transaction | GET /v1/transactions/{id} |
Statements
| Endpoint | Request |
|---|---|
| List Statements | GET /v1/statements |
| Get a Statement | GET /v1/statements/{id} |
| Create a test statement | POST /v1/statements |
Report Files
| Endpoint | Request |
|---|---|
| List Report Files | GET /v1/report-files |
| Download a Report File | POST /v1/report-files/{id}/download |
Balances
| Endpoint | Request |
|---|---|
| Look up account balance | POST /v1/internal-accounts/{id}/balance |
Webhooks: Transaction and Statement Webhooks
Payments & Fund Transfers
Payments
| Endpoint | Request |
|---|---|
| List Payments | GET /v1/payments |
| Create a Payment | POST /v1/payments |
| Get a Payment | GET /v1/payments/{id} |
Actions for Maker-Checker
| Endpoint | Request |
|---|---|
| Approve a Payment | POST /v1/payments/{id}/approve |
| Reject a Payment | POST /v1/payments/{id}/reject |
Batch Payments
| Endpoint | Request |
|---|---|
| List Batch Payments | GET /v1/payment-batches |
| Create a Batch Payment | POST /v1/payment-batches |
| Get a Batch Payment | GET /v1/payment-batches/{id} |
| Close a Batch Payment | POST /v1/payment-batches/{id}/close |
| Create a Bank Payment File | POST /v1/payment-files |
Refunds
| Endpoint | Request |
|---|---|
| List Refunds | GET /v1/refunds |
| Create a Refund | POST /v1/refunds |
| Get a Refund | GET /v1/refunds/{id} |
Webhooks: Payment Webhooks
Collections
Direct Debit
Authorizations
| Endpoint | Request |
|---|---|
| List Direct Debit Authorizations | GET /v1/direct-debit-authorizations |
| Create a Direct Debit Authorization | POST /v1/direct-debit-authorizations |
| Get a Direct Debit Authorization | GET /v1/direct-debit-authorizations/{id} |
| Cancel a Direct Debit Authorization | POST /v1/direct-debit-authorizations/{id}/cancel |
| Confirm a Direct Debit Authorization OTP | POST /v1/direct-debit-authorizations/{id}/otp-confirmation |
| Regenerate a Direct Debit Authorization OTP | POST /v1/direct-debit-authorizations/{id}/otp-regeneration |
Collections
| Endpoint | Request |
|---|---|
| List Direct Debit Collections | GET /v1/direct-debit-payments |
| Create a Direct Debit Collection | POST /v1/direct-debit-payments |
| Get a Direct Debit Collection | GET /v1/direct-debit-payments/{id} |
Batch Collections
| Endpoint | Request |
|---|---|
| Create a Batch Direct Debit Collection | POST /v1/direct-debit-payment-batches |
| List Batch Direct Debit Collections | GET /v1/direct-debit-payment-batches |
| Get a Batch Direct Debit Collection | GET /v1/direct-debit-payment-batches/{id} |
Banks
| Endpoint | Request |
|---|---|
| List Direct Debit Banks | GET /v1/direct-debit-banks |
Webhooks: Direct Debit Webhooks
Hosted Payments
Payments
| Endpoint | Request |
|---|---|
| List Hosted Payments | GET /v1/hosted-payments |
| Create a Hosted Payment | POST /v1/hosted-payments |
| Get a Hosted Payment | GET /v1/hosted-payments/{id} |
Refunds
| Endpoint | Request |
|---|---|
| List Hosted Refunds | GET /v1/hosted-refunds |
| Create a Hosted Refund | POST /v1/hosted-refunds |
| Get a Hosted Refund | GET /v1/hosted-refunds/{id} |
Payment QR Codes
| Endpoint | Request |
|---|---|
| Create a payment QR code | POST /v1/payment-qr-code |
Tracked Payment QR Codes
| Endpoint | Request |
|---|---|
| List tracked QR code payments | GET /v1/tracked-payment-qr-codes |
| Create a tracked QR code | POST /v1/tracked-payment-qr-codes |
| Get a tracked QR code payment | GET /v1/tracked-payment-qr-codes/{id} |
| Perform a direct lookup of a tracked QR code | POST /v1/tracked-payment-qr-codes/lookup |
Webhooks: Hosted Payment Webhooks
Virtual Accounts
| Endpoint | Request |
|---|---|
| List Virtual Accounts | GET /v1/virtual-accounts |
| Create a Virtual Account | POST /v1/virtual-accounts |
| Get a Virtual Account | GET /v1/virtual-accounts/{id} |
| Delete a Virtual Account | POST /v1/virtual-accounts/{id}/delete |
Webhooks: Virtual Account Webhooks
Foreign exchange (FX)
| Endpoint | Request |
|---|---|
| Look Up Forex Rates | POST /v1/forex/rate-lookup |
| Create a Forex Booking | POST /v1/forex/booking |
Digital Assets
Transfer
| Endpoint | Request |
|---|---|
| Create a Digital Asset Transfer | POST /v1/digital-assets/transfer |
| Look up Digital Asset Transfer status | POST /v1/digital-assets/transfer-status |
Balances
| Endpoint | Request |
|---|---|
| Look up Digital Asset Balance | POST /v1/digital-assets/balance |