Add Contact

Request Parameters

NameTypeRequirementDescription
nameStringMandatoryName of the Contact
emailStringMandatoryEmail Id of the Contact
mobileStringMandatoryMobile Number of the Contact
companyNameStringOptionalCompany Name
tagDetails.tagIdStringMandatoryTag Id

Sample Request

curl --location 'https://api.instantpay.in/contacts/profile' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825' \
--header 'X-Ipay-Endpoint-Ip: 125.0.0.1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Shahbaz",
    "email": "[email protected]",
    "mobile": "8430412341",
    "companyName": "XYZ",
    "tagDetails" : [
            {
                "tagId": "645b280e95335f08eb021aa2"
            }
     ]
}'
POST /contacts/profile HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
X-Ipay-Endpoint-Ip: 125.0.0.1
Content-Type: application/json
Content-Length: 225

{
    "name": "Shahbaz",
    "email": "[email protected]",
    "mobile": "8430412341",
    "companyName": "XYZ",
    "tagDetails" : [
            {
                "tagId": "645b280e95335f08eb021aa2"
            }
     ]
}

Response Parameters

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataArrayResponse Data (If Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/Sandbox
internalCodeStringIt will be null

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Contact Added Successfully",
    "data": {
        "userId": 189590,
        "name": "Shahbaz",
        "email": "[email protected]",
        "mobile": "8430454541",
        "callingCode": "91",
        "companyName": "XYZ",
        "updated_at": "2023-05-10T05:14:35.381000Z",
        "created_at": "2023-05-10T05:14:35.381000Z",
        "_id": "645b283b9b2e242ec80dd5c2",
        "tagId": [
            "645b280e95335f08eb021aa2"
        ]
    },
    "timestamp": "2023-05-10 10:44:35",
    "ipay_uuid": "h00599219842-6eda-44a4-bb0d-f23353f11f62",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!