Beneficiary

post

https://jtrapi.jiopay.co.in/beneficiary

API to add/modify a Beneficiary for a Customer ID at a supported bank.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

UAT URL:https://jtrapi-uat.jiopay.co.in/beneficiary

📘
Important Developer Note
The provided code examples are for reference and instructional purposes only. Please integrate and thoroughly test them within your own build to ensure proper functionality.

Bank codes table

bankCode	Bank name
ICIC	ICICI Bank Ltd
INDB	Indusind Bank Ltd
FDRL	Federal Bank
KKBK	Kotak Mahindra Bank Ltd
HDFC	HDFC Bank Ltd
UTIB	Axis Bank Ltd

Status table

Status	Message
Success	Beneficiary Request Received
Error	Invalid Request/ Checksum, Client Request Validation
Error	Invalid or non unique benCode
Error	Invalid benIFSC
Error	Invalid email in benEmail
Error	Invalid bankCode
Error	Invalid entityId
Error	Invalid programId
Error	Invalid txnType
Error	Invalid txnType

Body Params

entityId

string

required

Entity ID for your organization

programId

string

required

Program id related to beneficiary activity

bankCode

string

required

4-character bank code (see example table) where beneficiary is linked

customerId

string

required

Your unique internal reference number for this payout request.

makerId

string

Required only if you need to use maker-checker functionality with the bank.

checkerId

string

Required only if you need to use maker-checker functionality with the bank.

checksum

string

required

The generated checksum. Hash the beneficiary object using SHA-256.

callbackUrl

string

The API endpoint where we will submit updates on the beneficiary status for each custRefNo.

beneficiary.reqMode

string

required

String Use A to add beneficiary - Use M to modify beneficiary, Use D to deactivate beneficiary

beneficiary.txnType

string

required

IMPS/NEFT/RTGS/IFT or a combination separated by ‘|’. (For example: NEFT|RTGS|IMPS)

beneficiary.benCode

string

Unique Beneficiary code

beneficiary.benName

string

Beneficiary name

beneficiary.benIFSC

string

required

IFS code for the beneficiary bank account

beneficiary.benAcctNo

string

required

Beneficiary account number

beneficiary.Email

string

required

Beneficiary email address

beneficiary.Mobile

string

required

Beneficiary mobile number (without country code)

beneficiary.remarks

string

Remarks for this action

externalReferenceNumber

string

required

Your unique external reference number for this payout request

Response

Important Developer Note The provided code examples are for reference and instructional purposes only. Please integrate and thoroughly test them within your own build to ensure proper functionality.

Bank codes table

Status table

200Successful response

Important Developer Note
The provided code examples are for reference and instructional purposes only. Please integrate and thoroughly test them within your own build to ensure proper functionality.