Register Customer API

The Register Customer API is used to register new customers and facilitating the creation of digital wallets in the Hexa Platform. This API will do the following:

  • Register the customer.
  • Perform onboarding check (whenever applicable or opted by the Issuer).

Environment

Sandboxhttps://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/issuance/v1/enroll
ProductionContact your WIBMO KAM or support.
Sample request
curl --request POST \
     --url https://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/issuance/v1/enroll \
     --header 'X-Consumer-Custom-ID: F42BC4E7B801C834B630DE498473533F' \
     --header 'x-api-key: 4A02C4267C9A97A1488AB3259FD1A725' \
     --header 'accept: application/json' \
     --header 'bankId: 6060' \
     --header 'clientId: 1060' \
     --header 'content-type: application/json' \
     --header 'entityId: 100' \
     --header 'secureCode: pu8gSMLNE7pNv36IlUmstU' \
     --header 'x-api-key: 4A02C4267C9A97A1488AB3259FD1A725' \
     --data '
{
  "token": "e3ln1sSCTF9rgy9AjN5QNAkJruloChEdm7C39FVnfczb5gfIGv"
}
'
Response parameters (Decrypted)

This API will provide a token in the response that must be decrypted using the Decrypt API. The decrypted response is similar to the following:

ParameterTypeParameter RequirementDescription
messageCodeNumeric (4)ConditionalAPI response type identifier
clientTxnIdString (100)ConditionalEchoed from the request.
formFactor.uniqueNumberNumeric (16)ConditionalMasked dummy card number unique to each customer.
formFactor.urnNumeric (20)ConditionalUnique reference number for the customer
formFactor.securityCodeNumeric (3)ConditionalA unique security code for the dummy card.
formFactor.uniqueNumberExpiryNumeric (4)ConditionalExpiry of the dummy card (MMYY)
formFactor.accountDetails.accountNumberNumeric (15)MandatoryUnique wallet ID for a sub-wallet.
formFactor.accountDetails.accountNumberExpiryNumeric (4)MandatoryExpiry for the wallet.
Sample response (Decrypted)
{
	"customerId": "000000000081",
	"responseCode": "00",
	"messageCode": 3511,
	"clientTxnId": "ram12344ram900",
	"clientId": "1060",
	"responseDateTime": "20240214184521",
	"accosaTransactionId": 43300,
	"responseMessage": "CUSTOMER REGISTERED SUCCESSFULLY",
	"bankId": 6060,
	"accosaRefNo": "13987",
	"formFactor": {
		"uniqueNumber": "817491 XXXXXX 4794",
		"urn": 826564,
		"securityCode": "",
		"uniqueNumberExpiry": "0226",
		"accountDetails": [
			{
				"accountNumber": "702000003050941",
				"accountNumberExpiry": "0225"
			}
		]
	}
}
API response codes
Error CodeDescription
00CUSTOMER REGISTERED SUCCESSFULLY
1045UNABLE TO PROCESS REQUEST CAUSE OF UNKNOWN FIELD: ""
1054DUPLICATE REQUEST
1055MALFORMED_REQUEST
1088INVALID REQUEST DATE format
1231DATA_NOT_FOUND
1237DUPLICATE_MOBILE_NUMBER_WITH_MULTIPLE_ACCOUNT
1238INVALID_VOTERID_NUMBER
1239INVALID_PASSPORT_NUMBER
1240INVALID_ADHAR_NUMBER
1241INVALID_DRIVING_LICENCE_NUMBER
1242INVALID_PAN_NUMBER
1245CUSTOMER_ID_CAN_NOT_BE_EMPTY
1273INVALID MOBILE NUMBER
1283LOGIN_SERVICE_INTEGRATION_CALL_FAILURE
1289PROGRAM_NOT_ALLOWED_FOR_PRODUCT
1290FIRSTNAME_CANNOT_BE_BLANK
1291LASTNAME_CANNOT_BE_BLANK
1295PRDUCT_ID_CANNOT_BE_BLANK
1297MOBILE_NUMBER_CANNOT_BE_BLANK
1300DOC_TYPE_CANNOT_BE_BLANK
1305AML_NOT_CONFIGURED_FOR_PRODUCT
1312INVALID_DOC_TYPE
1315INVALID_GENDER
8004DUPLICATE EMAIL ID
8017INVALID CITY
8019INVALID STATE
8021INVALID COUNTRY
8024INVALID INITIAL LOAD
8026INVALID DATE OF BIRTH FORMAT
9310CARDHOLDER LAST NAME IS MANDATORY
9328CARDHOLDER FIRST NAME IS MANDATORY
9333KYC EXPIRY NOT CONFIGURED FOR PRODUCT
9334CUSTOMER ONBOARDING IN PROGRESS
9335RISK CATEGORY IS MANDATORY
9338CUSTOMER ALREADY REGISTERED
9343CLIENT TXN ID IS MANDATORY
10031MOBILE NO NOT PRESENT
10042INVALID EMAIL LENGTH
10043MOBILE NO INVALID LENGTH
10048INVALID EMAIL FORMAT
70012DUPLICATE PAN NUMBER WITH MULTIPLE ACCOUNT
70013DUPLICATE VOTER NUMBER WITH MULTIPLE ACCOUNT
303180RISK CATEGORY LENGTH SHOULD NOT BE MORE THAN 20 CHARACTERS
303181PRODUCTID LENGTH SHOULD NOT BE MORE THAN 5 CHARACTERS
303182INITIAL LOAD AMOUNT CURRENCY LENGTH SHOULD NOT BE MORE THAN 3 CHARACTERS
303183KYC PROFILE VALUE SHOULD NOT BE MORE THAN 1000
303184INVALID INITIAL LOAD VALUE LENGTH
303185RISK SCORE CANNOT BE MORE THAN 1000
303186FIRST NAME LENGTH SHOULD NOT BE MORE THAN 50 CHARACTERS
303187MIDDLE NAME LENGTH SHOULD NOT BE MORE THAN 50 CHARACTERS
303188LAST NAME LENGTH SHOULD NOT BE MORE THAN 50 CHARACTERS
303189ADDRESS LINE 1 SHOULD NOT EXCEED 50 CHARACTERS
303190ADDRESS LINE 2 SHOULD NOT EXCEED 50 CHARACTERS

Request parameters

Language
URL
Click Try It! to start a request and see the response here!