Payouts
A Payout moves a settled batch of your own sales to the bank account on file for your business. Payouts are normally automatic; this API lets you trigger the funding transfer for a settlement that is approved but not yet funded, and list past payouts. The destination is the payout bank account configured in the dashboard (Settings → Payouts); it cannot be set or changed through the API. HL Hunt has no API for sending money to third-party recipients, cards or wallets — the Bank Payouts and Card Payouts pages that older sidebars linked to described a product that does not exist and have been removed.
/v1/payoutsCreate a Payout
Pay out an approved settlement to your payout bank account. Secret key.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| amount | integer | required | Must be a positive integer, but it is not used: a payout always moves the settlement's full net amount, which is what the response reports. |
| settlement_id | string | optional | HL Hunt settlement id to pay out. Omit to pay out the latest approved settlement. |
| method | string | optional | "standard" (ACH, default). "instant" is accepted but currently always fails with payout_failed because instant payouts need a debit card on file and none can be added yet. |
| description | string | optional | Stored on the payout. |
Response
| Field | Type | Description |
|---|---|---|
| id | string | Payout id. |
| object | string | "payout". |
| amount | integer | Cents sent (the settlement's net amount). |
| currency | string | Lower-case, e.g. "usd". |
| status | string | pending, processing, succeeded, failed or canceled. |
| method | string | "standard" or "instant". |
| arrival_date | string | null | Set when the bank confirms arrival. |
| description | string | null | As sent. |
| bank_name | string | null | Name on the destination bank account. |
| bank_account_last4 | string | null | Last four digits of the destination account. |
| failure_reason | string | null | Why a failed payout failed, e.g. no payout bank on file, bank disabled, or the processor's message. |
| created | string | ISO 8601. |
- HTTP 201. 400 missing_required_param (amount) · 400 payout_failed with a message: Settlement not found; No approved settlements available for payout; This settlement has already been funded; Instant payouts require a debit card on file; the payout bank is missing, unverified or disabled · 403 tenant_ownership_denied · 409 no_active_merchant · 401 invalid_api_key_prefix.
- Emits payout.created. There is no payout.paid event; poll GET /v1/payouts for status changes.
curl -X POST https://api.hlhunt.org/v1/payouts \
-H "Authorization: Bearer sk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{ "amount": 1, "settlement_id": "stl_xxxxxxxxxxxx", "description": "Weekly payout" }'/v1/payoutsList Payouts
Payouts for the key's business, including automatic ones.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| status | string (query) | optional | pending, processing, succeeded, failed or canceled. |
| limit | integer (query) | optional | 1–100, default 25. |
Response
| Field | Type | Description |
|---|---|---|
| object | string | "list". |
| data | array | Payout objects (same fields as the create response). |
| has_more | boolean | true when the page is full. |
| total | integer | Total payouts. |
curl -X GET "https://api.hlhunt.org/v1/payouts?status=succeeded&limit=20" \
-H "Authorization: Bearer sk_live_your_api_key"Endpoints
/v1/payouts/v1/payoutsCreate a Payout
curl -X POST https://api.hlhunt.org/v1/payouts \
-H "Authorization: Bearer sk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{ "amount": 1, "settlement_id": "stl_xxxxxxxxxxxx", "description": "Weekly payout" }'List Payouts
curl -X GET "https://api.hlhunt.org/v1/payouts?status=succeeded&limit=20" \
-H "Authorization: Bearer sk_live_your_api_key"