> ## 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. # Hold a seller payout batch > Puts a payout batch on hold so the next transfer run skips it. `status` moves to `on_hold` and the batch stays out of settlement until it is unheld. Use this to stop a scheduled payout without cancelling the batch or releasing its invoices. Returns the updated `SellerPayoutBatch`. ## OpenAPI ````yaml https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/batches/{id}/hold 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: Segments description: Segments - name: Shipping description: Shipping - name: SSE description: SSE - name: Store description: Store - name: Webhooks description: Webhooks paths: /orders/payouts/invoices/batches/{id}/hold: parameters: [] post: tags: - Payouts summary: Hold a seller payout batch description: >- Puts a payout batch on hold so the next transfer run skips it. `status` moves to `on_hold` and the batch stays out of settlement until it is unheld. Use this to stop a scheduled payout without cancelling the batch or releasing its invoices. Returns the updated `SellerPayoutBatch`. operationId: hold-seller-payout-batch parameters: - name: id in: path description: The ID of the payout batch. required: true schema: type: string responses: '200': description: OK 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' '404': $ref: '#/components/responses/NotFound' components: schemas: 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 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 `OrderPayment` objects - the same payment shape returned in order detail. 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/OrderPayment' 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 processed_at: description: >- When the batch finished processing and became ready to transfer. `null` until processing completes. type: - string - 'null' 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 `created` → `scheduled` → `completed`; `on_hold`, `failed`, and `cancelled` are terminal until an admin acts. type: string enum: - created - scheduled - completed - 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 transferred_at: description: >- When the payout was transferred to the seller. `null` until `status` is `completed`. type: - string - 'null' format: date-time x-tags: - Payouts OrderPayment: title: OrderPayment description: Order Payment oneOf: - $ref: '#/components/schemas/CardPayment' - $ref: '#/components/schemas/NetbankingPayment' - $ref: '#/components/schemas/UpiPayment' - $ref: '#/components/schemas/WalletPayment' - $ref: '#/components/schemas/BankTransfer' - $ref: '#/components/schemas/LoyaltyPointPayment' CardPayment: title: CardPayment description: Payments using credit card, debit card allOf: - $ref: '#/components/schemas/OrderPaymentInfo' - type: object properties: card_number: description: "masked card number\r\ne.g. ************1111" type: - string - 'null' card_type: type: string enum: - Visa - Master Card - Rupay NetbankingPayment: title: NetbankingPayment description: Payments using payment gateway netbanking option. allOf: - $ref: '#/components/schemas/OrderPaymentInfo' - type: object properties: bank_name: type: string UpiPayment: title: UpiPayment description: UPI Payment allOf: - $ref: '#/components/schemas/OrderPaymentInfo' - type: object properties: upi_id: type: - string - 'null' WalletPayment: title: WalletPayment allOf: - $ref: '#/components/schemas/OrderPaymentInfo' - type: object properties: wallet_name: type: - string - 'null' BankTransfer: title: BankTransfer description: Bank transfer payment - IMPS, NEFT, RTGS allOf: - $ref: '#/components/schemas/OrderPaymentInfo' - type: object properties: bank_account_number: description: "masked account number\r\ne.g. ************1234" type: - string - 'null' bank_name: type: - string - 'null' LoyaltyPointPayment: title: LoyaltyPointPayment description: Loyalty point redemption. allOf: - $ref: '#/components/schemas/OrderPaymentInfo' x-tags: - Orders OrderPaymentInfo: title: OrderPaymentInfo description: Common fields in all types of payments. type: object properties: transaction_type: enum: - payment - refund request_number: type: string amount: type: number format: double payment_status: $ref: '#/components/schemas/PaymentStatus' payment_date: type: string format: date-time payment_reference_number: type: - string - 'null' payment_method: description: >- `""` when the payment was recorded without a method — seen on point-of-sale orders. type: string enum: - Card - Credit Card - Debit Card - Netbanking - UPI - Wallet - Loyalty Point - IMPS - NEFT - RTGS - Cash - NACH - '' payment_mode: type: string icon_url: type: - string - 'null' created_at: type: string format: date-time readOnly: true modified_at: type: string format: date-time readOnly: true x-tags: - Orders PaymentStatus: title: PaymentStatus enum: - pending - success - failed - partially_paid - refund_initiated - refunded - unsettled - settled - partially_settled - debit_scheduled - collection_due 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 NotFound: description: Requested resource not found content: application/json: schema: type: object properties: message: type: string success: type: boolean code: type: string securitySchemes: Authorization: type: http scheme: bearer ````