> ## Documentation Index > Fetch the complete documentation index at: https://docs.jupico.com/llms.txt > Use this file to discover all available pages before exploring further. # List submerchant settlements > Returns settlement records for your submerchants, including settlement timing and amounts. ## OpenAPI ````yaml /openapi.json post /v1/query/settlements/submerchant openapi: 3.0.0 info: title: Jupico - OpenAPI 3.0 description: >- The Jupico API lets Service Providers onboard merchants, process card and eCheck (ACH) payments, run hosted payment pages, manage recurring billing, send payouts, and query every resource. All endpoints use HTTPS with Basic authentication and accept and return JSON. Endpoints are grouped by workflow: onboard merchants first, then accept payments, then move funds and report. termsOfService: https://help.jupico.com/references-and-resources/legal contact: email: support@jupico.com license: name: Jupico License url: https://jupico.com version: 1.0.5 servers: - url: https://sandbox-platform.jupico.com security: - basicAuth: [] tags: - name: Status description: Health check for the Jupico API. - name: Onboarding Invites description: >- Create and send invites that onboard merchants through the Jupico-hosted flow, with optional pre-filled identity, fees, and payout bank account data. - name: Provisioning description: >- Onboard merchants from your own UI. Collect onboarding data and submit it through the provisioning chain: applicant → application → submerchant. - name: Session description: >- Create browser authorization sessions for the Jupico web components, so card and bank account data is tokenized client-side and never touches your servers. - name: Tokenization description: >- Convert one-time tokens from the web components into permanent Jupico tokens, or tokenize raw card data if your systems are PCI DSS compliant. - name: Customer description: >- Create and manage customer records that payments, subscriptions, installments, and invoices link to. - name: Card Transactions description: >- Process credit and debit card transactions using tokenized card data: sale, authorization, capture, void, refund, and rollback. - name: eCheck Transactions description: >- Debit customer bank accounts via eCheck (ACH): sale, void, refund, rollback, and bank account tokenization. - name: Checkouts description: >- Hosted checkout sessions where customers complete payment on a Jupico-hosted page. - name: Payment Links description: >- Shareable links that open a Jupico-hosted payment page — no integration code needed at the point of sharing. - name: Invoices description: Create and email invoices that customers pay online. - name: Subscriptions description: >- Recurring billing. Plans define billing schedules and pricing models; subscriptions enroll customers against a stored payment token. - name: Installments description: Split a fixed total into scheduled payments with an optional deposit. - name: Payouts description: >- Send funds from a submerchant's available balance to a tokenized bank account with on-demand payout instructions. - name: Query description: >- Search and report across every resource: transactions, merchants, settlements, balances, disputes, fees, and more. All query endpoints accept the same filter, sort, and pagination envelope — see the Query Capabilities guide. paths: /v1/query/settlements/submerchant: post: tags: - Query summary: List submerchant settlements description: >- Returns settlement records for your submerchants, including settlement timing and amounts. operationId: findSettlementsSubmerchant requestBody: required: true content: application/json: schema: type: object responses: '200': $ref: '#/components/responses/findSettlementsSubmerchant' security: - basicAuth: [] components: responses: findSettlementsSubmerchant: description: findSettlementsSubmerchant content: application/json: schema: type: object properties: success: type: boolean example: true description: >- Whether the request was processed successfully. Declines return HTTP 200 with `success: false`. message: type: string example: succeeded description: Human-readable result message. code: type: string example: '0' description: Machine-readable result code. See the Error Codes reference. data: type: array items: type: object properties: _id: type: string example: 67c24dd60621becf9a41813e description: Internal document identifier. subMerchantId: type: string example: jpt-sim-md-1 description: Unique identifier of the submerchant. spProductId: type: string example: '255' description: >- Identifier of the Service Provider product the merchant belongs to. facId: type: string example: JPT description: Facilitator identifier assigned by Jupico. totalSales: type: number example: 47090 description: Gross sales in the settlement. refunds: type: number example: 0 description: Refund amount. chargebacks: type: number example: 0 description: Chargebacks linked to this transaction. taxHolding: type: number example: 0 description: Tax amount withheld. netSales: type: number example: 45706.67 description: Sales minus refunds and chargebacks. feesIds: type: array items: type: string example: - 67c1b0bd7ce3b3d57560d48d - 67c1b0bd7ce3b3d57560d491 description: Identifiers of fee records included. createdAt: type: string format: date-time example: '2025-02-28T23:59:18.385Z' description: Timestamp when the object was created (ISO 8601). updatedAt: type: string format: date-time example: '2025-02-28T23:59:18.385Z' description: Timestamp when the object was last updated (ISO 8601). platformFee: type: number example: 1312.01 description: Portion of the fee billed at the platform level. spProductFee: type: number example: 71.32 description: >- Portion of the fee billed at the Service Provider product level. interchangeFee: type: number example: 0 description: Interchange fee amount passed through. totalFees: type: number example: 1383.33 description: Total fees deducted. description: The response payload. totals: type: object properties: _id: type: string nullable: true example: null description: Internal document identifier. count: type: number example: 23 description: Number of records. totalSales: type: number example: 85318.68 description: Gross sales in the settlement. totalRefunds: type: number example: 0 description: Total refunds in the settlement. netSales: type: number example: 82725.1 description: Sales minus refunds and chargebacks. totalChargebacks: type: number example: 0 description: Total chargebacks in the settlement. taxHolding: type: number example: 0 description: Tax amount withheld. feesIdsLength: type: number example: 324 description: Number of fee records in the settlement. platform: type: number example: 2445.85 description: Total fees at the platform level. spProduct: type: number example: 147.73 description: Total fees at the Service Provider product level. interchange: type: number example: 0 description: Interchange pass-through fee settings. totalFees: type: number example: 2593.58 description: Total fees deducted. description: Aggregate totals across all returned records. query: type: object properties: options: type: object properties: limit: type: number example: 1000 description: Maximum number of records returned. description: 'Query options: pagination, sorting, and field projection.' description: Echo of the query envelope that produced this result. securitySchemes: basicAuth: type: http scheme: basic ````