List Contact

Request Parameters

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

Sample Request

curl --location --request DELETE '' \
--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 '{

    "personId" : "6453951835fca2f80f074002"
DELETE /contacts/person HTTP/1.1
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: 88


    "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 )
internalCodeStringit will be null
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": [
            "_id": "645b283b9b2e242ec80dd5c2",
            "userId": 189590,
            "name": "Sample Name",
            "email": "[email protected]",
            "mobile": "7428585742",
            "callingCode": "91",
            "companyName": "XYZ",
            "tagId": [
            "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
Click Try It! to start a request and see the response here!