List Payments

List all payments with filtering and pagination

This endpoint retrieves a paginated list of payments. Use filters to narrow results by status, date range, amount, and more.

Authentication

This endpoint requires a valid API key with payments:read permissions.

Authorization: Bearer YOUR_API_KEY

Query Parameters

limit · integer

Number of items to return (default: 20, max: 100)

starting_after · string

Cursor for pagination (payment ID)

ending_before · string

Cursor for reverse pagination (payment ID)

status · string

Filter by status: “pending”, “processing”, “succeeded”, “failed”, “cancelled”

customer_id · string

Filter by customer ID

order_id · string

Filter by order ID

invoice_id · string

Filter by invoice ID

payment_method_type · string

Filter by payment method: “card”, “ach”, “wire”, “paypal”

created_from · string

Filter by creation date start (ISO 8601)

created_to · string

Filter by creation date end (ISO 8601)

amount_min · integer

Minimum amount in cents

amount_max · integer

Maximum amount in cents

currency · string

Filter by currency code

Response

object · string

Object type, always “list”

data · array

Array of payment objects

has_more · boolean

Whether more items exist

cURL

curl --location 'https://api.stateset.com/v1/payments?status=succeeded&limit=10' \
--header 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "object": "list",
  "data": [
    {
      "id": "pay_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "payment",
      "amount": 15000,
      "currency": "USD",
      "status": "succeeded",
      "created_at": "2024-01-19T15:30:00Z",
      "payment_method": {
        "type": "card",
        "card": {
          "last4": "4242",
          "brand": "visa"
        }
      },
      "customer_id": "cust_abc123",
      "order_id": "order_123456",
      "description": "Payment for Order #123456"
    },
    {
      "id": "pay_7823f083-bb2c-54d6-bf6d-1b8e3fc75f41",
      "object": "payment",
      "amount": 25000,
      "currency": "USD",
      "status": "succeeded",
      "created_at": "2024-01-19T12:15:00Z",
      "payment_method": {
        "type": "ach",
        "ach": {
          "last4": "6789",
          "bank_name": "Chase"
        }
      },
      "customer_id": "cust_def456",
      "invoice_id": "inv_789012",
      "description": "Invoice payment"
    }
  ],
  "has_more": true,
  "url": "/v1/payments"
}