post https://api.instantpay.in/contacts/address
Keep your location information accurate and up-to-date with Instantpay’s Add Address API. This solution lets businesses add new addresses to their database. It ensures reliable and complete location data management.
The Add Address API streamlines address management. It works for new offices, client addresses, and other vital locations. This API suits businesses that handle dynamic location data. It provides the flexibility to adapt as your business grows.
Integrating the Add Address API will keep your address database accurate. It will help with decision-making and operations.
Request Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| gcId | String | Mandatory | Contact Id(You will get from Add Contact Response) |
| addressType | String | Mandatory | Type of Address |
| address | String | Mandatory | Address of the Contact Person |
| city | String | Mandatory | City Name |
| state | String | Mandatory | State Name |
| pincode | String | Mandatory | Address Pincode |
| countryCode | String | Mandatory | Country Code (IN for India) |
Sample Request
curl --location '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 '{
"gcId" : "6447f86b1a1767723d055989",
"addressType": "Shipping",
"address": "Mohan Cooperative Industrial Estate",
"city": "New Delhi",
"state": "Delhi",
"pincode": "110044",
"countryCode" :"IN"
}'
POST /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: 219
{
"gcId" : "6447f86b1a1767723d055989",
"addressType": "Shipping",
"address": "Mohan Cooperative Industrial Estate",
"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 | Current 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 |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Address Added Successfully",
"data": {
"gcId": "645383ba4acec95a32089822",
"addressType": "Shipping",
"address": "Mohan Cooperative Industrial Estate",
"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
}