v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

Beneficiary Status Enquiry

API to request status of beneficiary action.

post/beneficiary-status

Request body

entityIdstring required

Entity ID for your organization

programIdstring required

Program id related to beneficiary activity

custRefNostring required

Your alphanumeric internal reference for this beneficiary request. Response will be with this ID for status updates.

Response

Successful response

custRefNostring

Your internal reference number for a specific beneficiary request sent in the original request.

entityIdstring

Entity ID for your organization

programIdstring

Program id related to beneficiary action

info.statusstring

Status of beneficiary action (see table below)

info.messagestring

Success or Error message

info.bankCodestring

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

info.benCodestring

Beneficiary code

info.benNamestring

Beneficiary name

info.benIFSCstring

IFS code for the beneficiary bank account

info.benAcctNostring

Beneficiary account number