---
title: "Beneficiary"
method: POST
path: "/beneficiary"
---

# Beneficiary

`POST /beneficiary`

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

## Request body

- object
  - `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 `200`

Successful response

- object
  - `custRefNo` string — Alphanumeric reference received in the request
  - `status` string — 'success' if request is successful, 'error' if error has occurred
  - `message` string — Success or Error message

---

[API](https://skmtc.net/jiopay/apis/jiopay-pg.md) · [All operations](https://skmtc.net/jiopay/apis/jiopay-pg/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jiopay/jiopay-pg/revisions/55aa41b8482f/schema)