Payouts Integration Steps
Integrating with Enkash’s Payout API
Setup API endpoints, obtaining credentials, and configuring your environment for seamless transactions. Follow the steps below to get started.
API Endpoints
Environment | Base URL |
---|---|
Test | https://ekpayout-uat.enkash.in |
Live | https://api.enkash.in |
Setup
[<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;"/>](https://app.getpostman.com/run-collection/19089-b05811fc-982e-4060-8acc-1c201a4c3f63?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D19089-b05811fc-982e-4060-8acc-1c201a4c3f63%26entityType%3Dcollection%26workspaceId%3Defb2e830-a170-4108-98d6-c6e5c2243a1c#?env%5BProduction%5D=W3sia2V5IjoidG9rZW4iLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiIiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6ImNvbGxlY3Rpb25OYW1lIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6MX0seyJrZXkiOiJjb2xsZWN0aW9uU2NoZW1hVXJsIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6Mn0seyJrZXkiOiJhY2Nlc3NLZXkiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiIiwic2Vzc2lvbkluZGV4IjozfSx7ImtleSI6IndvcmtzcGFjZUlkIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJjb2xsZWN0aW9uSWQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiIiwic2Vzc2lvbkluZGV4Ijo1fV0=)
:::info[Production]
Production keys will be provided after successfully completing test cases.
:::
Ensure your system’s IP addresses are whitelisted for both sandbox and production environments
APIs
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 from your records. |
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 | Retrieve the available balance in your payout account. |
Add Source Bank Account | Add a source bank account for payouts. |
Get Source Bank Account Details | Fetch details of your linked bank account. |
Best Practices
- Encrypt API Request Payloads: Ensure sensitive data is encrypted before sending requests.
- Decrypt API Responses: Decrypt responses upon receipt to protect transaction data integrity.
Follow the steps outlined in Encrypting and Decrypting Payload.
Last modified: a month ago