---
title: Create Batch Payout
description: Send payout requests in bulk to partners as a single batch.
---

The Create Batch Payout Request API allows merchants to send payout requests in bulk to their partners, processed as a single batch. The API uses JSON format for both request and response payloads. To ensure security, all data is encrypted using AES-256 Base64 encryption. Each partner is provided with a unique authentication key and encryption key for secure transaction processing.

#### POST

```
http://kraken.airpay.co.in:8000/payout/partner/payout-batches
```

## Header

| Parameter | Type Value | Description | Value Like |
| --- | --- | --- | --- |
| Content-Type  required | String | The Content-Type header indicates the media type of the request or response body so the receiver knows how to process the data. | `application/json` |
| Authorization  required | String | The token is a JSON Web Token (JWT) in this example, commonly used for bearer authentication. | `JIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NT` |

## Request Body

| Parameter | Type Value | Description | Value Like |
| --- | --- | --- | --- |
| batch_code  required | Alphanumeric  <br>(1-15) | Unique code of the payout batch | `2022JAN` |
| batch_name  required | Alphanumeric  <br>(1-100) | Name of the batch | `Affiliate Payout Batch of January 2022` |
| transfers  required | Object | Buyer Transfer data block |
| transfer_number  required | Alphanumeric  <br>(1-10) | Buyer Last Name | `10` |
| UID  required | Alphanumeric  <br>(1-50) | Custom variable from partner | `USER1` |
| payee_name  required | Alphanumeric  <br>(1-100) | Name of the payee | `test` |
| payee_mobile  required | Numeric  <br>(10) | Mobile number of the payee | `981231313` |
| partner_bank_id  required | Numeric | Partner bank account id. This value will be ignored if bank_name or bank_account_type or bank_account_number or bank_ifsc present in the request | `100` |
| bank_name  required | Alphanumeric  <br>(1-50) | Beneficiary bank name | `SBI` |
| bank_account_number  required | Numeric  <br>(1-50) | Beneficiary account number | `560002379833` |
| bank_ifsc  required | Alphanumeric  <br>(1=15) | Beneficiary bank IFSC code | `SBIN0016387` |
| currency  required | Alphanumeric  <br>(3) | Currency code. Default value "INR" | `INR` |
| amount  required | Numeric | Amount to transfer | `2500` |
| transfer_mode  required | Alphanumeric | NEFT / IMPS | `NEFT` |

## Success 200

| Parameter | Type Value | Description | Value Like |
| --- | --- | --- | --- |
| status  required | Alphanumeric | success / error | `status=success` |
| message  required | Alphanumeric | Response description | `Payout batch created.` |
| errors  required | Array | Error messages if response status is 'error' |
| data  required | Array | Response data |
| code  required | Alphanumeric | Payout batch code | `2022JAN` |
| name  required | Alphanumeric | Payout Batch of January 2022 Payout batch name | `Affiliate` |
| create_datetime  required | DateTime | Date and time of payout batch created (Y-m-d H:i:s) | `2022-02-13 09:54:43` |
| transfers  required | Array | Transfer data block |
| transfer_number  required | Alphanumeric | Unique id of the transfer in the batch | `10` |
| UID  required | Alphanumeric | Custom variable from partner | `USER1` |
| amount  required | Numeric | Amount to transfer | `2500` |
| payee_name  required | Alphanumeric | Name of the payee | `John Brown` |
| payee_mobile  required | Numeric | Mobile number of the payee | `9846030201` |
| currency  required | Alphanumeric | Currency code | `INR` |
| partner_bank_id  required | Numeric | Partner bank account id | `111` |
| bank_name  required | Alphanumeric | Beneficiary bank name | `SBI` |
| bank_account_type  required | Alphanumeric | savings / current | `savings` |
| bank_account_number  required | Numeric | Beneficiary account number | `560002379833` |
| bank_ifsc  required | Alphanumeric | Beneficiary bank IFSC code | `SBIN0016387` |
| transfer_mode  required | Alphanumeric | NEFT / IMPS |
| transfer_datetime  required | DateTime | Transfer date and time(Y-m-d H:i:s) | `null` |
| utr_number  required | Alphanumeric | UTR / RRN Number | `null` |
| fees  required | Numeric | Transfer charge (If transfer status is success) | `0` |

## Request Example

```json
{
  "status": "success",
  "message": "Payout batch created.",
  "data": {
    "batch_code": "2022JAN",
    "batch_name": "Affiliate Payout Batch of January 2022",
    "created_datetime": "2022-02-13 09:54:43",
    "transfers": [
      {
        "transfer_number": "10",
        "UID": "USER1",
        "payee_name": "John Brown",
        "payee_mobile": "9846030201",
        "bank_name": "SBI",
        "bank_account_type": "savings",
        "bank_account_number": "560002379833",
        "bank_ifsc": "SBIN0016387",
        "currency": "INR",
        "amount": 2500,
        "transfer_mode": "NEFT",
        "partner_bank_id": "111",
        "status": "PENDING",
        "transfer_datetime": null,
        "utr_number": null,
        "fees": 0
      },
      {
        "transfer_number": "11",
        "payee_name": "Shivam Sharma",
        "payee_mobile": "9846030201",
        "partner_bank_id": "100",
        "currency": "INR",
        "amount": 1850,
        "transfer_mode": "IMPS",
        "bank_name": "ICICI",
        "bank_account_type": "savings",
        "bank_account_number": "56000673436565",
        "bank_ifsc": "ICIC001234",
        "status": "PENDING",
        "transfer_datetime": null,
        "utr_number": null,
        "fees": 0
      }
    ]
  }
}
```

### Success Response (Decrypted)

```json
{
    "status": "success",
    "message": "Payout batch created.",
    "data": {
        "code": "2022JAN",
        "name": "Affiliate Payout Batch of January 2022",
        "created_datetime": "2022-02-13 09:54:43",
        "transfers": [
            {
                "transfer_number": "10",
                "UID": "USER1",
                "amount": 2500,
                "payee_name": "John Brown",
                "payee_mobile": "9846030201",
                "currency": "INR",
                "partner_bank_id": "111",
                "bank_name": "SBI",
                "bank_account_type": "savings",
                "bank_account_number": "560002379833",
                "bank_ifsc": "SBIN0016387",
                "transfer_mode": "NEFT",
                "status": "PENDING",
                "transfer_datetime": null,
                "utr_number": null,
                "fees": 0
            }
        ]
    }
}
```