Payments

List payments

Changed on

Use when listing or searching payments (e.g. reconciliation UI or customer payment history). Returns a paginated list; supports filtering by customer, invoice, status.

get/payments

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/payments
  • Auth
    API key in header x-api-key

Query parameters

currencystring
destination_idstring
destination_typestring
end_timestring
expandstring
gateway_payment_idstring
gateway_tracking_idstring

For filtering by gateway tracking ID

limitinteger
offsetinteger
order'asc' | 'desc'
payment_gatewaystring
payment_idsstring[]
payment_method_typestring
payment_statusstring
sortstring
start_timestring
status'published' | 'deleted' | 'archived'

Response

Paginated payments

Changes

  • 50b7421a9690Revision changes
    • info

      added the optional property // to the response with the status

  • f8ecf435d25dRevision changes
    • warning

      added the new UPI enum value to the // response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status