patch https://api.instantpay.in/contacts/address
Instantpay's Update Address API helps businesses keep their location data accurate and up-to-date. Our API lets you easily update address details. It keeps your database current with the latest info.
The Update Address API is ideal for managing changes to office and customer addresses. It supports real-time updates. This lets you maintain an accurate, reliable address database. This feature is vital for firms that value efficient logistics and great customer service.
With Instantpay’s Update Address API, you can manage your location data. It will be responsive and reliable. This will help your business run at its best.
Request Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| addressId | String | Mandatory | You will get from the Add Address Response |
| gcId | String | Mandatory | Contact Id(You will get from Add Contact Response) |
| addressType | String | Mandatory | Address Type |
| address | String | Mandatory | Address |
| city | String | Mandatory | City Name |
| state | String | Mandatory | State Name |
| pincode | String | Mandatory | Pincode |
| countryCode | String | Mandatory | Country Code(IN for India) |
Sample Request
curl --location --request PATCH 'https://api.instantpay.in/contacts/address' \
--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 '{
"addressId": "6448ea7c1a1767723d055996",
"gcId" : "6447f86b1a1767723d055989",
"addressType": "Billing",
"address": "Sarita Vihar",
"city": "New Delhi",
"state": "Delhi",
"pincode": "110044",
"countryCode" :"IN"
}'
PATCH /contacts/address HTTP/1.1
Host: api.instantpay.in
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: 263
{
"addressId": "6448ea7c1a1767723d055996",
"gcId" : "6447f86b1a1767723d055989",
"addressType": "Billing",
"address": "Sarita Vihar",
"city": "New Delhi",
"state": "Delhi",
"pincode": "110044",
"countryCode" :"IN"
}
Response Parameters
| 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 ) |
| enviroment | String | Live/Sandbox |
| internalCode | String | It will be null |
{
"statuscode": "TXN",
"actcode": null,
"status": "Address Added Successfully",
"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 15:56:03",
"ipay_uuid": "h0059915f5be-9d37-492c-9424-2146b3ad97f5",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}