Payout APIs - Enkash Developer Portal

Set up API endpoints, obtain credentials, and configure your environment for seamless transfers. Follow the steps below to get started.

API Endpoints

Environment	Base URL
Test	`https://ekpayout-uat.enkash.in`
Live	`https://api.enkash.in`

Setup Guide

Download Postman Collection

Click below to access the pre-configured Postman collection for testing API requests:

Configure API Endpoints

Set the appropriate base URL (Test or Live) in your API client or environment file.

Obtain API Keys, Client ID & Secret

Sandbox (test) API keys will be emailed to you upon onboarding.

Whitelist Your IP

Ensure your system’s IP addresses are whitelisted for both sandbox and production environments.

Production keys
Will be provided after successfully completing your sandbox test cases

APIs Available

Authentication API

API Name	Function
Get Authentication Token	Retrieve an authentication token for secure API access

Beneficiary APIs

API Name	Function
Create Beneficiary	Add a new beneficiary
Search Beneficiary	Search for an existing beneficiary
Delete Beneficiary	Delete a beneficiary

Transfer APIs

API Name	Function
Create Payout	Initiate a single payout transaction
Create Batch Payout	Create a batch for multiple payouts
Search Payouts	Search for payout transactions

Account APIs

API Name	Function
Get Account Balance	Check available payout account balance
Add Source Bank Account	Add a source bank account for payouts
Get Source Bank Account Details	Fetch details of linked bank accounts

Payout API Response Codes

Enkash’s Payout API provides response codes to indicate the outcome of API requests, ensuring clear communication and efficient error handling. Properly handling these codes is essential for seamless integration.

Response Codes

Code	Description
0	Success.
1	Failure.
403	APIs not enabled.
403	Encryption failed for response.
409	Beneficiary ID already exists.
409	Transaction ID already exists.
409	Batch Transaction ID already exists.
412	Bank account and IFSC both are required.
412	Invalid nodal bank in request.
412	Invalid checksum in the request.
412	Invalid Company ID.
412	Bank account and VPA both provided. Provide only one to add the beneficiary.
422	Invalid encrypted request.
422	Invalid request format.
422	Invalid Client ID.
422	Please provide a valid Beneficiary ID.
422	Please provide a valid name.
422	Please provide a valid Virtual Payee Address (VPA).
422	Invalid or missing parameter in the request.
422	No beneficiary details present.
422	Please provide a valid email.
422	Please provide a valid phone number.

Integration Note:
Ensure your application handles all these response codes effectively

Common Scenarios

Duplicate Entries

409: If a Beneficiary ID, Transaction ID, or Batch Transaction ID already exists, avoid duplicates by checking beforehand.

Validation Errors

422: Ensure all required fields (Beneficiary ID, name, email, phone number, VPA) are validated before sending the request.

Missing or Incorrect Parameters

412 / 422: Verify that the request has all mandatory parameters and follows the correct format.

Example Error Handling

{
  "code": 412,
  "message": "Bank account and IFSC both are required."
}

Action: Ensure both bank account details and the IFSC code are present in your request to proceed

Best Practices

Encrypt API Request Payloads: Always encrypt sensitive data before sending requests.

Decrypt API Responses: Decrypt responses immediately upon receipt to ensure data integrity.

Integrating with Enkash’s Payout API

API Endpoints#

Setup Guide#

APIs Available#

Payout API Response Codes#

Common Scenarios#

Best Practices#

API Endpoints

Setup Guide

APIs Available

Payout API Response Codes

Common Scenarios

Best Practices