> ## 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.

# Record a manual payment for a payout batch

> Records a payout that was transferred to the seller outside the platform, for example a bank transfer made from your own banking portal. Use this when the store `payout` configuration is `manual`, or when an `auto` batch had to be settled by hand. Marks the batch as paid and returns the updated `SellerPayoutBatch`.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json put /orders/payouts/invoices/batches/{id}/manual-payment
openapi: 3.2.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: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Create and update products; manage their channels and category
      assignments, and list SKUs.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Variants
    description: Create, read and update product variants individually or in bulk.
    summary: Variants
    kind: nav
    parent: section-catalog
  - name: Categories
    description: Manage catalog categories and the attributes assigned to them.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Product attributes
    description: Define product attributes and the attribute sets that organize them.
    summary: Product attributes
    kind: nav
    parent: section-catalog
  - name: Inventory
    description: >-
      Read stock and inventory activity, update inventory, and record stock-in
      and stock-out movements.
    summary: Inventory
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: Read, moderate and remove product reviews.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Media
    description: >-
      Request file uploads, manage uploaded files, and organize them into
      folders.
    summary: Media
    kind: nav
    parent: section-catalog
  - name: Catalog jobs
    description: Create catalog processing jobs and follow their status.
    summary: Catalog jobs
    kind: nav
    parent: section-catalog
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Customers
    description: >-
      Create and update customers, view their details and activity, and manage
      profile images.
    summary: Customers
    kind: nav
    parent: section-customers
  - name: Users
    description: List the users attached to a customer and activate or deactivate them.
    summary: Users
    kind: nav
    parent: section-customers
  - name: Customer attributes
    description: Define customer attributes and manage the values assigned to customers.
    summary: Customer attributes
    kind: nav
    parent: section-customers
  - name: Customer groups
    description: Configure the customer groups available in the store.
    summary: Customer groups
    kind: nav
    parent: section-customers
  - name: Addresses
    description: Read and manage a customer’s saved addresses.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: Bank accounts
    description: Read and manage a customer’s bank accounts.
    summary: Bank accounts
    kind: nav
    parent: section-customers
  - name: KYC documents
    description: Configure the store’s KYC requirements and manage customer documents.
    summary: KYC documents
    kind: nav
    parent: section-customers
  - name: Visitors
    description: >-
      Read anonymous visitor profiles, their activity and their attribute
      values.
    summary: Visitors
    kind: nav
    parent: section-customers
  - name: Loyalty
    description: >-
      Configure loyalty programs, manage membership tiers, and inspect or record
      point activity.
    summary: Loyalty
    kind: nav
    parent: section-customers
  - name: Credit
    description: Set credit-line eligibility and read customer credit balances.
    summary: Credit
    kind: nav
    parent: section-customers
  - name: Mandates
    description: >-
      Inspect customer payment mandates and debit schedules, and pause, resume
      or revoke a mandate.
    summary: Mandates
    kind: nav
    parent: section-customers
  - name: Segments
    description: >-
      Manage customer segments, their members and associated advertising
      audiences.
    summary: Segments
    kind: nav
    parent: section-customers
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: List abandoned carts for follow-up.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: Manage coupons, coupon codes and promotions, and inspect their usage.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Read and update orders, accept or cancel them, check stock, and follow
      order activity.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Invoices
    description: List order invoices and retrieve an order’s invoice or receipt.
    summary: Invoices
    kind: nav
    parent: section-orders
  - name: Returns
    description: Read customer return requests and approve or reject them.
    summary: Returns
    kind: nav
    parent: section-orders
  - name: Shipments
    description: >-
      Create and manage shipments, follow delivery activity, and handle
      replacements and shortfalls.
    summary: Shipments
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Order payments
    description: >-
      Create and inspect payment requests, verify order payments, and cancel or
      mark a payment paid.
    summary: Order payments
    kind: nav
    parent: section-payments
  - name: Refunds
    description: Estimate and issue refunds, or mark an order refund paid or forfeited.
    summary: Refunds
    kind: nav
    parent: section-payments
  - name: Payment exceptions
    description: Inspect payment exceptions and resolve them.
    summary: Payment exceptions
    kind: nav
    parent: section-payments
  - name: Payment methods
    description: Configure manual payment methods and list available payment options.
    summary: Payment methods
    kind: nav
    parent: section-payments
  - name: Seller payouts
    description: >-
      Configure seller payouts and manage invoices, adjustments, charges and
      payout batches.
    summary: Seller payouts
    kind: nav
    parent: section-payments
  - name: section-marketplace
    summary: Marketplace
    kind: nav
  - name: Marketplace catalog
    description: Inspect and publish marketplace products, variants, reviews and inventory.
    summary: Marketplace catalog
    kind: nav
    parent: section-marketplace
  - name: Marketplace listings
    description: List, synchronize and remove the store’s product listings on marketplaces.
    summary: Marketplace listings
    kind: nav
    parent: section-marketplace
  - name: Marketplace settings
    description: >-
      Read marketplace configuration and configure category schemas and
      attributes.
    summary: Marketplace settings
    kind: nav
    parent: section-marketplace
  - name: Sellers
    description: Manage the sellers a customer is authorized to buy from.
    summary: Sellers
    kind: nav
    parent: section-marketplace
  - name: section-fulfillment
    summary: Fulfillment
    kind: nav
  - name: Shipping methods
    description: Configure shipping methods and costs, and check courier serviceability.
    summary: Shipping methods
    kind: nav
    parent: section-fulfillment
  - name: Shipping boxes
    description: Manage shipping boxes and read the boxes available for a product.
    summary: Shipping boxes
    kind: nav
    parent: section-fulfillment
  - name: Shipping zones
    description: Create, read and maintain shipping zones.
    summary: Shipping zones
    kind: nav
    parent: section-fulfillment
  - name: Warehouses
    description: Create, read and maintain the store’s warehouses.
    summary: Warehouses
    kind: nav
    parent: section-fulfillment
  - name: section-point-of-sale
    summary: Point of sale
    kind: nav
  - name: Devices
    description: Manage POS devices, generate pairing codes and revoke devices.
    summary: Devices
    kind: nav
    parent: section-point-of-sale
  - name: POS users
    description: Manage staff accounts used at the point of sale.
    summary: Staff
    kind: nav
    parent: section-point-of-sale
  - name: POS roles
    description: Manage POS roles and inspect available permissions.
    summary: Roles & permissions
    kind: nav
    parent: section-point-of-sale
  - name: section-store
    summary: Store
    kind: nav
  - name: Store
    description: Read and update the store configuration.
    summary: Store
    kind: nav
    parent: section-store
  - name: Locations
    description: List countries, states and pincodes.
    summary: Locations
    kind: nav
    parent: section-store
  - name: Notifications
    description: >-
      Manage notification templates and store or customer notification
      preferences.
    summary: Notifications
    kind: nav
    parent: section-store
  - name: Downloads
    description: Request data downloads and follow download jobs.
    summary: Downloads
    kind: nav
    parent: section-store
  - name: Search
    description: Search customers, orders and products across the store.
    summary: Search
    kind: nav
    parent: section-store
  - name: Filter options
    description: >-
      Retrieve the available filters for resource lists in the administration
      interface.
    summary: Filter options
    kind: nav
    parent: section-store
  - name: section-integrations
    summary: Integrations
    kind: nav
  - name: Catalog integrations
    description: Request catalog synchronization and inspect sync results and activity.
    summary: Catalog integrations
    kind: nav
    parent: section-integrations
  - name: Service providers
    description: Configure service providers and test their connections.
    summary: Service providers
    kind: nav
    parent: section-integrations
  - name: Webhooks
    description: >-
      Manage webhook subscriptions, rotate their secrets and send test
      deliveries.
    summary: Webhooks
    kind: nav
    parent: section-integrations
  - name: Webhook deliveries
    description: >-
      Inspect webhook delivery logs, retry deliveries and replay events to a
      subscription.
    summary: Webhook deliveries
    kind: nav
    parent: section-integrations
  - name: Events
    description: >-
      Browse recorded events and the event types available for webhook
      subscriptions.
    summary: Events
    kind: nav
    parent: section-integrations
  - name: Live updates
    description: Read the store’s live event stream and global state.
    summary: Live updates
    kind: nav
    parent: section-integrations
  - name: section-analytics
    summary: Analytics
    kind: nav
  - name: Analytics
    description: Query analytics data, read charts and inspect visitor sessions and events.
    summary: Analytics
    kind: nav
    parent: section-analytics
  - name: Metrics
    description: >-
      Read aggregate metrics for catalog, customers, orders, payments,
      fulfillment and webhooks.
    summary: Metrics
    kind: nav
    parent: section-analytics
