Getting started
Go from a test API key to your first live payment in five steps.
Acme is a REST API over HTTPS. Every request and response is JSON. You build and test your integration in test mode, which never reaches a bank and never moves money, then switch to a live key.
Get a test API key
Contact Acme to get your test API key. The key decides the mode: a test key runs every request in
TEST mode, a live key in LIVE mode. Keep the key on your server, never in client-side code or
source control.
Authenticate your first request
Send the key as a Bearer token in the Authorization header. List your bank accounts to check it
works:
curl https://api.tryacme.com/v1/internal-accounts \
--header "Authorization: Bearer YOUR_API_KEY"Next: Authentication.
Send a test payment
Create a payment with Create a Payment. Three things to know first:
- The fields a payment needs depend on its bank and payment type. Look up your bank in Bank payment rules.
amountis in minor units:1000is 10.00 SGD. See Minor units format.- Send an
Idempotency-Keyheader, so you can retry the request without paying twice. See Idempotency.
To see how your integration handles a failed payment, send one to a receiver account number from Test mode values.
Next: Single payments: integrate and test, then Payment lifecycle and statuses.
Receive webhooks
Give Acme one HTTPS endpoint URL for test mode and one for live mode. Acme sends you a signing key
for each. Verify the Acme-Signature header on every webhook before you act on it.
Next: Acme webhooks, then Webhook examples.
Go live
When your integration works in test mode:
- Ask Acme for your live API key and your live webhook signing key.
- Check each bank you send to against its payment rules.
- Handle a
503during a bank's scheduled maintenance. - Follow the Changelog and API compatibility for changes.