> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create seller payout batch

> Manually create a scheduled seller payout batch from selected pending payout invoices.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/batches
openapi: 3.1.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: Analytics
    description: Analytics
  - name: Catalog
    description: Catalog
  - name: Coupons & promotions
    description: Coupons & promotions
  - name: Customers
    description: Customers
  - name: Filter Options
    description: Filter Options
  - name: Inventories
    description: Inventories
  - name: Marketplace
    description: Marketplace
  - name: Marketplace Catalog
    description: Marketplace Catalog
  - name: Media Gallery
    description: Media Gallery
  - name: Metrics
    description: Metrics
  - name: Orders
    description: Orders
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: POS
    description: POS
  - name: POSAdmin
    description: Admin endpoints to be used as proxy in pos
  - name: Segments
    description: Segments
  - name: Shipping
    description: Shipping
  - name: SSE
    description: SSE
  - name: Store
    description: Store
  - name: Webhooks
    description: Webhooks
paths:
  /orders/payouts/invoices/batches:
    parameters: []
    post:
      tags:
        - Payouts
      summary: Create seller payout batch
      description: >-
        Manually create a scheduled seller payout batch from selected pending
        payout invoices.
      operationId: create-seller-payout-batch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SellerPayoutBatchCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      payout_batch:
                        $ref: '#/components/schemas/SellerPayoutBatch'
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    SellerPayoutBatchCreate:
      title: SellerPayoutBatchCreate
      type: object
      required:
        - invoice_numbers
      properties:
        include_pending_adjustments:
          description: >-
            When true, pending unlinked adjustments for the seller are included
            in the batch.
          type: boolean
          default: true
        invoice_numbers:
          description: >-
            Pending payout invoice numbers. All invoices must belong to the same
            seller.
          type: array
          items:
            type: string
          minItems: 1
        remarks:
          type: string
      x-tags:
        - Payouts
    SellerPayoutBatch:
      title: SellerPayoutBatch
      description: >-
        A settlement batch that groups a seller's payout-eligible invoices into
        a single transfer.
      type: object
      properties:
        batch_number:
          description: Human-readable batch reference, e.g. `PB-TNSFR9Q0HA7J`.
          type: string
        credit_adjustments:
          description: Total credits applied to the batch from its `adjustments`.
          type: number
        debit_adjustments:
          description: Total debits applied to the batch from its `adjustments`.
          type: number
        id:
          description: Payout batch ULID.
          type: string
        include_shipping_in_payout:
          description: >-
            Snapshot of the seller's payout config at batch creation. When
            `true`, shipping charges are part of the payable amount.
          type: boolean
        include_tax_in_payout:
          description: >-
            Snapshot of the seller's payout config at batch creation. When
            `true`, tax collected on the invoices is part of the payable amount.
          type: boolean
        initiated_by:
          description: >-
            `system` for scheduled batch runs, `admin` for manually created
            batches.
          type: string
          enum:
            - system
            - admin
        initiated_by_user_id:
          description: >-
            The admin user who created the batch. `null` when `initiated_by` is
            `system`.
          type:
            - string
            - 'null'
        invoice_count:
          description: Number of payout invoices settled by this batch.
          type: integer
        period_end:
          description: End of the invoice eligibility window covered by this batch.
          type: string
          format: date-time
        period_start:
          description: Start of the invoice eligibility window covered by this batch.
          type: string
          format: date-time
        remarks:
          type:
            - string
            - 'null'
        scheduled_at:
          description: When the batch is scheduled to be transferred to the seller.
          type: string
          format: date-time
        seller_id:
          type: string
        seller_name:
          type: string
          readOnly: true
        status:
          description: >-
            Batch lifecycle state. Batches move `pending` → `scheduled` →
            `processing` → `processed` → `transferred`; `on_hold`, `failed`, and
            `cancelled` are terminal until an admin acts.
          type: string
          enum:
            - pending
            - scheduled
            - processing
            - processed
            - transferred
            - failed
            - cancelled
            - on_hold
        to_be_paid:
          description: >-
            Net amount payable to the seller: `total_invoice_amount` -
            `total_charges` + `credit_adjustments` - `debit_adjustments`.
          type: number
        total_charges:
          description: >-
            Sum of marketplace charges deducted across all invoices in the
            batch.
          type: number
        total_invoice_amount:
          description: Sum of the batched invoice amounts, before charges and adjustments.
          type: number
      x-tags:
        - Payouts
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              error:
                type: object
                properties:
                  fieldname:
                    type: array
                    items:
                      type: string
    Unauthorized:
      description: Not authorized for given operation on the Resource
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Not authorized for given operation on the Resource.
              success:
                type: boolean
                default: false
              code:
                type: string
                example: unauthorized
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````