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

# Getting Paid

> How and when affiliate payouts are processed.

## Payout Process

Once your approved commissions reach the payout threshold, the merchant can create a payout in AgentRef, send the money externally, and mark the payout status as it progresses.

Today this is a manual merchant workflow. AgentRef tracks payout state and payout details, but does not automatically send affiliate funds.

### How It Works

<Steps>
  <Step title="Commissions accumulate">
    As your referrals convert, commissions move from `pending` → `approved`.
  </Step>

  <Step title="Threshold reached">
    When your approved balance reaches the program's payout threshold (default: \$50), you become payout-eligible.
  </Step>

  <Step title="Payout processed">
    The merchant creates a payout record, sends the money outside AgentRef (for example via PayPal or bank transfer), and records the status in AgentRef.
  </Step>

  <Step title="Money arrives">
    Once the merchant marks the payout as completed, it appears in your payout history. Arrival time depends on the external payment provider.
  </Step>
</Steps>

## Setting Your Payout Details

To receive payouts smoothly, add your payout details in AgentRef:

1. Go to **Settings → Payouts** in your affiliate dashboard
2. Choose your payout method: `paypal` or `bank_transfer`
3. Enter the required payout details
4. Save the profile so merchants can pay you correctly

<Warning>
  Merchants may hold payouts until your payout details are complete. Add them before your first payout becomes due.
</Warning>

## Payout Schedule

| Setting          | Default                 |
| ---------------- | ----------------------- |
| Payout threshold | \$50 USD                |
| Processing time  | Merchant-defined        |
| Payment method   | PayPal or bank transfer |

The merchant can configure the payout threshold per program.

## Viewing Payout History

### Dashboard

Your dashboard shows all payouts with status, amount, and date.

### Via API

Use `GET /me/payout-info` to check the payout method on file and `GET /me/payouts` to review payout history.

<CodeGroup>
  ```javascript Node.js theme={null}
  const headers = {
    Authorization: 'Bearer ak_aff_YOUR_KEY',
  };

  const payoutInfo = await fetch('https://www.agentref.co/api/v1/me/payout-info', { headers }).then((r) => r.json());
  const payouts = await fetch('https://www.agentref.co/api/v1/me/payouts', { headers }).then((r) => r.json());
  ```

  ```python Python theme={null}
  import httpx

  headers = {"Authorization": "Bearer ak_aff_YOUR_KEY"}

  payout_info = httpx.get("https://www.agentref.co/api/v1/me/payout-info", headers=headers).json()
  payouts = httpx.get("https://www.agentref.co/api/v1/me/payouts", headers=headers).json()
  ```

  ```bash cURL theme={null}
  curl "https://www.agentref.co/api/v1/me/payout-info" \
    -H "Authorization: Bearer ak_aff_YOUR_KEY"

  curl "https://www.agentref.co/api/v1/me/payouts" \
    -H "Authorization: Bearer ak_aff_YOUR_KEY"
  ```
</CodeGroup>

## Payout Statuses

| Status       | Meaning                                            |
| ------------ | -------------------------------------------------- |
| `pending`    | Payout created, waiting to be processed            |
| `processing` | Merchant started the external payment step         |
| `completed`  | Merchant confirmed the payout as paid              |
| `failed`     | External payment attempt failed and can be retried |

## Common Issues

<Accordion title="My payout failed">
  The most common reasons are incomplete payout details or a failed external payment attempt. Go to **Settings → Payouts** and confirm your PayPal or bank transfer details are correct.
</Accordion>

<Accordion title="I haven't received a payout yet">
  Check if your approved balance has reached the payout threshold. Also confirm your payout profile is complete and ask the merchant which payout cadence they use.
</Accordion>

<Accordion title="A commission was deducted from my payout">
  If a customer requested a refund, the associated commission is reversed. Refunds on already-paid commissions are deducted from your next payout.
</Accordion>