# Batch On Hold

POST 

Triggered when a pay out batch is placed on hold.

Notification name: `payout_batch_onhold`

Reference: https://docs.payabli.com/developers/webhooks/payout-batch-on-hold

## OpenAPI 3.1 Webhook Specification

```yaml
openapi: 3.1.1
info:
  title: Pay Out Batch On Hold
  version: subpackage_payOutWebhooks.payoutBatchOnHold
webhooks:
  payout-batch-on-hold:
    post:
      operationId: payout-batch-on-hold
      summary: Pay Out Batch On Hold
      description: |-
        Triggered when a pay out batch is placed on hold.

        Notification name: `payout_batch_onhold`
      tags:
        - subpackage_payOutWebhooks
      parameters:
        - name: Content-Length
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/type_commons:Content-Length'
        - name: Content-Type
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/type_commons:Content-Type'
        - name: Accept
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/type_commons:Accept'
        - name: String
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/type_commons:String'
        - name: Host
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/type_commons:Host'
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_commons:PayoutBatchOnHoldContent'
components:
  schemas:
    type_commons:Content-Length:
      type: string
    type_commons:Content-Type:
      type: string
    type_commons:Accept:
      type: string
    type_commons:String:
      type: string
    type_commons:Host:
      type: string
    type_commons:Paypoint:
      type: string
    type_commons:Text:
      type: string
    type_commons:BatchId:
      type: string
    type_commons:TotalAmount:
      type: string
    type_commons:Method:
      type: string
    type_commons:PayoutBatchOnHoldContent:
      type: object
      properties:
        Event:
          type: string
          enum:
            - type: stringLiteral
              value: PayOutBatchOnHold
          description: Event type identifier
        Paypoint:
          $ref: '#/components/schemas/type_commons:Paypoint'
        Text:
          $ref: '#/components/schemas/type_commons:Text'
        BatchId:
          $ref: '#/components/schemas/type_commons:BatchId'
        TotalAmount:
          $ref: '#/components/schemas/type_commons:TotalAmount'
        Method:
          $ref: '#/components/schemas/type_commons:Method'
      required:
        - Event
        - Paypoint
        - Text
        - BatchId
        - TotalAmount
        - Method

```