Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Transfer Apis
  • Payouts Overview
  • Payouts Sign Up
  • Payout Methods
  • Payout API Response Codes
  • Payouts Integration Steps
  • Encrypting and Decrypting Payload
  • Payouts Status Codes
  • Get Authentication Token
    • Get Authentication Token
  • Beneficiary Apis
    • Create Beneficiary
    • Search Beneficiary
    • Delete Beneficiary
  • Transfer Apis
    • Create Payout
      POST
    • Search Payouts
      POST
    • Create Batch Payout
      POST
  • Payout Account Apis
    • Get Balance
    • Get Source Bank Account Details
    • Add Source Bank Account
    • Fetch Bank Statement
  • Webhook Data Apis
    • Get Webhook Data
    • Create Webhook Data
  1. Transfer Apis

Create Batch Payout

POST
/api/v0/payout-transaction/batch
Payout Transaction Apis
Employ this API to initiate a batch transfer request at EnKash Payments. This facilitates transferring money to multiple beneficiaries simultaneously.
Batch Payout Create Request
batchTransactionId
string 
required
This signifies the unique identifier you create to distinguish the batch transfer request.
transfers
array[object (PayoutTransactionCreateRequest) {10}] 
required
beneficiaryId
string 
optional
It is the unique ID you created to identify the beneficiary.
transactionId
string 
required
It is the unique ID you create to identify the transfer.
transferAmount
number 
required
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> 
required
This denotes the transfer method. Permitted values include IMPS, NEFT, RTGS & UPI. The default transfer mode is NEFT.
Allowed values:
IMPSNEFTRTGSUPI
transferRemark
string 
optional
This field allows for any additional remarks regarding the transfer. Alphanumeric characters and whitespaces are permitted.
reference
string 
optional
This is unique reference that you can pass in request.
fundSourceId
string 
required
This represents the ID of the fund source from which the transfer amount will be debited.
beneficiaryDetail
object (BeneficiaryDetailCreateRequest) 
optional
checksum
string 
optional
This is checksum generated by you as per steps given in document.
debitAccountNumber
string 
optional
This is mandatory for connected banking payouts
Batch Payout Create Response
batchTransactionId
string 
optional
This signifies the unique identifier you created to distinguish the batch transfer request.
successfulPayoutTransactionCreateResponses
array[object (PayoutTransactionCreateResponse) {6}] 
optional
List of successful transactions
transactionId
string 
optional
It is the unique ID you created to identify the transfer.
enkashTransactionId
string 
optional
This is unique id generated by EnKash to identify payout
payoutStatus
enum<string> 
optional
This 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>
optional
This field displays the time when the transfer request was added to the system.
modifiedOn
string <date-time>
optional
This field displays the updated time for the transfer.
failureReason
string 
optional
This field displays the failure reason if any
failedPayoutTransactionCreateResponses
array[object (PayoutTransactionCreateResponse) {6}] 
optional
List of failed transactions
transactionId
string 
optional
It is the unique ID you created to identify the transfer.
enkashTransactionId
string 
optional
This is unique id generated by EnKash to identify payout
payoutStatus
enum<string> 
optional
This 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>
optional
This field displays the time when the transfer request was added to the system.
modifiedOn
string <date-time>
optional
This field displays the updated time for the transfer.
failureReason
string 
optional
This field displays the failure reason if any
status
string 
optional

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
clientId
string 
required
Example:
CEKFOWV7UQ
User-Agent
string 
required
Body Params application/json
request
string 
required
Encrypted request payload string
Example
{
    "request": "KqCNE+rZN5vcHyA60aVYsJI60q2ATQmb3edP5XqrkwYnIP0plypV4rXZYNc/JjdaIrzAihbNmR7ebT4R741qbX1JJQoaBSnH7QUzP20ZHVlNqJeyA+P7l429AZzIt5snBE/d8VMm7bm8VzMKZRFo/eNMnGdTygvxmPOPPhcx/B9t+8XmEDX/sfZQWpXQheNoVHhSUlw4EgcVnyjoXgYtA0xiRiAAe9oiWOWYdwlekXz2YDhE3x4snQ423Uzifvne7zgnO2/0+Cut8xObmDceZ27R3SMp7Hf9+lsLomdANCO3SbfDt6a88M+OWSM5Mkg7+HhH0kh/3gMXnGeZkqETWt7YRFLs1HUhY+JGBn3F/gmrCDjSwaD7o7nOQL/HQk7vhSUMauEFK3oR4886OVFoVKoxNiMIzL7Sy+u8cw2OlBrMJrdUZqbAwV4zqWaNEd2hppPk+ZSyKqNHn4PmaTcrboUyao71Xjn2lUgqOWaG+B+9IoWOdgkNSXxbTiBowtdmLnsxm+xVfaGOskjRrBLRyWfDLGbMoB6RBGOaXwM2Tg+9OJctpBsKrs5e/dzdkl7CIWpb/tk767lwR7qocPi4JUQShr+MdAGUjP3hXakgXAeuz3eW+h2CxAvpLecqAK+ubfvF5hA1/7H2UFqV0IXjaFR4UlJcOBIHFZ8o6F4GLQOznR3H5XgzYtzR7QcHFXwy9mA4RN8eLJ0ONt1M4n753u84Jztv9PgrrfMTm5g3HmdS1pUXZCPkF9xVMQueYYbmUKfMpD5fyc6ifsVDDzx4gg=="
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/api/v0/payout-transaction/batch' \
--header 'clientId: CEKFOWV7UQ' \
--header 'User-Agent;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request": "KqCNE+rZN5vcHyA60aVYsJI60q2ATQmb3edP5XqrkwYnIP0plypV4rXZYNc/JjdaIrzAihbNmR7ebT4R741qbX1JJQoaBSnH7QUzP20ZHVlNqJeyA+P7l429AZzIt5snBE/d8VMm7bm8VzMKZRFo/eNMnGdTygvxmPOPPhcx/B9t+8XmEDX/sfZQWpXQheNoVHhSUlw4EgcVnyjoXgYtA0xiRiAAe9oiWOWYdwlekXz2YDhE3x4snQ423Uzifvne7zgnO2/0+Cut8xObmDceZ27R3SMp7Hf9+lsLomdANCO3SbfDt6a88M+OWSM5Mkg7+HhH0kh/3gMXnGeZkqETWt7YRFLs1HUhY+JGBn3F/gmrCDjSwaD7o7nOQL/HQk7vhSUMauEFK3oR4886OVFoVKoxNiMIzL7Sy+u8cw2OlBrMJrdUZqbAwV4zqWaNEd2hppPk+ZSyKqNHn4PmaTcrboUyao71Xjn2lUgqOWaG+B+9IoWOdgkNSXxbTiBowtdmLnsxm+xVfaGOskjRrBLRyWfDLGbMoB6RBGOaXwM2Tg+9OJctpBsKrs5e/dzdkl7CIWpb/tk767lwR7qocPi4JUQShr+MdAGUjP3hXakgXAeuz3eW+h2CxAvpLecqAK+ubfvF5hA1/7H2UFqV0IXjaFR4UlJcOBIHFZ8o6F4GLQOznR3H5XgzYtzR7QcHFXwy9mA4RN8eLJ0ONt1M4n753u84Jztv9PgrrfMTm5g3HmdS1pUXZCPkF9xVMQueYYbmUKfMpD5fyc6ifsVDDzx4gg=="
}'

Responses

🟢200OK
application/json
Body
response_code
integer <int32>
optional
response_message
string 
optional
payload
string 
optional
Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": "string"
}
Modified at 2024-10-14 09:16:57
Previous
Search Payouts
Next
Get Balance
Built with