Skip to main content
GET
/
v1
/
payments
List payments
curl --request GET \
  --url https://api.flowlix.dev/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E",
      "amount": 4999,
      "currency": "EUR",
      "status": "SUCCEEDED",
      "integration_type": "DIRECT",
      "amount_refunded": 0,
      "amount_refundable": 4999,
      "created_at": 1719792000,
      "livemode": false,
      "merchant_reference": "ord_1234",
      "description": "Order #1234",
      "card": {
        "brand": "visa",
        "last4": "1111",
        "exp_month": 12,
        "exp_year": 2027,
        "country": "DE"
      },
      "billing_details": {
        "email": "jenny@example.com",
        "first_name": "Jenny",
        "last_name": "Rosen",
        "phone": "+491701234567",
        "address": {
          "line1": "Kurfuerstendamm 21",
          "line2": "Apartment 4B",
          "city": "Berlin",
          "state": "Berlin",
          "postal_code": "10719",
          "country": "DE"
        }
      },
      "metadata": {
        "order_id": "ord_1234"
      },
      "decline_code": "insufficient_funds",
      "decline_message": "The card has insufficient funds.",
      "hosted_payment_url": "https://pay.flowlix.dev/hpp/pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E",
      "refunds": [],
      "status_transitions": {
        "requires_action_at": null,
        "processing_at": 1719792002,
        "succeeded_at": 1719792042,
        "failed_at": null,
        "canceled_at": null,
        "expired_at": null
      },
      "next_action": {
        "redirect_url": "<string>"
      }
    }
  ],
  "has_more": false
}

Authorizations

​
Authorization
string
header
required

Use your secret API key as the Bearer token. Test mode keys start with api_test_sk_ and live mode keys start with api_live_sk_. Both modes use the same API host; the mode is determined by the key.

Authorization: Bearer api_test_sk_abc123def456

Query Parameters

​
limit
integer
default:10

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

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

Cursor for forward pagination. Provide the id of the last payment in the previous page. Mutually exclusive with ending_before.

Unique opaque identifier for a payment (pay_ prefix + random alphanumeric suffix).

Pattern: ^pay_[A-Za-z0-9]{24}$
Example:

"pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

​
ending_before
string

Cursor for backward pagination. Provide the id of the first payment in the current page. Mutually exclusive with starting_after.

Unique opaque identifier for a payment (pay_ prefix + random alphanumeric suffix).

Pattern: ^pay_[A-Za-z0-9]{24}$
Example:

"pay_q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

​
status
enum<string>

Filter payments by status. Current status of a payment attempt.

  • PENDING -- The payment was accepted by Flowlix and is waiting to be processed.
  • REQUIRES_ACTION -- Customer action is required, usually 3D Secure authentication.
  • PROCESSING -- The payment is being processed by downstream payment systems.
  • SUCCEEDED -- The payment completed successfully.
  • FAILED -- The payment was declined or failed permanently.
  • CANCELED -- The payment was canceled before completion.
  • EXPIRED -- The customer did not complete a required action before its expiry time.
Available options:
PENDING,
REQUIRES_ACTION,
PROCESSING,
SUCCEEDED,
FAILED,
CANCELED,
EXPIRED
Example:

"SUCCEEDED"

​
created_gte
integer<int64>

Return payments created on or after this Unix timestamp in seconds.

​
created_lt
integer<int64>

Return payments created before this Unix timestamp in seconds.

Response

Matching payments, sorted newest first. An empty data array means no payments match the supplied filters.

Paginated list of payments.

​
data
object[]
required
​
has_more
boolean
required

Whether more payments are available after this page.

Example:

false