Load Card Balance - Enkash Developer Portal

Request

Header Params

authorization

string

required

Provide your bearer token in the Authorization header when making requests to protected resources.

Example:

Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

partnerId

string

required

PartnerID shared during sign-up

Example:

CRXXXXXXX

Body Params application/json

companyId

string

optional

Unique EnKash Company ID. This is the ID assigned to a company onboarded on the EnKash platform.

cardAccountId

string

optional

Unique EnKash Account ID. This is the ID assigned to the account created under the company.

createdBy

string

optional

Transaction created by user.

amount

number

required

Amount greater than 1

>= 0.01

transactionType

enum<string>

required

As it is update balance request type should be CR. (credit)
On this card DR (Debit) is not allowed.

Allowed values:

DRCR

description

string

optional

Description for the transaction.

type

enum<string>

optional

Type should be LOAD_MONEY.

Allowed values:

SALEREPAYMENTRECOVERYLOAD_MONEYREFUNDREVERSALCREDITFEEALLOCATE_FUNDUNALLOCATE_FUNDCASHBACKFUNDPOST_DEBITPAYOUTDISCOUNTOPEN_VOUCHERALLOCATE_POINTUNALLOCATE_POINTVA_UNALLOCATE_FUNDVA_ALLOCATE_FUNDEXCESS_LOADEXCESS_UNLOADALLOCATE_COIN

transactionCode

enum<string>

optional

Transaction code should be PRINCIPLE

Allowed values:

PRINCIPLEINTERESTFEEGSTREPAYMENTREVERSALALLOCATIONCASHBACKDISCOUNTPENAL_INTERESTPROCESSING_FEEPROCESSING_FEE_ADJUSTMENTNPA_INTEREST

uniqueReferenceNumber

string

optional

External reference number for the load money transaction.

remarks

string

optional

Remarks for the transaction

enKashCardId

string

required

Unique identifier for the EnKash card.

Example

{
    "companyId": "CEKEP5GSGP",
    "cardAccountId": "CABFIPS",
    "createdBy": "anay",
    "amount": 10,
    "transactionType": "CR",
    "description": "desc",
    "type": "ALLOCATE_FUND",
    "transactionCode": "ALLOCATION",
    "uniqueReferenceNumber": "Ref123",
    "remarks": "string",
    "enKashCardId": "EKCMB7KAEW"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v0/partner/enKashCard/balance' \
--header 'authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379' \
--header 'partnerId:  CRXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "companyId": "CEKEP5GSGP",
    "cardAccountId": "CABFIPS",
    "createdBy": "anay",
    "amount": 10,
    "transactionType": "CR",
    "description": "desc",
    "type": "ALLOCATE_FUND",
    "transactionCode": "ALLOCATION",
    "uniqueReferenceNumber": "Ref123",
    "remarks": "string",
    "enKashCardId": "EKCMB7KAEW"
}'

Responses

🟢200OK

application/json

Body

code

integer

required

message

string

required

payload

string

required

Example

{
    "code": 0,
    "message": "Success",
    "payload": "Funds allocated from Parent Account to Card by Admin successful"
}