Skip to main content
GET
/
payouts
List payout intents
curl --request GET \
  --url https://api.billing.io/v1/payouts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "po_1a2b3c4d5e",
      "org_id": "<string>",
      "recipient_address": "<string>",
      "amount": 123,
      "amount_atomic": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "reference_id": "<string>",
      "due_date": "2023-11-07T05:31:56Z",
      "approved_at": "2023-11-07T05:31:56Z",
      "approved_by": "<string>",
      "executed_at": "2023-11-07T05:31:56Z",
      "expected_tx_hash": "<string>",
      "verified_at": "2023-11-07T05:31:56Z",
      "failed_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "failure_reason": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}
List payout intents. Filter by status or due date range. 
curl "https://api.billing.io/v1/payouts?status=approved&limit=10" \
  -H "Authorization: Bearer $BILLING_API_KEY"

Authorizations

​
Authorization
string
header
required

Use your secret API key as a Bearer token. Keys are prefixed: sk_live_ (production) or sk_test_ (sandbox).

Query Parameters

​
cursor
string

Opaque cursor for pagination. Omit for the first page.

​
limit
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
​
status
enum<string>
  • draft — Payout intent created, awaiting approval
  • approved — Approved, ready for execution
  • pending_execution — Execution in progress
  • executed — Transaction submitted on-chain
  • verifying — Verifying on-chain confirmation
  • settled — On-chain settlement confirmed
  • failed — Payout failed
  • canceled — Payout was canceled
Available options:
draft,
approved,
pending_execution,
executed,
verifying,
settled,
failed,
canceled
​
due_date_before
string<date-time>

Filter payouts due before this date

​
due_date_after
string<date-time>

Filter payouts due after this date

Response

Payout intent list

​
data
object[]
​
has_more
boolean
​
next_cursor
string | null