--- 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 (1-25) | Unique code of the payout batch | `BTCH20260806TS2` | | batch_name required | Alphanumeric (1-100) | Name of the batch | `Test 06 Aug 2026 TS2` | | created_datetime required | DateTime | Batch creation date and time (Y-m-d H:i:s) | `2022-07-24 18:05:43` | | transfers required | Array | Array of transfer data blocks | `[{...}]` | | transfer_number required | Alphanumeric (1-10) | Unique id of the transfer in the batch | `1` | | UID required | Alphanumeric (1-50) | Custom variable from partner | `Samuel` | | payee_name required | Alphanumeric (1-100) | Name of the payee | `Tom AB` | | payee_mobile required | Numeric (10-15) | Mobile number of the payee | `71234876566` | | payee_email optional | String | Payee email address | `sample@example.com` | | bank_name required | Alphanumeric (1-50) | Beneficiary bank name | `HDFC` | | account_type required | Alphanumeric | Beneficiary account type | `Saving` | | bank_account_id required | Alphanumeric (1-30) | Beneficiary account identifier | `00123410001234` | | bank_ifsc required | Alphanumeric (1-15) | Beneficiary bank IFSC code | `HDFC0000080` | | order_id optional | Alphanumeric (1-50) | Merchant order ID for reconciliation | `ord2026080602` | | currency required | Alphanumeric (3) | Currency code. Default value "INR" | `INR` | | amount required | Numeric | Amount to transfer | `2.00` | | transfer_mode required | Alphanumeric | NEFT / IMPS | `NEFT` | | upi_id optional | String | UPI identifier, if applicable | `` | | remarks required | String | Required remarks for the transfer | `Test Txn` | | pan_number optional | Alphanumeric (10) | Payee PAN number | `ABCS0123A` | ## 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 { "batch_code": "BTCH20260806TS2", "batch_name": "Test 06 Aug 2026 TS2", "created_datetime": "2022-07-24 18:05:43", "transfers": [ { "transfer_number": "1", "UID": "Samuel", "payee_name": "Tom AB", "payee_mobile": "71234876566", "payee_email": "sample@example.com", "bank_name": "HDFC", "account_type": "Saving", "bank_account_id": "00123410001234", "bank_ifsc": "HDFC0000080", "order_id": "ord2026080602", "currency": "INR", "amount": 2.0, "transfer_mode": "NEFT", "upi_id": "", "remarks": "Test Txn", "pan_number": "ABCS0123A" }, { "transfer_number": "2", "UID": "Ravi", "payee_name": "Ravi Kumar", "payee_mobile": "9876543210", "payee_email": "dummy@example.com", "bank_name": "ICICI", "account_type": "Current", "bank_account_id": "00123420001234", "bank_ifsc": "ICIC0000123", "order_id": "ord2026080603", "currency": "INR", "amount": 500.5, "transfer_mode": "IMPS", "upi_id": "ravi@icici", "remarks": "Second test transaction", "pan_number": "ABCD1234E" } ] } ``` ### Success Response (Decrypted) ```json { "status": "success", "message": "Payout batch created.", "data": { "code": "BTCH20260806TS2", "name": "Test 06 Aug 2026 TS2", "created_datetime": "2022-07-24 18:05:43", "transfers": [ { "transfer_number": "1", "UID": "Samuel", "payee_name": "Tom AB", "payee_mobile": "71234876566", "payee_email": "sample@example.com", "bank_name": "HDFC", "account_type": "Saving", "bank_account_id": "00123410001234", "bank_ifsc": "HDFC0000080", "order_id": "ord2026080602", "currency": "INR", "amount": 2.0, "transfer_mode": "NEFT", "upi_id": "", "remarks": "Test Txn", "pan_number": "ABCS0123A", "status": "PENDING", "transfer_datetime": null, "utr_number": null, "fees": 0 }, { "transfer_number": "2", "UID": "Ravi", "payee_name": "Ravi Kumar", "payee_mobile": "9876543210", "payee_email": "dummy@example.com", "bank_name": "ICICI", "account_type": "Current", "bank_account_id": "00123420001234", "bank_ifsc": "ICIC0000123", "order_id": "ord2026080603", "currency": "INR", "amount": 500.5, "transfer_mode": "IMPS", "upi_id": "ravi@icici", "remarks": "Second test transaction", "pan_number": "ABCD1234E", "status": "PENDING", "transfer_datetime": null, "utr_number": null, "fees": 0 } ] } } ```