Add Recipient

put

https://staging.eko.in/ekoapi/v2/customers/{customer_id_type}:{customer_id}/recipients/{recipients_id_type}:{id}

Add a new recipient or update an existing recipient for a customer

👍
PUT
/customers/:customer_id_type::customer_id/recipients/:recipients_id_type::id
eg: /customers/mobile_number:9876543210/recipients/acc_ifsc:61046336411_sbin0000001

📘
Note - The maximum recipient addition limit in a day is 5

docs.google.com

Bank List

Path Params

customer_id_type

string

required

Defaults to mobile_number

Fixed type for remittance

customer_id

int32

required

id of the customer; currently only mobile number of the customer can be used

recipient_id_type

string

required

recipient_id_type can have the following parameters: a) acc_ifsc b) acc_bankcode (only applicable when IMPS service is available and IFSC is not required). For bankcode refer to bank list attached below

string

required

This should be the value according to the recipient_id_type format.

Form Data

initiator_id

int32

required

The unique cell number with which you are onboarded on Eko's platform. For UAT refer to [Platform Credentials] (https://developers.eko.in/docs/platform-credentials)

bank_id

int32

required

a unique id for each bank has been allocated and that has to passed here. Refer to the bank list attached below

recipient_name

string

required

name of the recipient

recipient_mobile

int32

required

Valid mobile number of the recipient

recipient_type

int32

required

Defaults to 3

value will be 3

user_code

string

required

User code value of the retailer from whom the request is coming

Headers

developer_key

string

required

Your unique API key that will authenticate your request. For UAT, refer to [Platform Credentials] (https://developers.eko.in/docs/platform-credentials)

secret-key

string

required

Refer to [authentication section] (https://developers.eko.in/docs/authentication)

secret-key-timestamp

string

required

Refer to [authentication section] (https://developers.eko.in/docs/authentication)

Response

Add Recipient

👍
PUT

eg: /customers/mobile_number:9876543210/recipients/acc_ifsc:61046336411_sbin0000001

📘

👍PUT

eg: /customers/mobile_number:9876543210/recipients/acc_ifsc:61046336411_sbin0000001

📘

200200

👍
PUT