POSTAdd Recipient
Register a new beneficiary under a DigiKhata sender's account.
Adds a beneficiary (bank account) to a DigiKhata sender. On success a recipient_id is returned — use it to send transaction OTP and initiate the transfer. Maximum 5 recipients per day.
Request
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
customer_id | string | required | Sender's 10-digit mobile number.e.g. 9444444444 |
customer_idstringRequiredSender's 10-digit mobile number.
example: 9444444444
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 |
bank_id | integer | required | Unique ID assigned to the beneficiary's bank.e.g. 12 |
recipient_name | string | required | Full name of the recipient.e.g. Aditya |
recipient_mobile | string | required | Recipient's 10-digit mobile number.e.g. 9775597777 |
account | string | required | Recipient's bank account number.e.g. 1234567890657 |
bank_code | string | required | IFSC code of the recipient's bank branch.e.g. KKBK0000878 |
initiator_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
client_ref_idstringoptionalUnique reference ID per API call, generated by your system (max 20 characters).
example: 2026010100123456789
bank_idintegerRequiredUnique ID assigned to the beneficiary's bank.
example: 12
recipient_namestringRequiredFull name of the recipient.
example: Aditya
recipient_mobilestringRequiredRecipient's 10-digit mobile number.
example: 9775597777
accountstringRequiredRecipient's bank account number.
example: 1234567890657
bank_codestringRequiredIFSC code of the recipient's bank branch.
example: KKBK0000878
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_keystringRequiredStatic API key issued to your account after KYC.
secret-keystringRequiredDynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
secret-key-timestampstringRequiredCurrent time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
content-typestringRequiredapplication/json
example: application/json
Responses
statusnumberPrimary success indicator (0 = success).
messagestringHuman-readable response / error message.
response_status_idnumberGranular status id; see the shared error-codes table.
response_type_idnumberA unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobjectAPI-specific response payload.
recipient_idnumberUnique recipient identifier — use to transact.
recipient_mobilestringRecipient's mobile number (echoed back).