The Atlar connector polls an Atlar workspace and surfaces accounts, counterparties (external accounts), and transactions. Atlar's transactional model is bank-rail flat (SEPA, BACS, ACH), so the connector uses one shared shape across rails.
Prerequisites#
You need an Atlar workspace and a pair of HMAC credentials (accessKey + secret). Atlar signs every request with HMAC-SHA256; the connector signs internally — you only supply the credentials.
Make sure to create an API key dedicated to Formance. Doing so will improve your auditability and security and will allow you to revoke access to Formance at any time if needed.
Installation#
curl -X POST $FORMANCE_API_URL/api/payments/v3/connectors/install/atlar \
-H "Content-Type: application/json" \
-d @config.jsonConfiguration fields#
| Field | Type | Required | Default |
|---|---|---|---|
accessKey | string | Yes | |
baseUrl | string | Yes | |
pageSize | integer | No | 25 |
pollingPeriod | string | No | 30m |
secret | string | Yes |
baseUrl defaults to https://api.atlar.com; override only when Atlar provisions you against a dedicated sandbox or staging URL.
Capabilities#
FETCH_ACCOUNTS— internal accounts via/v1/accounts.FETCH_EXTERNAL_ACCOUNTS— counterparties via/v1/counterparties.FETCH_PAYMENTS—/v1/transactions, classified as PAY-IN / PAYOUT / TRANSFER by direction.FETCH_OTHERS—external-payments(incoming SCT/SDD instructions awaiting reconciliation), surfaced under theexternal-paymentcollection onv3ListPaymentsOther.
Outbound transfer/payout initiation, bank-account creation, and webhooks are not exposed on the Atlar API surface this connector reaches.
Account model#
Every Connectivity internal account is one Atlar /v1/accounts row. The reference is the Atlar account ID; name is the account name; defaultAsset is the account currency at ISO 4217 precision. EXTERNAL accounts come from /v1/counterparties. Metadata stamps the underlying bank/id, bank/name, bank/bic, IBAN and other identifiers per market+type, plus alias, owner/name, and the fictive flag. See Accounts for the cross-connector model.
Asset model#
Uppercase ISO 4217 (EUR, GBP, USD), formatted to UMN at standard precision. Amounts are already in minor units — no scaling.
Status mapping#
Atlar transaction status | Payment status |
|---|---|
INITIATED, PENDING, SUBMITTED, INFLIGHT | PENDING |
EXECUTED, REGISTERED, RECONCILED | SUCCEEDED |
FAILED, REJECTED | FAILED |
CANCELLED | CANCELLED |
| anything else | UNKNOWN |
Metadata keys#
Under com.atlar.spec/:
- Account:
account_id,bank_iban,bank_bic,account_type,currency_code. - External account:
counterparty_id,name,account_number,routing_number,bic,country. - Payment:
transaction_id,transaction_type,bank_reference,remittance_information_unstructured,direction.
Workflow tree#
FetchAccounts (periodic)
└── FetchPayments (periodic) — per account
FetchExternalAccounts (periodic)
FetchOthers (periodic) — external-payments awaiting reconciliationKnown gaps#
- Balances are not exposed — Atlar's
/v1/accountspayload doesn't carry a real-time balance. - Outbound initiation (
CreateTransfer/CreatePayout) is not implemented; Atlar's payment-initiation API requires payment-plan scaffolding without a Connectivity-side model. - Webhooks are not wired; reconciliation runs on the polling cycle.