Enkash APIs

Update Event

Developing

PATCH

/api/v0/enkash-coins/{coinConfigId}

Update Coin Event Configuration

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

coinConfigId

string

required

Coin Configuration ID

Example:

WCC12345

Header Params

Content-Type

string

required

Example:

application/json

string

required

Example:

_cfuvid=HYP8bzh65tyJdOQA3SszmnkR5ESGtAs.KQDRP5INTTg-1720761030734-0.0.1.1-604800000; JSESSIONID=2965781B20AA96A7AA6BF5631B3BBDD8

Body Params application/json

amount

integer

optional

amount for coins

configuration

object

optional

To be kept as CUSTOM enum.

CUSTOM

string

required

companyId

string

optional

Company Id of the company for which coin event is configured

event

string

optional

Event Name

Example

{
  "amount": 10,
  "configuration": "DEFAULT"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://test.your-api-server.com/api/v0/enkash-coins/WCC12345' \
--header 'Cookie: _cfuvid=HYP8bzh65tyJdOQA3SszmnkR5ESGtAs.KQDRP5INTTg-1720761030734-0.0.1.1-604800000; JSESSIONID=2965781B20AA96A7AA6BF5631B3BBDD8' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 10,
    "configuration" : "DEFAULT"
}'

Responses

🟢200Success

application/json

Body

payload

object

required

coinConfigId

string

required

configuration

string

required

event

string

required

amount

integer

required

response_code

integer

required

response_message

string

required

Example

{
  "payload": {
    "coinConfigId": "WCC024845",
    "configuration": "DEFAULT",
    "event": "INVOICE_PAYMENT",
    "amount": 10
  },
  "response_code": 0,
  "response_message": "Success"
}

Modified at 2025-01-08 07:37:33

Get Event

Allocate Coins