Add Person

Request Parameters

NameTypeRequirementDescription
gcIdStringMandatoryContact Id(You will get from Add Contact Response)
contactPersonNameStringMandatoryName of the Contact Person
emailStringMandatoryEmail ID
mobileStringMandatoryMobile Number
descriptionStringMandatoryRemarks

Sample Request

curl --location 'https://api.instantpay.in/contacts/person' \
--header 'XContent-Type: application/json' \
--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 '{
    
    "gcId" : "645383ba4acec95a32089822",
    "contactPersonName" : "Sample Name",
    "email" : "[email protected]",
    "mobile" : "7428585742",
    "description" : "test desc"

}'
POST /contacts/person HTTP/1.1
Host: api.instantpay.in
XContent-Type: application/json
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: 196

{
    
    "gcId" : "645383ba4acec95a32089822",
    "contactPersonName" : "Sample Name",
    "email" : "[email protected]",
    "mobile" : "7428585742",
    "description" : "test desc"

}'

Response Parameter

Parameter 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
{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Contact Person Added Successfully",
    "data": {
        "gcId": "645383ba4acec95a32089822",
        "contactPersonName": "Sample Name",
        "email": "[email protected]",
        "mobile": "7428585742",
        "description": "test desc",
        "callingCode": "+91",
        "updated_at": "2023-05-04T11:20:56.115000Z",
        "created_at": "2023-05-04T11:20:56.115000Z",
        "_id": "6453951835fca2f80f074002"
    },
    "timestamp": "2023-05-04 16:50:56",
    "ipay_uuid": "h0059916095e-b71e-4253-a449-2cda8d2429cb",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!