List Notes

Unlock deeper insights into your data with Instantpay's List Notes API. It is a powerful tool for businesses. It shows them all annotations linked to their key elements. This API lets users get a list of existing notes. It provides context for better decision-making and communication.

Integrating the List Notes API lets businesses analyse their datasets in detail. This fosters a more nuanced, data-driven approach to their operations. This feature helps organisations gain insights from context. It boosts their ability to make strategic decisions and drive results.

Request Parameters

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

Sample Request

curl --location --request GET 'https://api.instantpay.in/contacts/note' \
--header 'XContent-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}}' \
--header 'Content-Type: application/json' \
--data '{
    "gcId":"645383ba4acec95a32089822"

}'
GET /contacts/note HTTP/1.1
Host: api.instantpay.in
XContent-Type: application/json
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: 42

{
    "gcId":"645383ba4acec95a32089822"

}

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
internalCodeStringit will be null

{ "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": [
        {
            "_id": "6453992d54c74877510e5372",
            "gcId": "645383ba4acec95a32089822",
            "note": "test 1 filedfd",
            "updated_at": "2023-05-04T11:41:42.283000Z",
            "created_at": "2023-05-04T11:38:21.792000Z",
            "attachment": [
                {
                    "fileName": "sample.jpeg",
                    "fileLink": "https://api.instantpay.in/downloadmanager?q=Iw5m6DOl6GukDaBvenjfItol0EMd8Hon21BbyfJjtEUuZGGY%2FezDACnTJFiaRsLNG20dBMUHFDlT9r0awsJ6AcrJDX5%2BOfs2N4eeaFMGjNn9UPXK221PV2hQ%3D%3D",
                    "fileSize": 11226
                }
            ]
        }
    ],
    "timestamp": "2023-05-04 17:15:13",
    "ipay_uuid": "h0059916120f-44cb-455b-805e-b93354adfcc3",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
 
Language
Click Try It! to start a request and see the response here!