GET
/
payments
curl --request GET \
  --url https://api.cloud.flexprice.io/v1/payments \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "amount": 123,
      "attempts": [
        {
          "attempt_number": 123,
          "created_at": "<string>",
          "created_by": "<string>",
          "error_message": "<string>",
          "id": "<string>",
          "metadata": {},
          "payment_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        }
      ],
      "created_at": "<string>",
      "created_by": "<string>",
      "currency": "<string>",
      "destination_id": "<string>",
      "destination_type": "INVOICE",
      "error_message": "<string>",
      "failed_at": "<string>",
      "id": "<string>",
      "idempotency_key": "<string>",
      "invoice_number": "<string>",
      "metadata": {},
      "payment_method_id": "<string>",
      "payment_method_type": "CARD",
      "payment_status": "PENDING",
      "refunded_at": "<string>",
      "succeeded_at": "<string>",
      "tenant_id": "<string>",
      "track_attempts": true,
      "updated_at": "<string>",
      "updated_by": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

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
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

200
application/json
OK
items
object[]
pagination
object