Sign in
Payouts

List payouts

Changed on

List payouts of the business's available balance to its linked bank account, newest first. This is settlement to your own bank account, not send-money transfers to third parties.

get/v1/payouts

Request

  • Base URL: https://api.hit-pay.com
  • URL: https://api.hit-pay.com/v1/payouts
  • Auth: none declared. Required headers: X-BUSINESS-API-KEY

Query parameters

status'scheduled' | 'processing' | 'paid' | 'failed' | 'canceled' | 'pending'

Filter by the public payout status returned in the payload.

created_at_fromstring date
Example:2026-09-01

Include payouts created on or after this date (YYYY-MM-DD, business timezone).

created_at_tostring date
Example:2026-09-17

Include payouts created on or before this date (YYYY-MM-DD, business timezone).

per_pageinteger
cursorstring

The cursor parameter accepts a next_cursor value obtained from the previous response's meta object (meta.next_cursor).

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

Paginated list of payouts

Example response

{
  "data": [
    {
      "currency": "sgd",
      "source_currency": "sgd"
    }
  ],
  "meta": {
    "per_page": 25
  }
}

Changes