Overview
What the Atlas API does, the envelope every response carries, and where the reference lives.
Atlas is a merchant-facing REST API for moving money: payments (getting money
from a payer), payouts (sending money to a recipient), and refunds — plus the
status lookups that tell you where any of them stands. Every request is a flat
JSON body sent over HTTPS to a POST endpoint, signed with an HMAC-SHA256
signature computed from your merchant secret — there is no session, no API key
header, and no field on any endpoint that is optional to sign.
Base URL
Every path in this reference — /atlas/payment, /atlas/payout, and so on —
is relative to a base URL, which is issued to you with your credentials rather
than published here. Examples throughout this site use the placeholder
https://api.example.com; substitute the one you were given.
There is a separate base URL for development, issued the same way. They differ only in host: every path, field and signature rule below is the same on both.
The response envelope
Every successful response is wrapped the same way:
{
"success": true,
"data": { "...": "..." },
"timestamp": "2026-07-02T00:00:00.000Z"
}successis alwaystruehere — a failed request never reaches this shape at all. Failure is an HTTP error status, notsuccess: false.datais the endpoint's own payload — a created payment, a payout, a refund, a status, or a project list. Its shape is specific to the endpoint and documented on each reference page.timestampis when the response was produced, ISO 8601.
An error response has a different, fixed shape, on every endpoint but one:
{ "statusCode": 401, "message": "invalid signature", "error": "Unauthorized" }message is a single string for most rejections, and an array of strings —
one per failed constraint — specifically when the request body fails
validation, which is the only case with more than one thing wrong at once.
The one exception is insufficient wallet balance on
POST /atlas/payout, which answers with a flat,
differently-shaped 400 instead — see
Payouts, refunds and status lookups.
The endpoints
| Endpoint | Purpose |
|---|---|
POST /atlas/payment | Create a payment and get back a redirect_url or payment_details for the payer. |
POST /atlas/payin/status | Look up a payment's status by Atlas's id or your own external_id. |
POST /atlas/payout | Send money to a recipient. |
POST /atlas/payout/status | Look up a payout's status by Atlas's id or your own external_id. |
POST /atlas/refund | Refund a completed payment. |
POST /atlas/refund/status | Look up a refund's status. |
POST /atlas/project/list | List the projects available to your merchant, and the customer fields each one needs. |
Alongside these, Atlas delivers signed webhook callbacks to the
callback_url you supply on a payment or a payout, as its status changes —
see Webhooks.
Every field name, type and requirement is generated straight from the API's own request and response schemas, under Reference in the sidebar. This section is the prose the reference can't produce: why a webhook may arrive twice, how the signature is actually built, and what to do with the response you get back.
The same document these pages are generated from is available as an OpenAPI file, if you would rather generate a client than read.
There is deliberately no "try it" console on this site — no form that builds a signed request and fires it for you. Every request is signed with your merchant secret, and a page that asks for that secret in order to demonstrate signing is teaching the wrong habit. The worked examples on Authentication and the signature do the same job in code you keep.
Where to go next
Getting started
The shortest path from nothing to a created payment.
Authentication and the signature
The canonical string rule, worked by hand and in four languages.
Projects
Which projects you can charge against, and what each one accepts.
Payments
A complete signed request, and the redirect flow end to end.
Payouts, refunds and status lookups
What each is for, and when to poll versus wait.
Webhooks
How deliveries are verified, and why one may arrive twice.