---
title: Create Batch Payout Request
description: This API is used to create payout requests in bulk which is set in batch by merchant to pay his respective partner.
---

This API is used to create payout requests in bulk which is set in batch by merchant to pay his respective partner. The Request and Response will be in JSON Format.
 The Request / Response JSON String will be encrypted using AES-256 Base 64 Encryption.
 Each partner will have separate Auth Key and Encryption Key.

Create Batch Payout Request API is to send payout request batch.

## POST

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

## Header

| Field | Type | Description |
| --- | --- | --- |
| Content-Type | String | application/json |
| Authorization | String | Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
## Header-Example:

```
{
    "Accept": "application/json",
    "Authorization": "Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
```

## Parameter

| Field | Type | Description |
| --- | --- | --- |
| batch_code | Alphanumeric | Unique code of the payout batch (Maxlength 15) (required) |
| batch_name | Alphanumeric | Name of the batch (Maxlength 100) (required) |
| transfers | Object[] | Buyer Transfer data block (required) |
| transfers[transfer_number] | Alphanumeric | Buyer Last Name (Maxlength 10) (required) |
| transfers[UID] | Alphanumeric | Custom variable from partner (Maxlength 50) (required) |
| transfers[payee_name] | Alphanumeric | Name of the payee (Maxlength 100) (required) |
| transfers[payee_mobile] | Numeric | Mobile number of the payee (Maxlength 10) (required) |
| transfers[partner_bank_id] | 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 (required) |
| transfers[bank_name] | Alphanumeric | Beneficiary bank name (Maxlength 50) (required) |
| transfers[bank_account_number] | Numeric | Beneficiary account number(Maxlength 50) (required) |
| transfers[bank_ifsc] | Alphanumeric | Beneficiary bank IFSC code (Maxlength 15) (required) |
| transfers[currency] | Alphanumeric | Currency code. Default value “INR” (Maxlength 3) (required) |
| transfers[amount] | Numeric | Amount to transfer (required) |
| transfers[transfer_mode] | Alphanumeric | NEFT / IMPS (required) |
## Request-Example

```
{
    "batch_code": "2022JAN",
    "batch_name": "Affiliate Payout Batch of January 2022",
    "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"
        },
        {
            "transfer_number": "11",
            "payee_name": "Shivam Sharma",
            "payee_mobile": "9846030201",
            "partner_bank_id": "100",
            "currency": "INR",
            "amount": 1850,
            "transfer_mode": "IMPS"
        }
    ]
}
```

## Success 200

| Field | Type | Description |
| --- | --- | --- |
| status | Alphanumeric | success / error |
| message | Alphanumeric | Response description |
| errors | Array | Error messages if response status is ‘error’ |
| data | Array | Response data |
| data[code] | Alphanumeric | Payout batch code |
| data[name] | Alphanumeric | Payout batch name |
| data[create_datetime] | DateTime | Date and time of payout batch created (Y-m-d H:i:s) |
| data[transfers] | Array | Transfer data block |

