Skip to main content
GET
/
payments
List payments
curl --request GET \
  --url https://us.api.flexprice.io/v1/payments \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "amount": "<string>",
      "attempts": [
        {
          "attempt_number": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "error_message": "<string>",
          "id": "<string>",
          "metadata": {},
          "payment_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "currency": "<string>",
      "destination_id": "<string>",
      "error_message": "<string>",
      "failed_at": "2023-11-07T05:31:56Z",
      "gateway_metadata": {},
      "gateway_payment_id": "<string>",
      "gateway_tracking_id": "<string>",
      "id": "<string>",
      "idempotency_key": "<string>",
      "invoice_number": "<string>",
      "metadata": {},
      "payment_gateway": "<string>",
      "payment_method_id": "<string>",
      "payment_url": "<string>",
      "refunded_at": "2023-11-07T05:31:56Z",
      "save_card_and_make_default": true,
      "succeeded_at": "2023-11-07T05:31:56Z",
      "tenant_id": "<string>",
      "track_attempts": true,
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Query Parameters

​
currency
string
​
destination_id
string
​
destination_type
string
​
end_time
string
​
expand
string
​
gateway_payment_id
string
​
gateway_tracking_id
string

For filtering by gateway tracking ID

​
limit
integer
Required range: 1 <= x <= 1000
​
offset
integer
Required range: x >= 0
​
order
enum<string>
Available options:
asc,
desc
​
payment_gateway
string
​
payment_ids
string[]
​
payment_method_type
string
​
payment_status
string
​
sort
string
​
start_time
string
​
status
enum<string>
Available options:
published,
deleted,
archived

Response

Paginated payments

​
items
object[]
​
pagination
object