curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/api/v1/payments' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"has_more": true,
"limit": 20,
"offset": 1,
"payments": [
{
"amount": "49.00",
"amount_refunded": "string",
"created_at": "2026-08-31T14:22:05Z",
"currency": "USD",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payment_method": "card",
"payment_number": "string",
"processor": "stripe",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
],
"total": 102
}
List payments
List of payments
GET
/
api
/
v1
/
payments
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/api/v1/payments' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"has_more": true,
"limit": 20,
"offset": 1,
"payments": [
{
"amount": "49.00",
"amount_refunded": "string",
"created_at": "2026-08-31T14:22:05Z",
"currency": "USD",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payment_method": "card",
"payment_number": "string",
"processor": "stripe",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
],
"total": 102
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Query parameters
integer (int32)
Maximum number of results to return (default: 50).
integer (int32)
Number of results to skip (default: 0).
string
Filter by order ID (UUID).
string
Filter by customer ID (UUID).
string
Filter by payment status (pending, authorized, captured, failed, refunded,
partially_refunded, voided).string
Filter by payment method (
credit_card, debit_card, bank_transfer, etc.).string
Filter by processor name.
string
Minimum payment amount.
string
Maximum payment amount.
string
Payments created on or after this date (RFC 3339).
string
Payments created on or before this date (RFC 3339).
Response
PaymentListResponse
boolean
required
integer (int32)
required
Minimum:
0.integer (int32)
required
Minimum:
0.PaymentResponse[]
required
integer
required
Minimum:
0.Status codes
| Code | Meaning |
|---|---|
200 | List of payments |
400 | Invalid filter parameter |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/api/v1/payments' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"has_more": true,
"limit": 20,
"offset": 1,
"payments": [
{
"amount": "49.00",
"amount_refunded": "string",
"created_at": "2026-08-31T14:22:05Z",
"currency": "USD",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payment_method": "card",
"payment_number": "string",
"processor": "stripe",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
],
"total": 102
}
Last modified on September 21, 2026