Can I retrieve settlement or payout information via API?

Aghanim does not currently provide a dedicated public API for retrieving official settlement or payout data such as final payout amounts, balances, or settlement statements.

The official payout figures remain available in the dashboard, including Company USD Balance and Company Settings → Payouts.

What is available programmatically

If you want to automate internal accounting, BI, or reconciliation workflows, you can use transaction-level data from the following sources:

• GET /s2s/v1/payments for payment records, including amounts, fees, taxes, statuses, and dates.
• Order endpoints for order-level records.
• Webhooks such as order.paid, payment.*, and refund-related events for near real-time money-movement data.

Important caveat

Transaction-level data from the S2S API and webhooks is useful for building your own internal reporting pipeline, but it is not intended to reconcile 1:1 with official payout figures.

Official payouts are net figures that may reflect factors such as fees, FX, taxes, refunds, chargebacks, reserves, and payout period cutoffs. For that reason, the dashboard remains the source of truth for final settlement amounts.

How this relates to the transaction registry

A transaction registry downloaded for a specific payout is considered official. It is the transaction-level breakdown behind that specific payout.

This is different from pulling live transaction data through the S2S API or webhooks. Live API and webhook data can be used to build a close reconstruction for internal BI purposes, but it should not be treated as the official final payout source.

Recommended use

• Use the dashboard and payout-specific transaction registry for official payout confirmation.
• Use the S2S API and webhooks to automate internal BI, reporting, and reconciliation workflows.