Atlar API Guide
A hands-on, step-by-step walkthrough of the Atlar treasury management API. You will learn how to authenticate, explore accounts, make payments, track transactions, and receive real-time webhook notifications — all within a safe sandbox environment.
What you will learn
OAuth 2.0 Authentication
Securely obtain tokens using Client Credentials flow.
Account & Balance Data
Query bank accounts, balances, and identifiers.
Payments End-to-End
Create counterparties, credit transfers, and approvals.
Transactions & Webhooks
Track transactions and receive real-time events.
Prerequisites
- ●An Atlar account — sign up at app.atlar.com
- ●A sandbox organization with the Atlar Testbank connected
- ●A terminal, REST client, or Python/Node.js environment for making API calls
- ●Familiarity with REST APIs and JSON
The Atlar API at a glance
The Atlar API is resource-oriented JSON REST. Endpoints are grouped into namespaces:
| Namespace | Base Path | Purpose |
|---|---|---|
| Financial Data | /financial-data/v2/ | Accounts, transactions, balances |
| Payments | /payments/v2/ | Credit transfers, direct debits, counterparties, mandates |
| Connectivity | /connectivity/v2beta/ | Bank connections and configuration |
| IAM | /iam/v2beta/ | Organizations, memberships, OAuth tokens |
Guide roadmap
Sandbox Setup & Test Bank
Create an organization and connect the Atlar Testbank.
Roles & Programmatic Access
Set up RBAC roles and create API credentials.
Authentication — OAuth 2.0
Obtain an access token using Client Credentials.
Explore Your Accounts
List accounts and retrieve balances.
Create a Counterparty
Register a payment destination with an external account.
Make Your First Payment
Create a SEPA Credit Transfer or cross-border payment.
Approvals
Approve or reject payments via API and dashboard.
Track Transactions
Retrieve transactions, balances, and simulate test data.
Webhooks — Real-Time Updates
Subscribe to events and verify webhook signatures.
Beyond the Basics
Direct debits, batch payments, idempotency, and more.