## Request Encrypted 
```

uoCsw/t/uwF1cps+z8A1su4IhgHHb1bJLTJcOaErGu0+Z6676pvkaXW5znboLDpbqSdR6ErU2wVAx5MF65f5tMXyqN/2CGR3gEPqjCOFw3Q2YdrovMd+3DGtO+86wlfeN0PHh21fQ+OiSbnvsGBh1xnDXgHzqvhm5izb8le2/tk4AgbmEWQQA1qw/cwd4prvXu+1sjX3xTRyUVLNHFXS3TIrVVkKF5hq2rbNafPMsfgK90PveCwE8cxOEg1TlEacNK77SaW10IBDjR+LXfxoPZ1Demel8d+uX/uhlnCyrOIHHVMTjRvmU+j5PijhA7oD/NJ/dfR7YXZKbchnqiMs+pxcwbZSlrGEbdq0rL3FPeOkRtmkkJkdyusDTGZ2nLyL5Qu2nmKx9VfUS6Fq/XON2P2ACatcAHqFTubT17uoNk9ANZBmyoVOYGtZJBWFL3W0+VRSPAxY+WNW+fQeLxLXkjVHUMgNPoY0+Ye084zJF0WcJAjkX3jE2IJ/fXD3FkiHBpiICoggUtaSKjbi5xKanfwY3BVPzlmxxgZJpdxgCmW43wkoG89o+TIsb9sKJnsQ+Sqa1BGwUcDYVBnESH/oFbKGS2ZK8hUGrK/c7qLFfYi+KdItRsRrtppvl2q1cHcIMOi6TKjaFZXn0BxxX98f8aDWVzzbLjL4zrvO7KElHJze3qEJ4eCcLU2rZGoB7yPe6WMz5ZenCRNxpqyqK1PhcFOxIJmu6nfC720EeDqDdLs=
```
## Example Response Encrypted
```
{
    "status": "success",
    "message": "Payout batch created.",
    "data": "4+jRBKwFm6Ar9r9cHXIML1ehi+LkeOtmwPFdPY5yeVoG/RzJlLgQhPDAiKnRZySsVo7o31eusipVD1tW/C/685GT3w4MKOq2t22fUAS3U7+SQpKYiUzB+rFGcWRVVjiYdgI+vSb5E/yxjIvxehQMwgwLMRTmT5OBW7bcKdVB2RRXkg4tjPBfjHvNsIvxbjSlxi//3gfdZtP3n+93+DO33GMi6cPcwORKuSrdw6Lc07iS5LpTaSdD00SE/CVnBzsHgtll02c4F+iOCb4EZTLcT7QlycusR5fTzNBxFUfjx/djvrMpOUZ7rLIGRi2rQu0peDbg0E3nQYw4oayhY/I1r4xMxZQZO5DmN2HPVcCQ9xTuaSbttsRgmx5vxDczafvAObtOU36XETEvn0x3jnWco2czyUwnzl3IQGMKOv62sHm0PKAWQwb2A45XtZOHPYHmdVb+AedMuQo+qfHFhjbDnxHzrUtfMPtnA42LzbsYemiq3yD/rtT53A4ORr2WkVjB3oUu7DdkIrHknfut2XjtQrWBjgx2MpyB8ftOPtWOBWxqAnvRHe+PgoLqMO1y5JtgsF1TqhrQyr3n/wCdeqgelrqDIvYUIRDuRgHO53VCG3rbeEHR83czZjCoIw6AW20ihxf4liySsgb6Tf28maM0KbRI8GA20eY5+hvV2sA+rbwIEryIHyReET0LhQaupb3v3YfP4UJbjz51YABCRNiMmWvh8o9/k5jjnOMRhQ7wrcbuJ09fixPtU5hk2qIJuiby6mO4w2N4uiW+/4jCzbNnKcFZSm8Plz0y11Uu61YJe934k8AHv3E6Lza97GQ/Rd1ImDDpTJZahtgTqAqFTfJsSX7Q13ql3q8+CUbEjsJl+dmoXTv6BiDE6TfJ0z86HWZ1AvBfNhZM59/Dh2OQz0bppEr2X98Qt/FgpYSCKCrcP1dGp79vsNeINPjOPYI9X5YHhXWFYWtpi8zjlbgbQEkG16asC0dtQAAZp4icRGwu91z++2IBHP8CCxfPUGeOdjSvCjMKSonVApLwaYHms6y8H24gCftESWFz9/gVsKgBqFE="
}
```
## Response Decrypted
```
{
    "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"
            },
            {
                "transfer_number": "11",
                "amount": 1850,
                "payee_name": "Shivam Sharma",
                "payee_mobile": "9846030201",
                "currency": "INR",
                "partner_bank_id": "100",
                "bank_name": "ICICI",
                "bank_account_type": "savings",
                "bank_account_number": "56000673436565",
                "bank_ifsc": "ICIC001234",
                "transfer_mode": "IMPS",
                "status": "PENDING",
                "transfer_datetime": null,
                "utr_number": null,
                "fees": "0"
            }
        ]
    }
}
```