Add Address

Request Parameters

NameTypeRequirementDescription
gcIdStringMandatoryContact Id(You will get from Add Contact Response)
addressTypeStringMandatoryType of Address
addressStringMandatoryAddress of the Contact Person
cityStringMandatoryCity Name
stateStringMandatoryState Name
pincodeStringMandatoryAddress Pincode
countryCodeStringMandatoryCountry Code (IN for India)

Sample Request

curl --location '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 '{
    "gcId" : "6447f86b1a1767723d055989",
    "addressType": "Shipping",
    "address": "13 Karan Dubey, GT Road",
    "city": "Aligarh",
    "state": "Uttar pradesh",
    "pincode": "202001",
    "countryCode" :"IN"
}'
POST /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: 219

{
    "gcId" : "6447f86b1a1767723d055989",
    "addressType": "Shipping",
    "address": "13 Karan Dubey, GT Road",
    "city": "Aligarh",
    "state": "Uttar pradesh",
    "pincode": "202001",
    "countryCode" :"IN"
}

Response Parameters

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
enviromentStringLive/Sandbox

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Address Added Successfully",
    "data": {
        "gcId": "645383ba4acec95a32089822",
        "addressType": "Shipping",
        "address": "13 Karan Dubey, GT Road",
        "city": "Aligarh",
        "state": "Uttar pradesh",
        "pincode": "202001",
        "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
}
Language
Click Try It! to start a request and see the response here!