List Contact

Request Parameters

NameTypeRequirementDescription
gcIdStringMandatoryContact Id(You will get from Add Person Response)
personIdStringMandatoryPerson Id

Sample Request

curl --location --request DELETE 'https://api.instantpay.in/contacts/person' \
--header 'XContent-Type: application/json' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOQ8l80uxEOrgU6T3Oc4znVc=' \
--header 'X-Ipay-Client-Secret: 55bb356f8d28953c47b40286db23b3aba8e3902e6a0d923f90730e9f6e4b3fcb' \
--header 'X-Ipay-Endpoint-Ip:  14.142.186.142' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'Content-Type: application/json' \
--data '{

    "gcId":"645383ba4acec95a32089822",
    "personId" : "6453951835fca2f80f074002"
}
'
DELETE /contacts/person HTTP/1.1
Host: api.instantpay.in
XContent-Type: application/json
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOQ8l80uxEOrgU6T3Oc4znVc=
X-Ipay-Client-Secret: 55bb356f8d28953c47b40286db23b3aba8e3902e6a0d923f90730e9f6e4b3fcb
X-Ipay-Endpoint-Ip:  14.142.186.142
X-Ipay-Auth-Code: 1
Content-Type: application/json
Content-Length: 88

{

    "gcId":"645383ba4acec95a32089822",
    "personId" : "6453951835fca2f80f074002"
}

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": "Transaction Successful",
    "data": [
        {
            "_id": "645b283b9b2e242ec80dd5c2",
            "userId": 189590,
            "name": "Shahbaz",
            "email": "[email protected]",
            "mobile": "8430454541",
            "callingCode": "91",
            "companyName": "XYZ",
            "tagId": [
                "645b280e95335f08eb021aa2"
            ],
            "tags": [
                {
                    "_id": "645b280e95335f08eb021aa2",
                    "userId": 189590,
                    "name": "Employee1",
                    "hexColorCode": "#FF1934",
                    "updated_at": "2023-05-10T05:13:50.517000Z",
                    "created_at": "2023-05-10T05:13:50.517000Z"
                }
            ]
        }
    ],
    "timestamp": "2023-05-10 10:45:08",
    "ipay_uuid": "h00599219875-45b5-485f-8dfb-9ed9ed5b37fd",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!