Skip to main content

Atlas Payment Service

The Atlas Payment Service provides programmatic payment creation, funds movements, real-time banking rails tracking, compliance document uploads, and regulatory purpose code discovery.

It supports enterprise multi-currency payouts to external bank accounts, wallet-to-business vendor disbursements, and internal transfers between corporate wallets.

flowchart TD
subgraph Client["Client Application"]
Init["1. Create Payment Request / Transfer"]
Upload["Optional: Request Pre-signed Upload Link"]
QueryCodes["Optional: Fetch Purpose Codes"]
end

subgraph AtlasPayment["Atlas Payment Service"]
Validator["Validation & Balance Check"]
Router{"Payment Type"}
TrackSvc["Payment Tracking Engine"]
end

subgraph Rails["Settlement Rails"]
Local["Local Clearing (SEPA / ACH / Faster Payments)"]
SWIFT["SWIFT MT103 / UETR Tracking"]
Internal["Ledger Internal Movement"]
end

Init --> Validator
Upload --> Validator
QueryCodes --> Validator
Validator --> Router
Router -->|WALLET_PAYOUT| Local
Router -->|WALLET_PAYOUT| SWIFT
Router -->|WALLET_TO_BUSINESS| Internal
Router -->|TRANSFER_WITHIN_WALLETS| Internal
Local --> TrackSvc
SWIFT --> TrackSvc
TrackSvc -.->|Status & Proof of Payment| Client

Key Features

  • Standardized Payment Types: Create WALLET_PAYOUT (to external beneficiary bank accounts), WALLET_TO_BUSINESS (to another business on the platform), and TRANSFER_WITHIN_WALLETS (between corporate currency wallets).
  • Settlement Tracking: Query SWIFT GPI tracking identifiers (uetr), SWIFT mt103 messages, clearing house references, and downloadable Proof of Payment (pop) documents.
  • Supporting Documents: Generate short-lived pre-signed S3 upload links (valid for 10 minutes, up to 5MB) for compliance invoices, contracts, and export declarations.
  • Purpose Code Resolution: Query required regulatory purpose codes per jurisdiction, payment direction (Inbound, Outbound, Cards), and currency (LOCAL or GLOBAL).
  • Idempotency & Anti-Duplication: Pass paymentId or externalUniqueRef to prevent duplicate ledger debits.

Payment Types Comparison

Payment TypeSourceDestinationKey FieldsCommon Use Case
WALLET_PAYOUTSource WalletExternal Bank Account (targetAccountId)sourceWalletId, sourceAmount, targetAccountId, purposeIdSupplier payout, contractor disbursement, employee payroll
WALLET_TO_BUSINESSSource WalletPlatform Company (targetCompanyId)sourceWalletId, sourceAmount, targetCompanyId, purposeIdB2B invoice settlement between platform sub-companies
TRANSFER_WITHIN_WALLETSSource WalletOwned Wallet (targetWalletId)sourceWalletId, sourceAmount, targetWalletIdTreasury liquidity rebalancing, inter-wallet sweeping

Available Endpoints

EndpointMethodOperation IDDescription
/payments/createPOSTcreate_payment_requestCreate a standardized payment request (WALLET_PAYOUT, WALLET_TO_BUSINESS, TRANSFER_WITHIN_WALLETS)
/transferPOSTtransfer_to_another_walletInitiate a direct transfer to another wallet or business
/payments/{paymentId}GETget_payment_by_payment_idRetrieve comprehensive payment record details by payment ID
/payments/payment-tracking/{reference}GETget_payment_tracking_detailQuery tracking details (mt103, uetr, Proof of Payment)
/documents/generate-upload-linkPOSTgenerate_link_to_upload_fileGenerate a 10-minute secure pre-signed link for document uploads
/payments/purpose-codesGETlist_payment_purpose_codes_v2List compliance and regulatory purpose codes for payment routes

Authentication

All endpoints require a valid JWT Bearer access token obtained via the Atlas Login endpoint:

Authorization: Bearer <your_jwt_access_token>