GET
/
v1
/
payouts
curl "https://api-eu.sulpayments.ch/v1/payouts?status=done&from=2026-04-01" \
  -H "Authorization: Bearer {token}"
{
  "payouts": [
    {
      "id": 1234,
      "partner_code": "PIX-001",
      "value": 1000.00,
      "fee": 1.50,
      "tax": 0.00,
      "payment_type": "pix",
      "kind": "personal",
      "total": 998.50,
      "status": "done",
      "fee_payer": "merchant",
      "claimed_at": "2026-04-15T10:00:00Z",
      "paid_at": "2026-04-15T10:00:05Z",
      "provider": "zrobank"
    }
  ],
  "total_pages": 5,
  "current_page": 1,
  "per_page": 30
}

Headers

Authorization
string
required
Bearer {token}

Query parameters

status
string
Filter by status (claimed, processing, done, error).
payment_type
string
payout_method
string
When set, returns platform payouts instead of merchant payouts.
from
string
ISO 8601
to
string
ISO 8601
sort
string
One of created_at, updated_at, paid_at.
direction
string
asc or desc.
page
integer
default:"1"
per_page
integer
default:"30"
Maximum 200.

Response

payouts
array
total_pages
integer
current_page
integer
per_page
integer
curl "https://api-eu.sulpayments.ch/v1/payouts?status=done&from=2026-04-01" \
  -H "Authorization: Bearer {token}"
{
  "payouts": [
    {
      "id": 1234,
      "partner_code": "PIX-001",
      "value": 1000.00,
      "fee": 1.50,
      "tax": 0.00,
      "payment_type": "pix",
      "kind": "personal",
      "total": 998.50,
      "status": "done",
      "fee_payer": "merchant",
      "claimed_at": "2026-04-15T10:00:00Z",
      "paid_at": "2026-04-15T10:00:05Z",
      "provider": "zrobank"
    }
  ],
  "total_pages": 5,
  "current_page": 1,
  "per_page": 30
}