Create Customer
POST/customer-account
The request is used to create a customer and his accounts in the system. This will create customers, their login profile, cash account to manage the cash, portfolio account to manage the holdings, and all the exchange accounts customers allow to trade.
Note - Market data APIs access for new customers will take some time ~ 1-2hrs.
Customer accounts will be created according to the configured default customer profile or subscription package.
Customer profile ; is similar to a blue print of customer accounts. If this is enabled at the institution level all the customer accounts will be created according to that customer profile.
Subscription package ; enables to define the set of exchanges to which the exchange/ trading accounts should be created for a customer to trade with currencies. Exchange accounts will be created for all the exchanges defined in the subscription package, the cash accounts will be created according to the respective exchange and configured currency and security account will be created with type equity for each cash account.
Note: Please try again, If you receive error code - 1123.
Request
- application/json
Body
Possible values: <= 50 characters
Fintech's Reference Number ; this can be any value and value format can be decided by Fintech itself.
Possible values: <= 20 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 15 characters
Possible values: <= 15 characters
Possible values: <= 50 characters
Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$
Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$
Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$
Possible values: <= 50 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 250 characters
Possible values: [M-Male
, F-Female
, -1-rather not say
]
Possible values: Value must match regular expression yyyy/MM/dd
Responses
- 200
OK
- */*
- Schema
- Example (from schema)
- SUCCESS
- RETRY
- FAILED (already existing reference number)
Schema
Possible values: [SUCCESS
, FAILED
]
Find error codes here)
GTN customer number of the Customer account which was created at GTN side.
List of Cash Account Numbers of the created GTN cash accounts under created customer account.
List of Security Account Numbers of the created GTN security accounts under created customer account.
List of Exchange Account Ids of the created GTN exchange accounts under created customer account.
{
"status": "SUCCESS",
"reason": "string",
"rejectCode": 0,
"customerNumber": "string",
"cashAccountNumbers": [
"string"
],
"accountNumbers": [
"string"
],
"exchangeAccountIds": [
0
]
}
{
"status": "SUCCESS",
"reason": "customer creation success",
"rejectCode": 0,
"customerNumber": "ASI804304850",
"cashAccountNumbers": [
"C000135856"
],
"accountNumbers": [
"P000132185"
],
"exchangeAccountIds": [
380803
]
}
{
"status": "FAILED",
"reason": "System is busy, please retry again",
"rejectCode": 1123
}
{
"status": "FAILED",
"reason": "Customer is already created with the referneceNumber: 88032b29-6329-432c-82b2-f3e3f2bc4015",
"rejectCode": 1125
}