Name Abbreviator

Name abbreviator APIs helps to generate abbreviations or shortened versions of names. These abbreviations can be helpful in various contexts such as in KYC while validating the names.

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code -1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

NameTypeMandatory (M) , Optional (O)Description
NameStringMname of the user
maxLengthStringOMaximum length allowed
externalRefStringMYour Unique Transaction Id

Sample Request

curl --location --request POST '' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Sample Name",
    "maxLength": "26",
    "externalRef": "1650279339"
POST /identity/nameAbbreviations HTTP/1.1
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json

    "name": "Sample Name",
    "maxLength": "26",
    "externalRef": "1650279339"

Response Parameters

statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )


Note :

1- externalRef must be unique and in alpha numeric characters.

Sample Response

    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "ipayId": "1220418164539ZBMFR",
        "openingBalance": "13.46",
        "closingBalance": "13.46",
        "transactionValue": "0.00",
        "payableValue": "0.00",
        "abbreviations": [
            "Sample N",
            "S Name",
            "Sample Name"
    "timestamp": "2022-04-18 16:45:39",
    "ipay_uuid": "h00596179688-8454-4a48-8783-531e2952d282",
    "orderid": "1220418164539ZBMFR",
    "environment": "LIVE",
Click Try It! to start a request and see the response here!