get https://api.instantpay.in/contacts/address
Instantpay’s List Address API gives businesses a complete view of their location data. This enables better, data-driven decisions. Our API returns a list of all existing addresses. It gives insights into your geographical distribution. This can improve logistics, customer service, and market analysis.
Integrating the List Address API lets businesses optimise operations. They can then fully understand their location landscape. This feature is a powerful tool for using location data. It can streamline delivery routes, enhance customer service, and analyse market presence.
Use Instantpay's List Address API for better location management. It will boost your efficiency.
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/address' \
--header 'Content-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}}' \
--data '{
"gcId":"645383ba4acec95a320898227"
}
'
GET /contacts/address HTTP/1.1
Host: api.instantpay.in
Content-Type: application/json
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Length: 41
{
"gcId":"645383ba4acec95a320898227"
}
Response Parameter
| Name | Type | Description |
|---|---|---|
| statuscode | String | Instantpay status code |
| actcode | String | Action code |
| status | String | Status message |
| data | Array | Response data(if Present) |
| ipay_uuid | String | Request reference number |
| timestamp | String | Response time (YYYY-MM-DD HH:II:SS) |
| 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": [
{
"gcId": "645383ba4acec95a32089822",
"addressType": "Shipping",
"address": "Sarita Vihar",
"city": "New Delhi",
"state": "Delhi",
"pincode": "110044",
"countryCode": "IN",
"updated_at": "2023-05-04T10:26:03.447000Z",
"created_at": "2023-05-04T10:26:03.447000Z",
"_id": "6453883b1b3f10b8f1093092"
},
],
"timestamp": "2023-05-04 16:23:13",
"ipay_uuid": "h0059915ff76-3a56-4a6d-ae8f-83526a5de99e",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}