Payments
List payments
Customers
Invoices
Wallets
Entitlements
Environments
Events
Features
Payments
Integrations
Subscriptions
Tenants
Users
Payments
List payments
List payments with the specified filter
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
Enter your API key in the format x-api-key <api-key>*
Query Parameters
Required range:
1 <= x <= 1000
Required range:
x >= 0
Available options:
asc
, desc
Available options:
published
, deleted
, archived
Response
200
application/json
OK
Available options:
INVOICE
Available options:
CARD
, ACH
, OFFLINE
, CREDITS
Available options:
PENDING
, PROCESSING
, SUCCEEDED
, FAILED
, REFUNDED
, PARTIALLY_REFUNDED
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
}
}