# Payout request batch modified

Endpoint: POST payout-request-batch-modified
Version: latest
Security: SecretApiKey, JWT

## Security:

  - `SecretApiKey` (unknown)
    apiKey in header REB-APIKEY

  - `JWT` (unknown)
    http bearer JWT

## Request body:

  - `application/json` (unknown)
    Payload of a webhook event for a batch of payout requests.

## Request fields (application/json):

  - `batchId` (string, required)
    ID of the batch of payout requests.
    Example: preq_batch_0YVDMDE2BMC6KBB5MX76RF6T80

  - `eventType` (string, required)
    Type of event that triggered the webhook.
    Enum: "payout-request-batch-created", "payout-request-batch-modified"

  - `occurredTime` (string, required)
    Date and time when the batch change occurred.

  - `_embedded` (object, required)
    Embedded objects related to the batch event for payout requests.

  - `_embedded.payoutRequestBatch` (object, required)

  - `_embedded.payoutRequestBatch.description` (string | null)
    Optional description of the batch.
    Example: Batch processed on 2024-01-15

  - `_embedded.payoutRequestBatch.allocationOrder` (array | null)
    Order for auto-allocation of payout requests in this batch.
When set, this field overrides the organization-level allocation order during batch auto-allocation.
Must contain `selected-payment-instrument` exactly once.
Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
    Example: ["paypal","Interac-eTransfer","payment-card","alternative-payment-methods","selected-payment-instrument"]

  - `_links` (array, required)
    Links to related resources.

  - `_links.href` (string, required)
    URL of the link.

  - `_links.rel` (string, required)
    Type of relationship for the link.
    Enum: "payoutRequestBatch"

## Response 2xx:

  - `2xx` (unknown)
    Returns any 2xx status to indicate that data is received.