List Address

Request Parameters

NameTypeRequirementDescription
gcIdStringMandatoryContact 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

NameTypeDescription
statuscodeStringInstantpay status code
actcodeStringAction code
statusStringStatus message
dataArrayResponse data(if Present)
ipay_uuidStringRequest reference number
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/Sandbox
internalCodeStringIt 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
}
Language
Click Try It! to start a request and see the response here!