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: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825' \
--header 'X-Ipay-Endpoint-Ip: 125.0.0.1' \
--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: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
X-Ipay-Endpoint-Ip: 125.0.0.1
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
}