Core Resources

Customer Entity

Attribute

Type

Description

id

string

value of customer id

customer_id_type

string

type of customer id

state

integer

a value which signifies the current state of the customer

state_desc

string

description of the current state of customer

limit

array

signifies the amount available for the customer to transact in the month

balance

double

current balance of the customer

name

string

name of the customer

Recipient Entity

Attribute

Type

Description

recipient_id_type

string

can have 2 values

  1. acc_ifsc
  2. acc_bankcode

id

string

id of the recipient; needs to have the same format as mentioned in recipient_id_type

recipient_id

string

unique id of the recipient for the customer; this will be used in the transaction api

name

string

name of the recipient

recipient_mobile

integer

mobile number of the recipient

Transactions Entity

Attribute

Type

Description

tid

integer

unique transaction id on Eko platform

client_ref_id

string

unique tid on partner platform

timestamp

time at which transaction was done, should be in TZ format

currency

string

currency in which transaction is being processed

state

integer

signifies the state of the transaction

channel

integer

signifies the mode of transaction

refund_tid

integer

unique transaction id on Eko platform when a refund is done

Bank Entity

bank_code

string

short code for each bank

name

string

name of the bank

isverificationavailable

boolean

signifies availability of account name verification

ifsc_status

number

signifies if IFSC is required for addition of bank account number

code

string

short name of the bank