paths:
  /orders/payouts/invoices/batches/{id}/manual-payment:
    parameters: []
    put:
      tags:
        - Seller payouts
      summary: Record a manual payment for a payout batch
      description: >-
        Records a payout that was transferred to the seller outside the
        platform, for example a bank transfer made from your own banking portal.
        Use this when the store `payout` configuration is `manual`, or when an
        `auto` batch had to be settled by hand. Marks the batch as paid and
        returns the updated `SellerPayoutBatch`.
      operationId: record-seller-payout-batch-manual-payment
      parameters:
        - name: id
          in: path
          description: The ID of the payout batch.
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SellerPayoutBatchManualPayment'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                  - content
                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'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    SellerPayoutBatchManualPayment:
      oneOf:
        - description: >-
            Details of an off-platform transfer made to a seller, recorded
            against a payout batch.
          type: object
          required:
            - payment_mode
            - payment_method
            - payment_gateway_reference_no
          properties:
            payment_mode:
              type: string
              const: bank-transfer
            payment_method:
              description: 'Bank transfer instrument: NEFT, RTGS or IMPS.'
              type: string
              enum:
                - NEFT
                - RTGS
                - IMPS
            payment_gateway_reference_no:
              description: >-
                Reference number issued by the bank or gateway for the transfer,
                such as the NEFT UTR. Use it to reconcile the payout against the
                bank statement.
              type: string
            remarks:
              description: >-
                Free-text note stored on the batch, for example the reason the
                payout was settled outside the platform.
              type:
                - string
                - 'null'
          title: SellerPayoutBatchManualPayment
          x-tags:
            - Payouts
        - description: >-
            Details of an off-platform transfer made to a seller, recorded
            against a payout batch.
          type: object
          required:
            - payment_mode
            - payment_method
            - payment_gateway_reference_no
          properties:
            payment_mode:
              type: string
              const: payment-gateway
            payment_method:
              description: >-
                Instrument used for the transfer: `CC` (credit card), `DC`
                (debit card), `NEFT`, `RTGS`, `IMPS`, `UPI`, or `WALLET`.
              type: string
              enum:
                - CC
                - DC
                - NEFT
                - RTGS
                - IMPS
                - UPI
                - WALLET
            payment_gateway_reference_no:
              description: >-
                Reference number issued by the bank or gateway for the transfer,
                such as the NEFT UTR. Use it to reconcile the payout against the
                bank statement.
              type: string
            remarks:
              description: >-
                Free-text note stored on the batch, for example the reason the
                payout was settled outside the platform.
              type:
                - string
                - 'null'
          title: SellerPayoutBatchManualPayment
          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`, as a
            decimal string.
          type: string
        debit_adjustments:
          description: >-
            Total debits applied to the batch from its `adjustments`, as a
            decimal string.
          type: string
        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
        marketplace_detail:
          description: >-
            Marketplace context for this payout batch. Returned as `null` when
            not applicable.
          type:
            - object
            - 'null'
          properties:
            id:
              description: Marketplace ULID.
              type: string
              example: 01KVZ1TK3V1ZB8TK2V3E3G64FS
            marketplace_type:
              $ref: '#/components/schemas/MarketplaceType'
              example: internal
            name:
              type: string
              example: Davai Marketplace
            slug:
              type: string
              example: davai-marketplace
            store_id:
              type: string
              example: f7ul64jr3n
        payment_gateway:
          description: >-
            Slug of the payment provider that transferred the batch, for example
            `juspay` or `icici-cib`. `null` until the batch is transferred, and
            for batches settled manually.
          type:
            - string
            - 'null'
        payment_gateway_reference_no:
          description: >-
            Reference number issued by the bank or gateway for the transfer,
            such as the NEFT UTR. `null` until the batch is transferred.
          type:
            - string
            - 'null'
        payment_method:
          description: >-
            Instrument used for the transfer, one of `CC`, `DC`, `NEFT`, `RTGS`,
            `IMPS`, `UPI`, or `WALLET`. `null` until the batch is transferred.
          type:
            - string
            - 'null'
        payment_mode:
          description: >-
            How the batch was paid to the seller, either `bank-transfer` or
            `payment-gateway`. `null` until the batch is transferred.
          type:
            - string
            - 'null'
        payment_option:
          description: >-
            Snapshot of the store `payout` configuration at batch creation.
            `auto` batches are settled through a connected provider; `manual`
            batches are paid outside the platform and recorded with the
            manual-payment endpoint.
          type: string
          enum:
            - auto
            - manual
        payments:
          description: >-
            Transfers made to the seller against this batch, as
            `SellerPayoutBatchPayment` objects. Covers both provider transfers
            and payments recorded through the manual-payment endpoint. Empty
            until a transfer is attempted; each entry carries its own
            `payment_status`, so a retried batch lists one entry per attempt.
          type: array
          items:
            $ref: '#/components/schemas/SellerPayoutBatchPayment'
        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. A batch is `scheduled` (`created` when an
            admin created it), `processing` while its transfer is under way, and
            `completed` once the seller is paid; `payment_failed` when its
            transfer still fails after its retries, `on_hold` while it is held,
            and `cancelled` when it is cancelled or broken up.
          type: string
          enum:
            - created
            - scheduled
            - processing
            - completed
            - cancelled
            - on_hold
            - payment_failed
        to_be_paid:
          description: >-
            Net amount payable to the seller: `total_invoice_amount` -
            `total_charges` + `credit_adjustments` - `debit_adjustments`.
            Decimal string.
          type: string
        total_charges:
          description: >-
            Sum of marketplace charges deducted across all invoices in the
            batch, as a decimal string.
          type: string
        total_invoice_amount:
          description: >-
            Sum of the batched invoice amounts, before charges and adjustments,
            as a decimal string.
          type: string
        total_loyalty_point_redeemed:
          description: >-
            Sum of `loyalty_point_redeemed` across invoices in the batch, as a
            decimal string.
          type: string
      x-tags:
        - Payouts
    MarketplaceType:
      title: MarketplaceType
      type: string
      enum:
        - amazon
        - flipkart
        - marketplace
        - internal
    SellerPayoutBatchPayment:
      title: SellerPayoutBatchPayment
      description: >-
        Transfer recorded on a `SellerPayoutBatch`. Mirrors `OrderPayment`, with
        payout settlement field types.
      type: object
      properties:
        transaction_type:
          enum:
            - payment
            - refund
        request_number:
          type: string
        amount:
          description: Transfer amount as a decimal string.
          type: string
        payment_status:
          description: >-
            Status of the transfer: `pending` until it is sent, `initiated` once
            the bank has accepted it and its confirmation is awaited, `success`
            once paid, `failed` when the attempt failed (it is retried until its
            retries are used up).
          type: string
          enum:
            - pending
            - initiated
            - success
            - failed
        payment_date:
          type:
            - string
            - 'null'
          format: date-time
        payment_success_date:
          description: When the transfer succeeded.
          type:
            - string
            - 'null'
        payment_reference_number:
          type:
            - string
            - 'null'
        payment_method:
          description: Empty string when recorded without a method; null for refunds.
          type:
            - string
            - 'null'
          enum:
            - Card
            - Credit Card
            - Debit Card
            - Netbanking
            - UPI
            - Wallet
            - Loyalty Point
            - IMPS
            - NEFT
            - RTGS
            - Cash
            - NACH
            - ''
            - null
        payment_mode:
          type: string
        icon_url:
          type:
            - string
            - 'null'
        card_number:
          description: Masked card number, e.g. ************1111. Card payments only.
          type:
            - string
            - 'null'
        card_type:
          type:
            - string
            - 'null'
          enum:
            - Visa
            - Master Card
            - Rupay
            - null
        bank_name:
          type:
            - string
            - 'null'
        bank_account_number:
          description: Masked account number, e.g. ************1234.
          type:
            - string
            - 'null'
      x-tags:
        - Payouts
  responses:
    BadRequest:
      description: The request is invalid or cannot be completed in the current state.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              errors:
                description: Validation details as a field map, a bulk list or a string.
                anyOf:
                  - type: object
                    additionalProperties: true
                  - type: array
                  - type: string
              content:
                type: object
                additionalProperties: true
              details:
                type: string
    Unauthorized:
      description: >-
        The token is missing, invalid or expired, or does not grant access to
        this store and operation.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    InternalServerError:
      description: >-
        The request could not be completed. Quote error_id, when present, when
        contacting support.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
              error_id:
                type: string
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Sign in to the admin dashboard and use the resulting ID token for a
        store and operation you can access. The authenticated dashboard cookie
        is accepted when the Authorization header is absent. Missing or
        insufficient access returns 401.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.