Overview
Administrators of the Inspire Payments Platform can add notes to a payment to provide information.
Payment notes are displayed in the payment timeline on the Inspire Tenant Portal.
A note added to a payment in the Inspire Tenant Portal
Use the endpoints in this section to manage payment notes.
To pin the note at the top of the payment timeline, use the Pin payment note endpoint. To unpin, use the Unpin payment note endpoint.
Properties of the Payment Note Object
Payment Note objects returned by these endpoints can have the following properties:
id(String): Note ID.createdBy(String): Name on the person who added the note.editedBy(String): Name on the person who edidted the note.createdDate(String): Date and time when the note was created.description(String): The text of the note.pinnedDate(String): Only for pinned notes. Date and time when the note was pinned.