Use this API to initiate a batch transfer request from your EnKash Payments account. This allows you to transfer funds to multiple beneficiaries simultaneously, streamlining bulk payouts and reducing manual effort.Batch transfers are ideal for scenarios like vendor payments, employee disbursements, or large-scale customer refunds.
Batch Payout Create Request
batchTransactionId
stringÂ
requiredThis signifies the unique identifier you create to distinguish the batch transfer request.
transfers
array[object (PayoutTransactionCreateRequest) {10}]Â
requiredIt is the unique ID you created to identify the beneficiary.
It is the unique ID you create to identify the transfer.
This represents the transfer amount, where decimal values are permitted. The minimum value must be equal to or greater than 1.00
transferMode
enum<string>Â
requiredThis denotes the transfer method. Permitted values include IMPS, NEFT, RTGS & UPI. The default transfer mode is NEFT.
Allowed values:IMPSNEFTRTGSUPI
This field allows for any additional remarks regarding the transfer. Alphanumeric characters and whitespaces are permitted.
This is unique reference that you can pass in request.
This represents the ID of the fund source from which the transfer amount will be debited.
beneficiaryDetail
object (BeneficiaryDetailCreateRequest)Â
optionalThis is checksum generated by you as per steps given in document.
debitAccountNumber
stringÂ
optionalThis is mandatory for connected banking payouts
Batch Payout Create Response
batchTransactionId
stringÂ
optionalThis signifies the unique identifier you created to distinguish the batch transfer request.
successfulPayoutTransactionCreateResponses
array[object (PayoutTransactionCreateResponse) {6}]Â
optionalList of successful transactions
It is the unique ID you created to identify the transfer.
enkashTransactionId
stringÂ
optionalThis is unique id generated by EnKash to identify payout
payoutStatus
enum<string>Â
optionalThis field displays the status of the transfer.
Allowed values:SUCCESSFAILEDPENDINGIN_PROGRESSPAIDON_HOLDNEFT_CALL_MADEIMPS_CALL_MADEREINITIATEAGENCY_PENDINGAX_BBPS_SUCCESSPG_SETTLEMENT_PENDINGUPI_CALL_MADE
createdOn
string <date-time>
optionalThis field displays the time when the transfer request was added to the system.
modifiedOn
string <date-time>
optionalThis field displays the updated time for the transfer.
This field displays the failure reason if any
failedPayoutTransactionCreateResponses
array[object (PayoutTransactionCreateResponse) {6}]Â
optionalList of failed transactions
It is the unique ID you created to identify the transfer.
enkashTransactionId
stringÂ
optionalThis is unique id generated by EnKash to identify payout
payoutStatus
enum<string>Â
optionalThis field displays the status of the transfer.
Allowed values:SUCCESSFAILEDPENDINGIN_PROGRESSPAIDON_HOLDNEFT_CALL_MADEIMPS_CALL_MADEREINITIATEAGENCY_PENDINGAX_BBPS_SUCCESSPG_SETTLEMENT_PENDINGUPI_CALL_MADE
createdOn
string <date-time>
optionalThis field displays the time when the transfer request was added to the system.
modifiedOn
string <date-time>
optionalThis field displays the updated time for the transfer.
This field displays the failure reason if any