List Person

Request Parameters

gcIdStringMandatoryContact Id(You will get from Add Contact Response)

Sample Request

curl --location --request GET '' \
--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 '{
GET /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: 41


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": "6453969c6e9109027e051202",
            "gcId": "645383ba4acec95a32089822",
            "contactPersonName": "Sample Name",
            "email": "[email protected]",
            "mobile": "7428585742",
            "description": "test desc",
            "callingCode": "+91",
            "updated_at": "2023-05-04T11:27:24.956000Z",
            "created_at": "2023-05-04T11:27:24.956000Z"
    "timestamp": "2023-05-04 16:57:46",
    "ipay_uuid": "h00599160bd1-3f46-4482-91b3-d05c45df1bc1",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
Click Try It! to start a request and see the response here!