Skip to content

List Payments​

GET
/bridge-payment/payments

Get a paginated list of payments with detailed information. Authenticated users see their own payments. Guest users with token see payments filtered by their email. Use the include parameter to fetch related data like payment method details for better performance and smaller responses.

Authorizations​

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)
or
GuestToken

Guest token for anonymous checkout

TypeAPI Key (query: token)

Parameters​

Query Parameters

page

Page number for pagination

Typeinteger
Minimum1
Default1
limit

Number of items per page (max 50)

Typeinteger
Minimum1
Maximum50
Default20
status

Filter by payment status

Typestring
Valid values
"pending""processing""succeeded""failed""canceled"
search

Search by payment ID, email, or description

Typestring
created_at_from

Filter payments created after this date

Typestring
Format"date-time"
created_at_to

Filter payments created before this date

Typestring
Format"date-time"
orderBy

Field to order by

Typestring
Valid values
"created_at""amount_cents""status""updated_at"
Default"created_at"
orderDir

Order direction

Typestring
Valid values
"asc""desc"
Default"desc"
include

Comma-separated list of related resources to include in the response. Available options: payment_method (includes card brand, last 4 digits, expiry date, wallet type, etc.). Example: ?include=payment_method. Performance: This parameter improves API efficiency by only fetching related data when explicitly requested, reducing response size and query time when payment method details are not needed.

Typestring
Example"payment_method"
token

Guest token for accessing guest payments

Typestring

Responses​

List of payments retrieved successfully

application/json
JSON
{
"success": true,
"data": [
{
"id": "pay_1234567890",
"subtotal_cents": 5000,
"tax_cents": 500,
"discount_cents": 0,
"total_cents": 5500,
"amount_cents": 5500,
"currency": "USD",
"status": "succeeded",
"description": "Monthly subscription payment",
"concept": "Product Purchase",
"reference_code": "ORD-2024-001",
"category": "subscription",
"tags": "premium,monthly",
"provider_id": "stripe",
"payment_method_id": "pm_1234567890",
"payment_method": {
"id": "pm_1234567890",
"payment_type": "card",
"wallet_type": "apple_pay",
"card_brand": "visa",
"last_four": "4242",
"expiry_month": "12",
"expiry_year": "2025",
"alias": "My Visa Card"
},
"is_guest_payment": false,
"guest_email": "[email protected]",
"created_at": "string",
"updated_at": "string",
"completed_at": "string"
}
],
"meta": {
"page": 1,
"limit": 20,
"total": 45,
"hasMore": true,
"orderBy": "created_at",
"orderDir": "desc"
},
"user_context": {
"authenticated": true,
"user_id": "usr_123",
"user_type": "customer",
"user_email": "[email protected]",
"search_method": "user_id"
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI