Create Payout

Use this API to initiate an amount transfer at EnKash Payments.

PayoutTransactionCreateRequest

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

optional

This represents the ID of the fund source from which the transfer amount will be debited.

beneficiaryDetail

object (BeneficiaryDetailCreateRequest)

optional

vpaHandle

string

optional

Match pattern:

^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+$

beneficiaryId

string

required

beneficiaryName

string

required

beneficiaryAccountNumber

string

optional

beneficiaryIfsc

string

optional

Match pattern:

^[A-Za-z]{4}0[A-Z0-9a-z]{6}$

beneficiaryEmail

string

optional

Match pattern:

(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)])

beneficiaryPhone

string

optional

Match pattern:

^((\+|00)(\d{1,3})[\s-]?)?(\d{10})$

beneficiaryAddress

string

optional

beneficiaryCity

string

optional

beneficiaryState

string

optional

checksum

string

optional

beneficiaryPincode

string

optional

Match pattern:

\b\d{6}\b

nodalBank

enum<string>

optional

Allowed values:

KOTAKHDFCAXISICICIAU_BANKAXIS_NBSPLAXIS_NTSPLTEST_BANK

clientId

string

optional

checksum

string

optional

This is checksum generated by you as per steps given in document.

nodalBank

enum<string>

optional

Allowed values:

KOTAKHDFCAXISICICIAU_BANKAXIS_NBSPLAXIS_NTSPLTEST_BANK

clientId

string

optional

PayoutTransactionCreateResponse

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

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": "HkKZfu8K7vljI3a7FZuko6mzmh0NEuH0mcwK5hGbYzU4Fi6Uv/raO4tdg3Blxlpz6KWUmUET9A9fJFe/mrHnFlK3PZtv0sDELcUbyaZ1R/fniYUINbfzW0dnPooWsyKmaf5aj8ja9lEp8jt1NhbPWs5FLjJilltzZIzm8UyxB/eG44FI7wbEkEywYSLYN6DeWGT6q+axiHcmh3cWqfIjt48ZfLjj35z9nkmbH8a9eEEA1U/avn/MtaIBFuBUuYD+"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

string

optional

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": "string"
}

Request

Request samples

Responses