Request Parameters

Name	Type	Requirement	Description
name	String	Mandatory	Name of the Contact
email	String	Mandatory	Email Id of the Contact
mobile	String	Mandatory	Mobile Number of the Contact
companyName	String	Optional	Company Name
tagDetails.tagId	String	Mandatory	Tag Id

Sample Request

curl --location 'https://api.instantpay.in/contacts/profile' \
--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",
    "email": "[email protected]",
    "mobile": "7428585742",
    "companyName": "Business Name",
    "tagDetails" : [
            {
                "tagId": "645b280e95335f08eb021aa2"
            }
     ]
}'

POST /contacts/profile HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
Content-Length: 225

{
    "name": "Sample Name",
    "email": "[email protected]",
    "mobile": "7428585742",
    "companyName": "Business Name",
    "tagDetails" : [
            {
                "tagId": "645b280e95335f08eb021aa2"
            }
     ]
}'

Response Parameters

Name	Type	Description
statuscode	String	InstantPay Status Code
actcode	String	Action Code
status	String	Status Message
data	Array	Response Data (If Present)
timestamp	String	Response time (YYYY-MM-DD HH:II:SS)
ipay_uuid	String	Request reference number
orderid	String	Transaction Id ( If transaction otherwise it is null )
environment	String	Live/Sandbox
internalCode	String	It will be null

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Contact Added Successfully",
    "data": {
        "userId": 189590,
        "name": "Sample Name",
        "email": "[email protected]",
        "mobile": "7428585742",
        "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
}