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

# Partner Payout API

> Send payouts directly to Quickei user wallets via API

Send payouts directly to Quickei user wallets from your platform.

## What is the Partner Payout API?

The Partner Payout API allows external platforms to send money directly into Quickei user wallets. It is designed for aggregators, remittance providers, payroll services, and any platform that needs to disburse funds programmatically.

<CardGroup cols={3}>
  <Card title="Instant Delivery" icon="bolt" color="#095367">
    Funds land in the recipient's Quickei wallet in seconds, ready to spend or withdraw.
  </Card>

  <Card title="Multi-Currency" icon="coins" color="#0891b2">
    Send in any currency supported by your merchant wallet. Cross-currency payouts are converted automatically.
  </Card>

  <Card title="Webhook Notifications" icon="webhook" color="#095367">
    Get real-time status updates for every payout via signed webhooks.
  </Card>
</CardGroup>

## Use Cases

| Scenario               | Description                                                         |
| ---------------------- | ------------------------------------------------------------------- |
| **Remittance**         | A remittance provider sends cross-border transfers to Quickei users |
| **Payroll**            | A payroll service disburses salaries into employee wallets          |
| **Aggregator**         | A marketplace pays out sellers after order fulfillment              |
| **Rewards / Cashback** | A loyalty platform credits user wallets with earned rewards         |

## Payout Flow

<Steps>
  <Step title="Lookup">
    Find the recipient by phone number or email using [`POST /lookup`](/partner-api/03-lookup). You receive a `lookup_token` valid for 10 minutes.
  </Step>

  <Step title="Quote">
    Get the exchange rate and fees for the payout using [`POST /quote`](/partner-api/04-quote). The quote is cached for 5 minutes.
  </Step>

  <Step title="Payout">
    Execute the payout using [`POST /payout`](/partner-api/05-payout). Your merchant wallet is debited and the user wallet is credited instantly.
  </Step>

  <Step title="Webhook">
    Quickei sends a signed webhook to your configured URL with the final payout status.
  </Step>
</Steps>

## Sandbox vs Production

|             | Sandbox                                     | Production                          |
| ----------- | ------------------------------------------- | ----------------------------------- |
| Base URL    | `https://quickei.io/api/partner/sandbox/v1` | `https://quickei.io/api/partner/v1` |
| Credentials | Sandbox API key from dashboard              | Production API key from dashboard   |
| Real money  | No                                          | Yes                                 |
| Header      | `X-Quickei-Environment: sandbox`            | `X-Quickei-Environment: production` |

<Note>
  Sandbox and production share the same base URL. The environment is determined by which API key you use. Sandbox payouts do not move real funds.
</Note>

## Prerequisites

1. A **Quickei Merchant account** with at least one funded wallet
2. **API credentials** generated from the Merchant Dashboard under **Developer API > API Keys**
3. **Partner Payout API** enabled by a Quickei admin (contact support if you don't see the option)

## Rate Limiting

The Partner Payout API allows **120 requests per minute**. If exceeded, you'll receive a `429 Too Many Requests` response with a `Retry-After` header.

## Available Endpoints

| Method | Endpoint                                 | Description                   |
| ------ | ---------------------------------------- | ----------------------------- |
| `POST` | [`/lookup`](/partner-api/03-lookup)      | Find a user by phone or email |
| `POST` | [`/quote`](/partner-api/04-quote)        | Get exchange rate and fees    |
| `POST` | [`/payout`](/partner-api/05-payout)      | Execute a payout              |
| `GET`  | [`/payout/{id}`](/partner-api/06-status) | Check payout status           |
| `GET`  | [`/balance`](/partner-api/07-balance)    | Get merchant wallet balances  |