Get Payout Batch Details

This API is used by merchant to get the details of a payout batch with the status of each payout request in the batch. We will get response with the details of the amount, payee details, bank details and status of the transaction.

GET

http://kraken.airpay.co.in:8000/payout/partner/payout-batches/{batchCode}

Header

Field	Type	Description
Content-Type	String	application/json
Authorization	String	Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Header-Example:

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

Request-Example

HTTP get

GET 'partner/payout-batches{batchCode}'

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[created_datetime]	DateTime	Batch created date time (Y-m-d H:i:s)
data[transfers]	Array	Transfer data block
transfers[transfer_number]	Alphanumeric	Unique id of the transfer in the batch
transfers[UID]	Alphanumeric	Custom variable from partner
transfers[amount]	Numeric	Transfer Amount
transfers[payee_name]	Alphanumeric	Name of the payee
transfers[payee_mobile]	Numeric	Mobile number of the payee
transfers[currency]	Alphanumeric	Currency code
transfers[partner_bank_id]	Numeric	Partner bank account id
transfers[bank_name]	Alphanumeric	Beneficiary bank name
transfers[bank_account_type]	Alphanumeric	Savings / current
transfers[bank_account_number]	Alphanumeric	Beneficiary bank account number
transfers[bank_ifsc]	Alphanumeric	Beneficiary bank IFSC code
transfers[status]	Alphanumeric	Transfer status
transfers[transfer_datetime]	DateTime	Transfer date and time (Y-m-d H:i:s)
transfers[utr_number]	Alphanumeric	UTR / RRN number
transfers[fees]	Numeric	Transfer charge (If transfer status is SUCCESS)

Example Response Encrypted

{
    "status": "success",
    "message": "Payout batch",
    "data": "sXjZXf3ziqG25nm3w7plAzOIolkIGbwf/hcuog611v70blOZj7Jeff4DT1suAyQF5fa0ujZKVrYtIYj7HmfrIV7IbKAKFb70rV4bLMaYqPr13VniptNg7Xm62745yZX8+wyqMQfEAWfFx6ANLUTVJ/rIV2pelqA+Rhtq/kd3NE/PZEMRbSfkiCgC16T34+NtCpameob9a1AvFB4M2DNTI2DmvEFaZn+j3y5PB/jz+xDg0bKQA6FBTuqY3bmbyg/L2II/zXC9Kci4goyDWDPzEBvVl/jTNKZi80rNSvhiFjQE4Gyo4BCs+pOt3oxv0NCkfWw4mtEjSpm+EEZEtyeXFbm1lQIWAwBDHg+r0Vblc27mpS4G7F/0VtSEqPIs0uli34WXjHSQBqmwrSBqjYNNTysXNmkNO7MaiJTMguAF13zbcX4K9wLrAPQ6fO20J3e8gipc3TcgAZK2MVa9vuQYm7fQYxfMcrK+pcuevbrQTYgE+zFzsQT/guDsQTJF0Z0lIxa2XW8UhnnnVakWybnK2ZM5qfUbJ4J/BaEdI2M/uYHp7G2m+XaIXwGEBHn2AyXyi3VmK7VpL8NGucMfT6U1LKrAVdtYnipW8BTuM0HbwWDMjShfT5CjMBTCYC36eM6Zu9DQQZ4FZ/wY7kpw6BMXaS4P6FogdjflLUdigOnbLwcZhJ4zl4d4nZx/KAAoj2Kihb11kW0vf7yoqggd4hGaJNhIInhHcXllL+kgMG2o2Eb2odwLdiyy+k19GdGxDmsZebXPN0J2upbnG6vpzO8NDBK19VffbrqZkPb7eDG1t5pKKELrOyuf7fACi0hw4jcqiLrJuSPj7DTQ3/q2LQgGhNCEpA2lMn2PtVyqxfZOvnGB9NBwiLKmgJO+zEsPKYuxOk2oNs8/U+gz70UPp7Xge4q51c4yNI/2PXT0f60Q6FEgEYbxMMWmb2eCIvxCHoJ2C5nNbgUU3kUWc+L8P+HiT3nzy+JSgYoRJIarJJNveKKGtyW8mCLjhzYmvXh3W2ft"
}

Response Decrypted

{
"status": "success",
"message": "Payout batch",
"data": {
"code": "2022JAN",
"name": "Affiliate Payout Batch of January 2022"
"created_datetime": "2022-02-12 20:03:33",
"transfers": [
{
"transfer_number": "10",
"UID": "USER1",
"amount": 500,
"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"
"status": "PENDING",
"transfer_datetime": null,
"utr_number": null,
"fees": 0
},
{
"transfer_number": "11",
"UID": null,
"amount": 850
"payee_name": "Shivam Sharma",
"payee_mobile": "9846030201",
"currency": "INR",
"partner_bank_id": "100",
"bank_name": "ICICI",
"bank_account_type": "savings"
"bank_account_number": "580002379833",
"bank_ifsc": "ICIC0002186",
"status": "PENDING",
"transfer_datetime": null,
"utr_number": null,
"fees": 0
}
]
}
}