Build with Acme
Explore the Acme API by product or by bank, or follow Getting started to send your first test payment.
Start building
Getting started walks you through these five steps.
1. Get a test API key
Ask Acme for a test key. Test mode never reaches a bank.
2. Authenticate your first request
Send your key as a Bearer token on every request.
3. Send a test payment
Create a payment, then use the special test values to make it fail.
4. Receive webhooks
Verify each webhook's signature before you act on it.
5. Go live
Switch to your live key and check each bank's payment rules.
Browse by product
Payments
Send a single payment over a local rail or SWIFT.
Batch payments
Send many payments in one request.
Direct debit
Get a payer's authorization, then collect from their account.
Hosted payments
Collect a payment on a page Acme hosts for your customer.
Virtual accounts
Give each payer an account number to reconcile incoming funds.
Accounts and balances
List your bank accounts and look up their balances.
Transactions and statements
Read transactions and bank statements to reconcile.
Foreign exchange
Look up FX rates and book a conversion.
Digital assets
Transfer digital assets and look up their balances.
Browse by bank
Each bank has its own payment rules: the rails it supports and the fields, lengths and characters it accepts. Pick a bank and market below, or compare them all in Bank payment rules. Where a market has two guides, API covers single payments and H2H covers batch files.
ANZ
Banco Azteca
Citibank
Deutsche Bank
HSBC
Maybank
OCBC
RHB
Standard Chartered
Zand
Core concepts
- Minor units format: every
amountis in the currency's minor units. - Idempotency: retry a POST safely with an
Idempotency-Key. - Payment lifecycle and statuses: what each status means and when it changes.
- Pagination and Rate limits.
Resources
- Changelog: what changed in the API, month by month.
- API compatibility: what we keep stable, and how we announce changes.
- Scheduled maintenance: how a bank's maintenance window affects your requests.
- Test mode values: values that trigger failures in test mode.