Sign in

v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Create Entity (Remitter/Beneficiary/Student)

The Create Entity API allows the API user to create and add a new Remitter, Beneficiary(Individual/Beneficiary) or Student, for the purpose of International payments for Education.

post/v1/client/accounts

Headers

api-keystring required

API Key

auth-keystring required

Auth key generated via the "Generate Auth key API"

userIdstring required

User Id as generated via the "Create Account (sign-Up) API". Identifier of an individual user, you can map this to the User identification at your end.

Request body

accountTypestring required

The field defines the type of entity the Account would be created for. The entity could be either the remitter, the beneficiary or the student.

namestring required

Name of the remitter/student/beneficiary (As mentioned on the PAN Doc)

addressstring required

Address of remitter/student/beneficiary

citystring required

City of remitter/student/beneficiary

statestring required

State of remitter/student/beneficiary

countrystring required

Country of remitter/student/beneficiary (to be spelled in CAPITALS only)

phonestring required

Phone number of remitter/student/beneficiary (Please ensure the number starts with "+" followed by the countrycode and then the mobile no., as shown in the example for India)

dobstring

Date of Birth (YYYY/MM/DD) of remitter/student/beneficiary, as mentioned on the PAN (Mandatory for Remitter)

panNostring

PAN number of remitter/student (Mandatory for Student/Remitter)

postalCodestring required

PIN Code/Postal Code number of remitter/student/beneficiary

emailstring required

Email of remitter/student/beneficiary

firstNamestring

First Name of remitter/student/beneficiary

middleNamestring

Middle Name of remitter/student/beneficiary

lastNamestring

Last Name of remitter/student/beneficiary

nameOnPassportstring

Full Name of STUDENT as mentioned on the Passport (Mandatory for Student)

passportIssueDatestring

Date of issue of the passport for the STUDENT (Mandatory for Student) [Format: YYYY/MM/DD]

passportExpiryDatestring

Date of expiry of the passport for the STUDENT (Mandatory for Student) [Format: YYYY/MM/DD]

passportNostring

ID number on the passport for the STUDENT (Mandatory for Student)

reasonstring

Reason for transfer.

Response

200

statusinteger
messagestring

Example response

{
  "status": 200,
  "message": "Success",
  "data": {
    "userAccountId": "0ca9ed3f-9dc8-4311-9cb8-99f20069013d",
    "message": "user Added",
    "email": "abc@xyz.com"
  }
}