Integration flow, Core APIs and SSO Setup

Enable seamless reward disbursals using EnKash’s APIs. This page covers the integration flow, core APIs, and SSO setup to help you launch quickly and securely.

Integration Flow

Steps Involved

Obtain Access Token

Authenticate via the Client Authentication API to receive your access_token.

Set Headers & Token

For each API request, use the Authorization header with the access token.

Get Reward Account Details

Use Get Reward Account Details to fetch balance and account info.

Create or Allocate Rewards

Call Create and Allocate Points to fund the user’s reward card.

Security Notes

Encrypted Requests are mandatory using the AES encryption logic.

Success Indicators

HTTP Status	response_code	Meaning	Action
`200 OK`	`0`	Success	Proceed with response payload
`200 OK`	`1`	Failure	Check `response_message` for details

Example

{
  "response_code": 1,
  "response_message": "Insufficient balance in card account",
  "payload": "Insufficient balance in card account"
}

otbBalance field shows the current reward card balance available for redemption.

Core APIs

API	Description
Get Card Account Details	Fetch balance and user-specific card account info.
Create & Allocate Points	Create or reallocate reward cards and assign points.
SSO Login	Generate one-click login token for reward access.
Get Transaction Details	View transaction history and status.
Search Enkash Card	Look up specific user card details.
Bulk Create & Allocate Points	Create and fund multiple cards in one go.

SSO Integration

For Employee

Get Access Token Via SSO Login APIs

here

Embed this redirect URL on your portal

https://invoice-uat.enkash.in/sso/{access_token}/employee_rewards/{partner}

Placeholder	Description
`{access_token}`	Token obtained from the SSO API
`{partner}`	Your partner identifier (e.g., `hrms`)

Example

   `https://invoice-uat.enkash.in/sso/aF5V6hPScEd9mCowJmbZFKk5Xg/employee_rewards/hrms`

For HR Admin

https://invoice-uat.enkash.in/sso/{access_token}/reward_account/{partner}

In production, replace invoice-uat.enkash.in with home.enkash.com

Common Fields Passed

Parameter	Description
`companyId`	Unique EnKash Company ID provided to the client after onboarding.
`cardAccountId`	Unique EnKash Reward Account ID assigned to the client post onboarding.
`partnerId`	Unique Partner ID issued to the client during the onboarding process.
`enkashCardId`	System-generated unique ID for each EnKash card.
`enkashCardTransactionId`	Unique ID associated with each transaction made using an EnKash card.

HTTP Response Codes

Code	Message	Description
200	Success	API executed successfully
400	Bad Request	Invalid/missing parameters
422	Unprocessable Entity	Invalid data or failed validation
404	Not Found	Entity not found in the system
500	Server Error	Internal error on EnKash servers

Integration flow, Core APIs and SSO Setup