Secure Payments API – POST Customer Note

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 adding notes through the API, but you can also add notes in the UI on the Customers page.

To create a customer note, send a POST request to the following endpoint:

POST https://pciwallet.simnang.com/api/customers/{id}/note

Just replace {id} with the specific customer's ID. If you don't know it, use the GET Customers request.

Here's a sample JSON payload:

{    
"note": "Customer says they will pay on 5.21.21"  
}

And the same payload as a cURL request:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'authorization: YOUR AUTH' --header 'secret: YOUR SECRET' -d '{ \
"note": "Customer says they will pay on 5.21.21" \
}' 'https://pciwallet.simnang.com/api/customers/13/note'

The response will give the customer ID, the text of the note, a timestamp of when it was created, and a note ID (which is used to edit or delete the note).

{
"id": 1168,
"customer_id": 2659342,
"note": "Customer says they will pay on 5.21.21",
"created": "2021-05-03 15:17:14"
}

Notes can only include numbers, letters and periods.

To try it in our demo API tenant, visit our ReadMe page: Create Customer Note


How did we do?


Powered by HelpDocs (opens in a new tab)