Skip to main content
GET
/
v1
/
payouts
List payouts
curl --request GET \
  --url https://api.antonpayments.com/v1/payouts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "pay_abc123",
      "merchant_id": "<string>",
      "payee_id": "<string>",
      "instrument_id": "<string>",
      "batch_id": "<string>",
      "status": "created",
      "method": "<string>",
      "source_amount": "<string>",
      "source_currency": "<string>",
      "dest_amount": "<string>",
      "dest_currency": "<string>",
      "exchange_rate": "<string>",
      "fee": "<string>",
      "fee_currency": "<string>",
      "fee_bearer": "merchant",
      "fixed_side": "fixed_source",
      "total_debited": "<string>",
      "total_debited_currency": "<string>",
      "rail_type": "<string>",
      "rail_provider": "<string>",
      "rail_reference": "<string>",
      "network": "<string>",
      "wallet_address": "<string>",
      "tx_hash": "<string>",
      "cancelled_reason": "<string>",
      "purpose": "<string>",
      "reference": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "screened_at": "2023-11-07T05:31:56Z",
      "approved_at": "2023-11-07T05:31:56Z",
      "processed_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "failed_at": "2023-11-07T05:31:56Z",
      "cancelled_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Merchant API key: ak_live_* (production) or ak_test_* (sandbox).

Query Parameters

​
limit
integer
default:20

Maximum number of items to return (default 20, max 100).

Required range: x <= 100
​
cursor
string

Pagination cursor from previous response's next_cursor.

​
status
enum<string>

Filter by payout status.

Available options:
created,
pending_screening,
screening_failed,
pending_approval,
approved,
processing,
sent,
completed,
failed,
returned,
cancelled,
manual_review,
velocity_blocked
​
beneficiary_id
string

Filter by payee ID.

​
source_currency
string

Filter by source currency code.

​
reference
string

Filter by merchant reference.

Response

Paginated list of payouts.

​
data
object[]
required
​
has_more
boolean
required
​
next_cursor
string