Skip to main content
GET
/
v1
/
payments
List payments
curl --request GET \
  --url https://api.flowlix.dev/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "pay_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "object": "payment",
      "amount": 4999,
      "currency": "eur",
      "status": "succeeded",
      "description": "Order #1234",
      "card": {
        "brand": "visa",
        "last4": "1111",
        "exp_month": 12,
        "exp_year": 2027,
        "country": "US"
      },
      "customer": {
        "email": "jenny@example.com",
        "name": "Jenny Rosen"
      },
      "metadata": {
        "order_id": "ord_1234",
        "sku": "WIDGET-XL"
      },
      "decline_code": null,
      "decline_message": null,
      "redirect_url": null,
      "refunded_at": null,
      "succeeded_at": 1719792000,
      "failed_at": null,
      "created": 1719792000,
      "livemode": false,
      "refunded_amount": 0,
      "refunds": [],
      "next_action": null
    },
    {
      "id": "pay_b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "object": "payment",
      "amount": 1500,
      "currency": "eur",
      "status": "pending",
      "description": "Order #1235",
      "card": {
        "brand": null,
        "last4": "0002",
        "exp_month": null,
        "exp_year": null,
        "country": null
      },
      "customer": {
        "email": "alex@example.com",
        "name": "Alex Johnson"
      },
      "metadata": {},
      "decline_code": null,
      "decline_message": null,
      "redirect_url": null,
      "refunded_at": null,
      "succeeded_at": null,
      "failed_at": null,
      "created": 1719791000,
      "livemode": false,
      "refunded_amount": 0,
      "refunds": [],
      "next_action": null
    }
  ],
  "has_more": false,
  "url": "/v1/payments"
}

Authorizations

​
Authorization
string
header
required

Use your secret API key as the Bearer token. Test (sandbox) mode keys start with fl_test_sk_ and live mode keys start with fl_live_sk_. Both modes use the same API host; the mode is determined by the key.

Authorization: Bearer fl_test_sk_abc123def456

Query Parameters

​
limit
integer
default:10

Maximum number of payments to return. Accepts values between 1 and 100. Defaults to 10.

Required range: 1 <= x <= 100
​
starting_after
string

A cursor for forward pagination. Provide the id of the last payment in the previous page to fetch the next page of results. Must be a full payment ID returned by a prior list response.

Pattern: ^pay_[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
​
status
enum<string>

Filter payments by status.

Available options:
pending,
succeeded,
failed,
requires_action,
expired,
canceled
​
created[gte]
integer<int64>

Return payments created on or after this timestamp (inclusive), expressed as a Unix epoch in seconds.

​
created[lt]
integer<int64>

Return payments created before this timestamp (exclusive), expressed as a Unix epoch in seconds.

Response

A paginated list of payments.

A paginated list of Payment objects.

​
object
enum<string>

Object type; always list.

Available options:
list
Example:

"list"

​
data
object[]

An array of payment objects.

​
has_more
boolean

Whether there are additional results beyond this page. If true, use the id of the last item in data as the starting_after cursor to fetch the next page.

Example:

true

​
url
string

The URL for this list endpoint.

Example:

"/v1/payments"