POSTAdd Recipient

POST/customer/payment/ppi-levin/sender/{customer_id}/recipient

Adds a beneficiary (bank account) to a PPI Levin sender. On success a recipient_id is returned — use it to send transaction OTP and initiate the transfer. Maximum 5 recipients per day.

Path parameters

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

customer_idstringRequired

Sender'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
`user_code`	string	required	User code of the retailer/agent the service is run for.e.g. 20810200
`client_ref_id`	string	optional	Unique reference id per API call, generated by your system.e.g. REQ-20260101-001
`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
`recipient_type`	string	required	Recipient type. Value will be 3.e.g. 3
`account`	string	required	Recipient's bank account number.e.g. 1234567890657
`ifsc`	string	required	IFSC code of the recipient's bank branch.e.g. KKBK0000878
`type`	string	optional	Recipient identifier type. Defaults to `ifsc`.e.g. ifsc
`account_type`	string	optional	Account type. Defaults to 1.e.g. 1

initiator_idstringRequired

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

example: 9962981729

user_codestringRequired

User code of the retailer/agent the service is run for.

example: 20810200

client_ref_idstringoptional

Unique reference id per API call, generated by your system.

example: REQ-20260101-001

bank_idintegerRequired

Unique ID assigned to the beneficiary's bank.

example: 12

recipient_namestringRequired

Full name of the recipient.

example: Aditya

recipient_mobilestringRequired

Recipient's 10-digit mobile number.

example: 9775597777

recipient_typestringRequired

Recipient type. Value will be 3.

example: 3

accountstringRequired

Recipient's bank account number.

example: 1234567890657

ifscstringRequired

IFSC code of the recipient's bank branch.

example: KKBK0000878

typestringoptional

Recipient identifier type. Defaults to `ifsc`.

example: ifsc

account_typestringoptional

Account type. Defaults to 1.

example: 1

Headers

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.
- recipient_idnumber
  Unique recipient identifier — use to transact.
- recipient_mobilestring
  Recipient's mobile number (echoed back).
- customer_idstring
  Sender's mobile number (echoed back).