Tracking Transactions

Send deposit and withdrawal events to Atlas for financial analytics, risk monitoring, and AML compliance.

All API requests require an API Key passed via the X-API-Key header. Obtain yours at Dashboard → Settings → API Keys.

X-API-Key: your_api_key_here

Event Types

Transaction events are sent to POST /api/v1/transaction. The Kafka topic is fixed: atlas.events.raw.transaction.

Event	Description
deposit	Player adds funds to their account
withdraw	Player requests a payout

Track a Deposit

cURL

curl -X POST https://events.atlas.io/api/v1/transaction \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "org_id": "org_abc123",
    "brand_id": "brand_xyz",
    "event": "deposit",
    "user_id": "user_12345",
    "transaction_id": "txn_deposit_9876",
    "transaction_dt": "2026-03-11T14:30:00Z",
    "amount": 200.00,
    "currency": "BRL",
    "payment_method": "PIX",
    "payment_provider": "PICPAY",
    "bonus_credited": false,
    "bonus_code": "",
    "kyc_verified": true,
    "status": "APPROVED",
    "is_first_transaction": true,
    "before_balance": 0.00,
    "after_balance": 200.00
  }'

Track a Withdrawal

cURL

curl -X POST https://events.atlas.io/api/v1/transaction \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "org_id": "org_abc123",
    "brand_id": "brand_xyz",
    "event": "withdraw",
    "user_id": "user_12345",
    "transaction_id": "txn_withdraw_5432",
    "transaction_dt": "2026-03-11T18:00:00Z",
    "amount": 500.00,
    "currency": "BRL",
    "payment_method": "TED",
    "payment_provider": "BANK",
    "bonus_credited": false,
    "bonus_code": "",
    "kyc_verified": true,
    "status": "REQUESTED",
    "before_balance": 750.00,
    "after_balance": 250.00
  }'

Request Fields

Envelope Fields (all events)

org_id · string · required

Organization identifier.

brand_id · string · required

Brand identifier.

event · string · required

Event type: deposit or withdraw.

ip · string

Player IP address at transaction time.

geolocation_lat · number

Player latitude at transaction time.

geolocation_long · number

Player longitude at transaction time.

is_test · boolean

Marks the event as operator test traffic. When true, the event is accepted (202) but rerouted to an audit-only store — it never appears in analytics, dashboards or risk scoring. Defaults to false when omitted.

Transaction Fields

user_id · string · required

Your internal user identifier. Must be consistent across all events for the same player.

transaction_id · string · required

Your internal transaction identifier. Must be unique per transaction. Used for deduplication.

transaction_dt · string · required

ISO 8601 timestamp when the transaction happened.

amount · number · required

Transaction amount. Positive for deposits and withdrawals.

status · string · required

Transaction status: RECEIVED, APPROVED, REQUESTED, PENDING, UNDER_REVIEW, DENIED.

currency · string

ISO 4217 currency code (e.g., BRL, USD, EUR).

payment_method · string

Payment method used in the transaction (e.g., PIX, TED, CARD).

payment_provider · string

Payment provider/acquirer used to process the transaction.

bonus_credited · boolean

Indicates whether a bonus was credited together with the transaction.

bonus_code · string

Bonus campaign code applied to the transaction, when applicable.

kyc_verified · boolean

Indicates whether user KYC was verified at transaction time.

is_first_transaction · boolean

Indicates if this is the user’s first financial transaction.

before_balance · number

Player balance immediately before the transaction. Used for balance reconciliation.

after_balance · number

Player balance immediately after the transaction. Used for balance reconciliation.

AML Considerations

Transaction events feed directly into Atlas’s PLD (Anti-Money Laundering) engine.

For compliance purposes, always include:

• transaction_id — for transaction-level audit trails
• before_balance and after_balance — for reconciliation reports
• transaction_dt — actual transaction time, not ingestion time

→ See PLD Compliance Guide for AML monitoring configuration.

Batch Transactions

curl -X POST https://events.atlas.io/api/v1/transaction/batch \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      {
        "org_id": "org_abc123",
        "brand_id": "brand_xyz",
        "event": "deposit",
        "user_id": "user_001",
        "transaction_id": "txn_001",
        "transaction_dt": "2026-03-11T14:00:00Z",
        "amount": 100.00,
        "status": "APPROVED"
      }
    ]
  }'