Add Note

Request Parameters

NameTypeRequirementDescription
gcIdStringMandatoryContact Id(You will get from Add Contact Response)
noteStringMandatoryNotes
filesArrayMandatoryUploaded Files

Sample Request

curl --location 'https://api.instantpay.in/contacts/note' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--form 'gcId="111111111111"' \
--form 'note="Added Successfully"' \
--form 'files[]=@"/path/to/file"'
POST /contacts/note HTTP/1.1
Host: api.instantpay.in
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
Content-Length: 397
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="gcId"

111111111111
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="note"

Added Successfully
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files[]"; filename="file"
Content-Type: <Content-Type header here>

(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response Parameter

Parameter NameTypeDescription
statuscodeStringInstantpay status code
actcodeStringAction code
statusStringstatus Message
dataArrayResponse data(if Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/Sandbox

    "statuscode": "TXN",
    "actcode": null,
    "status": "Note Added Successfully",
    "data": {
        "gcId": "645383ba4acec95a32089822",
        "note": "test 1 files",
        "updated_at": "2023-05-04T11:38:21.792000Z",
        "created_at": "2023-05-04T11:38:21.792000Z",
        "_id": "6453992d54c74877510e5372"
    },
    "timestamp": "2023-05-04 17:08:23",
    "ipay_uuid": "h00699160f9a-8cd3-4453-a3b1-3d1b41b5373a",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!