Secure Payments API – GET Customer Notes

General

In Secure Payments, you can add notes to customers. This can be a useful way to keep track of information you learn about a customer that doesn't fit into any default fields. This article covers sending GET requests to the API to view notes, but you can also see notes in the UI on the Customers page. Getting customer notes is one of the customer options available through the Secure Payments (formerly PCI Wallet) API.

How To

To get all notes associated to a customer, send a GET request to the endpoint:

GET https://pciwallet.simnang.com/api/customers/{id}/notes

You'll replace {id} with the customer ID for the specific customer you want to see the notes for. If you don't know that ID, see our article on Getting Customers.

Here's a cURL request with the headers and a sample endpoint:

curl -X GET --header 'Accept: application/json' --header 'authorization: YOUR AUTH' --header 'secret: YOUR SECRET\' 
'https://pciwallet.simnang.com/api/customers/12/notes'

The response will give you all of the notes for a specific customer. Each entry will include a note ID, the customer ID, the text of the note, and a timestamp when it was created:

[
{
"id": 1174,
"customer_id": 2659342,
"note": "Customer said that he just switched jobs and will need to ask if he can get an advance. Said to call back on Friday.",
"created": "2021-05-13 18:36:05"
},
{
"id": 1175,
"customer_id": 2659342,
"note": "Customer got the advance and said he would send the payment today.",
"created": "2021-05-14 18:36:06"
}
]

The response returns all the notes associated with the requested customer. The "id" field is the ID for each specific note, which is used to edit or delete notes.

To try it in our demo API tenant, see our ReadMe page: GET Customer Notes


How did we do?


Powered by HelpDocs (opens in a new tab)