Enkash Developer Portal
Home
Home
Login
  1. Point Management
  • Back to home
  • Reward APIs
  • Token APIs
    • Authentication
    • Single Sign On (SSO)
  • Reward Allocation
    • Create And Allocate Points
    • Bulk Create And Allocate Rewards
    • Get Reward Account Details
    • Get Reward Transaction Details
    • Get User Details
    • Get User Card Details
  • Incentive Allocation
    • Incentive Create And Allocation
    • Get Incentive Transaction details
    • Get User Details
  • Redemption
    • User Authentication
    • Get Cart for User
    • Search Catalog
    • Get Product Catalog Details
    • Get Product Configs (Denominations)
    • Add to cart
    • Update Cart
    • Create Order
    • Order Search
    • create order
    • Fetch Order Info by Partner order Reference id
  • Point Management
    • Overview
    • Create Event
      POST
    • Get Event
      GET
    • Update Event
      PATCH
    • Allocate Coins
      POST
    • Get Balance
      GET
  1. Point Management

Allocate Coins

Developing
POST
/api/v0/enkash-coins/allocate-coin
This API facilitates the allocation of Coins according to the event configured.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
authorization
string 
required
Example:
Bearer oBPOndfOxpjOvReBnipyNdUuqB4
Content-Type
string 
required
Example:
application/json
Body Params application/json
companyId
string 
required
Company ID of the user to which coins are allocated
event
string 
required
Event Name
requestId
string 
required
Unique Request ID For coins allocation
userId
string 
required
User ID of user for which coins are allocated
Example
{ "companyId": "CEK0TCW2W8", "event": "REFERRAL_EVENT", "requestId": "COIN_REQ1234567", "userId": "EKQZVMQK"}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/api/v0/enkash-coins/allocate-coin' \
--header 'authorization: Bearer oBPOndfOxpjOvReBnipyNdUuqB4' \
--header 'Content-Type: application/json' \
--data-raw '{ "companyId": "CEK0TCW2W8", "event": "REFERRAL_EVENT", "requestId": "COIN_REQ1234567", "userId": "EKQZVMQK"}'

Responses

🟢200Success
application/json
Body
payload
string 
required
response_code
integer 
required
response_message
string 
required
Example
{"payload":"Successfully allocated enkash Coins","response_code":0,"response_message":"Success"}
Modified at 2025-01-08 07:38:04
Previous
Update Event
Next
Get Balance
Built with