POSTGenerate Add Recipient Bank OTP

Generate an OTP to register a recipient's bank for a DigiKhata sender.

POST/customer/payment/ppi-digikhata/sender/{customer_id}/recipient/bank/otp

Initiates bank registration for a recipient and dispatches an OTP. Returns a beneficiary_id and otp_ref_id to pass into Validate OTP to Add Recipient. The bank enforces a one-hour cooling period per recipient before another bank account can be registered.

Request

Path parameters

Field	Type	Required	Description
`customer_id`	string	required	Sender's 10-digit mobile number.e.g. 8617567988

customer_idstringRequired

Sender's 10-digit mobile number.

example: 8617567988

Body parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`client_ref_id`	string	optional	Unique reference ID per API call, generated by your system (max 20 characters).e.g. 2026010100123456789
`recipient_id`	string	required	Recipient ID of the recipient to register a bank for.e.g. 10017740

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

client_ref_idstringoptional

Unique reference ID per API call, generated by your system (max 20 characters).

example: 2026010100123456789

recipient_idstringRequired

Recipient ID of the recipient to register a bank for.

example: 10017740

These headers authenticate and sign every request. See How Auth Works for details.

Field	Type	Required	Description
`developer_key`	string	required	Static API key issued to your account after KYC.
`secret-key`	string	required	Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
`secret-key-timestamp`	string	required	Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
`content-type`	string	required	application/jsone.g. application/json

developer_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

Responses

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
response_type_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobject
API-specific response payload.
- beneficiary_idstring
  Beneficiary identifier created for the recipient bank.
- otp_ref_idstring
  OTP session reference — pass to Validate OTP to Add Recipient.

Next steps

NextPOSTValidate OTP to Add RecipientVerify the OTP to complete recipient bank registration for a DigiKhata sender.

import { EpsClient } from "@ekoindia/eps-sdk";

const client = new EpsClient({

developerKey: process.env.EPS_DEVELOPER_KEY,

accessKey: process.env.EPS_ACCESS_KEY,

initiatorId: "9962981729",

environment: "sandbox",

});

const result = await client.call("ppi-digikhata-recipient-bank-otp", {

"customer_id": "8617567988",

"recipient_id": "10017740"

});

console.log(result);

{

"response_status_id": 0,

"data": {

"beneficiary_id": "4202888",

"recipient_name": "",

"ifsc": "",

"account": "",

"otp_ref_id": "8617567988~8617567988~Channel4~4202888~4202888",

"recipient_id": ""

"response_type_id": 1741,

"message": "Beneficiary added",

"status": 0

}

Request

Path parameters

Body parameters

Responses

Next steps

Related