> ## Documentation Index > Fetch the complete documentation index at: https://docs.zbx.boomfi.xyz/llms.txt > Use this file to discover all available pages before exploring further. # List Payments > List payments with optional filters for invoice, customer, method, status, paylink, and plan. ## OpenAPI ````yaml /openapi.yaml get /payments openapi: 3.1.0 info: contact: email: support@boomfi.xyz name: API Support description: >- The BoomFi Merchants API provides a set of endpoints for merchants to manage their accounts, transactions, and more. Hosts differ per brand/environment; use the brand-specific base URL from the docs. title: ZBX Merchants API version: '1.0' servers: - url: https://mapi.zbx.boomfi.xyz/v1 description: Production security: [] tags: - description: Payment links name: Paylinks - description: Billing plans name: Plans - description: Subscriptions name: Subscriptions - description: Customer records name: Customers - description: Invoices name: Invoices - description: Payments name: Payments - description: Organisation events name: Events - description: Organisation profile and display settings name: Organisation - description: Webhook and request-signing secrets name: Secrets - description: Settlement accounts name: Accounts - name: Bank Address Book - description: Managed virtual accounts, balances, pay-in, and payout name: Virtual Accounts - description: Partner-managed accounts, virtual accounts, pay-in, and payout name: Partners - description: Partner virtual account automations and run history name: Partner Automations - description: Partner maintain-balance automations name: Partner Balance Monitoring - description: Tradeable currencies, instruments, and swap targets name: Instruments - description: RFQ quotes name: Quotes - description: RFQ orders and one-click trades name: Orders - description: Executed trades name: Trades paths: /payments: get: tags: - Payments summary: List Payments description: >- List payments with optional filters for invoice, customer, method, status, paylink, and plan. parameters: - description: Filter by customer display ID (cus_...). example: cus_01HXYZ in: query name: customer_id schema: type: string - description: Filter by invoice display ID (inv_...). example: inv_01HXYZ in: query name: invoice_id schema: type: string - description: Filter by invoice reference string. in: query name: invoice_reference schema: type: string - description: Page size. Defaults to 100. Minimum 1, maximum 100. example: 20 in: query name: limit schema: type: integer minimum: 1 maximum: 100 - description: Page number (1-based). Defaults to 1. example: 1 in: query name: page schema: type: integer minimum: 1 - description: Filter by payment link display ID (plink_...). example: plink_01HXYZ in: query name: paylink_id schema: type: string - description: >- Filter by payment method. Accepts one value or a comma-separated list of the allowed values below. example: - ProxyWallet in: query name: payment_method style: form explode: false schema: type: array items: enum: - Unknown - MerchantContract - ProxyWallet - Unblock - Payout - Card - GooglePay - ApplePay - Paypal - DirectDebit - Ramp - RampCryptoSettlement - Refund - Deposit type: string - description: Filter by plan display ID (plan_...). example: plan_01HXYZ in: query name: plan_id schema: type: string - description: >- Inclusive lower bound on created_at (RFC3339). When set, results are sorted by created_at. example: '2024-01-01T00:00:00.000Z' in: query name: since schema: type: string format: date-time - description: >- Sort direction for the primary list key (created_at when since/until are set, otherwise id). Defaults to desc. example: desc in: query name: sort schema: type: string enum: - asc - desc - description: >- Filter by payment status. Accepts one value or a comma-separated list of the allowed values below. example: - Succeeded in: query name: status style: form explode: false schema: type: array items: enum: - Unknown - RequiresPaymentMethod - RequiresConfirmation - RequiresAction - Processing - Succeeded - Canceled - Failed type: string - description: >- Inclusive upper bound on created_at (RFC3339). When set, results are sorted by created_at. example: '2024-12-31T23:59:59.000Z' in: query name: until schema: type: string format: date-time responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/internal.PaginatedResponse-encoding_json_RawMessage '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/internal.ErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internal.ErrorResponse' security: - ApiKeyAuth: [] components: schemas: internal.PaginatedResponse-encoding_json_RawMessage: properties: data: allOf: - $ref: >- #/components/schemas/internal.PaginatedItems-encoding_json_RawMessage description: Paginated payload. error: description: True when the request failed. type: boolean type: object internal.ErrorResponse: properties: error: allOf: - $ref: '#/components/schemas/internal.ErrorStruct' description: Error details including HTTP-style code and message. type: object internal.PaginatedItems-encoding_json_RawMessage: properties: items: description: Items in the current page. items: type: object type: array last_update: description: >- Timestamp of the most recently updated item in the result set, when available. example: '2021-01-01T00:00:00.000Z' type: string next: description: Next page number to request, when more results exist. example: 10 type: integer total: description: Total number of matching items across all pages. example: 10 type: integer type: object internal.ErrorStruct: properties: code: description: |- Error code Example: 400 example: 400 type: integer errors: description: List of errors items: $ref: '#/components/schemas/internal.SingleError' type: array message: description: |- Error message Example: Insufficient quantity example: Insufficient quantity type: string type: object internal.SingleError: properties: domain: description: |- Domain Example: orders example: orders type: string reason: description: |- Error Reason Example: InsufficientQuantity example: InsufficientQuantity type: string type: object securitySchemes: ApiKeyAuth: in: header name: X-API-KEY type: apiKey ````