get https://api.instantpay.in/contacts/person
Instantpay's List Person API helps businesses manage their contacts. It provides deep insights into their network of individuals. This API lists all existing contacts. It provides insights for better decision-making and communication.
Integrating the List Person API lets organisations analyse and segment their contacts. This enables a targeted, personalised approach to relationship management. This feature helps businesses better understand their contacts. It enables more effective and tailored communication.
Request Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| gcId | String | Mandatory | Contact Id(You will get from Add Contact Response) |
Sample Request
curl --location --request GET '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 '{
"gcId":"645383ba4acec95a32089822"
}'
GET /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: 41
{
"gcId":"645383ba4acec95a32089822"
}
Response Parameter
| Parameter 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 |
{
"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
}