List Payouts

Retrieve a list of payouts with optional filtering.

POSThttps://api.uprails.com/payouts/list

Returns a list of payouts. The payouts are returned sorted by creation date, with the most recent payouts appearing first.

Request Example

curl -X POST https://api.uprails.com/payouts/list \
  -H "Content-Type: application/json" \
  -H "api-key: snd_YOUR_API_KEY" \
  -d '{
    "limit": 10,
    "status": "success"
  }'

Request Body

limitintegerdefault: 10

Number of payouts to return (max: 100)

offsetintegerdefault: 0

Number of payouts to skip

statusstring

Filter payouts by status

Enum:requires_creationrequires_fulfillmentpendingsuccessfailedcancelledreversedexpired

payout_typestring

Filter by payout type

Enum:cardbankwallet

customer_idstring

Filter payouts by customer ID

created_gtestring

Filter payouts created after this timestamp (ISO 8601)

created_ltestring

Filter payouts created before this timestamp (ISO 8601)

Response

200OK

{
  "data": [
    {
      "payout_id": "po_1234567890abcdef",
      "merchant_id": "mer_xyz789",
      "customer_id": "cus_abc123",
      "status": "success",
      "amount": 10000,
      "currency": "USD",
      "payout_type": "bank",
      "created": "2024-01-15T10:00:00Z"
    },
    {
      "payout_id": "po_0987654321fedcba",
      "merchant_id": "mer_xyz789",
      "customer_id": "cus_def456",
      "status": "pending",
      "amount": 5000,
      "currency": "USD",
      "payout_type": "card",
      "created": "2024-01-14T08:00:00Z"
    }
  ],
  "total_count": 50,
  "has_more": true
}