Enkash Developer Portal
Home
Home
Login
  1. Home
  • Back to home
  • Payout APIs
  • Encryption & Decryption Guide
    • Generate Authentication Token
  • Beneficiary
    • Add Beneficiary
    • Search Beneficiary
    • Delete Beneficiary
  • Transfer
    • Initiate Transfer
    • Initiate Batch Transfer
    • Search Payout Transfers
  • Bank Details
    • Retrieve Account Balance
    • Retrieve Bank Account Details
    • Add Funds to EnKash
    • Fetch Statement
  • Webhook
    • Create Webhook Configuration
    • Retrieve Webhook Data
  1. Home

Integrating with Enkash’s Payout API

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

API Endpoints#

EnvironmentBase URL
Testhttps://ekpayout-uat.enkash.in
Livehttps://api.enkash.in

Setup Guide#

1
Download Postman Collection
Click below to access the pre-configured Postman collection for testing API requests:
Run in Postman
2
Configure API Endpoints
Set the appropriate base URL (Test or Live) in your API client or environment file.
3
Obtain API Keys, Client ID & Secret
Sandbox (test) API keys will be emailed to you upon onboarding.
4
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 NameFunction
Get Authentication TokenRetrieve an authentication token for secure API access
Beneficiary APIs
API NameFunction
Create BeneficiaryAdd a new beneficiary
Search BeneficiarySearch for an existing beneficiary
Delete BeneficiaryDelete a beneficiary
Transfer APIs
API NameFunction
Create PayoutInitiate a single payout transaction
Create Batch PayoutCreate a batch for multiple payouts
Search PayoutsSearch for payout transactions
Account APIs
API NameFunction
Get Account BalanceCheck available payout account balance
Add Source Bank AccountAdd a source bank account for payouts
Get Source Bank Account DetailsFetch 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
CodeDescription
0Success.
1Failure.
403APIs not enabled.
403Encryption failed for response.
409Beneficiary ID already exists.
409Transaction ID already exists.
409Batch Transaction ID already exists.
412Bank account and IFSC both are required.
412Invalid nodal bank in request.
412Invalid checksum in the request.
412Invalid Company ID.
412Bank account and VPA both provided. Provide only one to add the beneficiary.
422Invalid encrypted request.
422Invalid request format.
422Invalid Client ID.
422Please provide a valid Beneficiary ID.
422Please provide a valid name.
422Please provide a valid Virtual Payee Address (VPA).
422Invalid or missing parameter in the request.
422No beneficiary details present.
422Please provide a valid email.
422Please provide a valid phone number.
Integration Note:
Ensure your application handles all these response codes effectively

Common Scenarios#

1.
Duplicate Entries
409: If a Beneficiary ID, Transaction ID, or Batch Transaction ID already exists, avoid duplicates by checking beforehand.
2.
Validation Errors
422: Ensure all required fields (Beneficiary ID, name, email, phone number, VPA) are validated before sending the request.
3.
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.
Modified at 2025-07-07 17:52:15
Built with