> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useadmesh.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Payouts

> Set up your bank details, understand payout balances, and track your platform's payments.

AdMesh sends approved monthly payouts through Airwallex to your payout account.
Use the dashboard to complete your payout setup and track payments.

## Set up payouts

<Steps>
  <Step title="Open your payout dashboard">
    Sign in with your platform account and open
    [Payouts](https://useadmesh.com/dashboard/agent/payouts).
    Complete [platform onboarding](/platforms/overview) if you have not already.
  </Step>

  <Step title="Add your bank details">
    Complete the Airwallex beneficiary form shown during setup. If you have
    already set up payouts, use **Bank Details** to review or update the account.

    Provide the beneficiary and bank information requested for your selected
    country and account currency. Review the account, routing, and currency
    details before confirming and saving the form.
  </Step>

  <Step title="Resolve any setup requirements">
    Check your payout setup status after saving. Complete any missing fields or
    pending verification shown in the dashboard.

    If the dashboard shows a payout hold or another blocked reason, contact
    [support@useadmesh.com](mailto:support@useadmesh.com) for help.
  </Step>

  <Step title="Review balances and statements">
    Review your pending, available, locked, and paid balances. Check statements
    and payment history for the payout amount, status, and transfer details.

    Payouts require eligible earnings, completed recipient setup, the applicable
    minimum payout amount, and monthly payout approval. Available earnings do
    not mean a bank transfer has already been sent.
  </Step>
</Steps>

## Understand your balances

| Balance | Meaning |
| - | - |
| Pending | Recorded earnings that are not yet available for payout. |
| Available | Settled earnings available for payout consideration. |
| Locked | Earnings reserved for a payout statement, including amounts held in blocked or failed payout processing. |
| Paid Out | Earnings recorded as paid. Check the transfer details for the associated payment. |

<Note>
  [Reporting API earnings](/platforms/reporting) can include unsettled performance
  amounts. Payout balances follow the earnings ledger and settlement process,
  so they can differ from the reporting API totals.
</Note>

## Track a payout

Review the statement and its associated transfer when checking a payment:

| Statement status | What it means |
| - | - |
| `LOCKED` | Earnings have been reserved for payout processing; this does not confirm payment. |
| `BLOCKED` | A payout requirement or hold needs attention. Read the blocked reason. |
| `FAILED` | Payout processing failed. Review the failure details and contact support. |
| `PAID` | The payout is recorded as paid. Review the transfer reference and settlement details. |

The transfer currency may differ from the USD earnings currency. Use the transfer
details for the amount the beneficiary receives, applicable fees, and exchange
rate when provided. Timing depends on approval, recipient readiness, and transfer
processing; use the dashboard status to follow your payment.

## Read payout information through the API

Payout endpoints require your signed-in platform account's **Firebase ID token**
with the `agent` role. They do not accept the platform API key used by
`GET /agent/reporting`.

```bash theme={null}
curl --fail-with-body --request GET \
  'https://api.useadmesh.com/agent-payouts/me/statements?page=1&page_size=10' \
  --header 'Authorization: Bearer YOUR_FIREBASE_ID_TOKEN'
```

| Endpoint | Information returned |
| - | - |
| `GET /agent-payouts/me/balance` | Payout balance snapshot by currency. |
| `GET /agent-payouts/me/readiness` | Setup status, missing fields, payout thresholds, and blocked reason. |
| `GET /agent-payouts/me/overview` | Balances, readiness, latest statement, and recent statements. |
| `GET /agent-payouts/me/statements` | Statements with `page`, `page_size` (1–100), and optional `status` filtering. |
| `GET /agent-payouts/me/statements/{statement_id}` | One of your statements and its associated transfer. |
| `GET /agent-payouts/me/history` | Locked, blocked, failed, and paid statements, with `page` and `page_size` pagination. |

Balance fields ending in `_micros` use one million units per major currency unit.
For USD, `12500000` micros represents **\$12.50**. Statement money fields include
gross earnings, the AdMesh fee, and net earnings where provided.

## Troubleshooting

* **Setup incomplete:** complete onboarding and the bank details form, then check
  the setup status again.
* **Pending earnings:** wait for settlement; performance earnings are not all
  immediately eligible for payout.
* **Below the payout minimum:** check the applicable threshold in payout readiness.
  Meeting the threshold does not bypass other payout requirements.
* **Blocked or failed payout:** check the reason and confirm your bank details.
  Contact support for retry or resolution.
* **API authentication error:** sign in again to obtain a valid Firebase ID token
  and confirm that you are using your platform account.

Need help? Contact [support@useadmesh.com](mailto:support@useadmesh.com).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.