Skip to main content

payments

Search and retrieve payments with comprehensive filtering and pagination.

Provides flexible search capabilities across payment data with configurable pagination controls. Results include comprehensive payment information and transaction details by default for complete financial context. Supports response expansion options to optimize data retrieval.

Possible errors:

  • LIST_PAYMENTS_ERROR: Failed to retrieve payments due to system error
  • FORBIDDEN: Insufficient permissions to access payment data

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]

payments(
  input: PaymentsSearchInput
): PaymentsResponse!

Arguments​

payments.input ● PaymentsSearchInput input​

Search criteria for filtering payments.

If not provided, returns all accessible payments with default pagination (12 items per page) and includes transaction details.

Type​

PaymentsResponse object​

Paginated response containing payment records with navigation metadata.

Includes payment data along with pagination controls for efficient data browsing and client-side state management. Supports response expansion to include related transaction details.