Secure Payments API – Post a Callback

General

This article explains how to create a callback through a POST request in the API. You can also see our articles on updating or getting callbacks:

Callbacks

Callbacks allow you to receive a notification when certain events happen in Secure Payments (formerly PCI Wallet).

To post a callback, send a POST request to this endpoint:

POST https://pciwallet.simnang.com/api/callback

Your payload will specify the event that you want to be notified for (there's a full list of options at the bottom of this page). You'll also need to include your own URL; whenever the selected event is executed in your account, a message will be sent as a POST request to this URL. Lastly, the payload will need to specify whether the callback is enabled.

Here's a sample JSON payload:

{
"callback": {
"event": "password-update",
"url": "YOUR CALLBACK URL",
"enabled": true
}
}

And a sample cURL request:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'authorization: YOUR AUTH' --header 'secret: YOUR SECRET' -d '{ \
"callback": { \
"event": "password-update", \
"url": "YOUR CALLBACK URL", \
"enabled": true \
} \
}' 'https://pciwallet.simnang.com/api/callback'

Supported Events

Here is the list of supported events:

settings-update
password-update
processor-create
processor-update
processor-delete
credit-card-create
credit-card-update
credit-card-delete
bank-account-create
bank-account-update
bank-account-delete
payment-processing
nacha-file-generation

The callback must be sent as a POST request to an HTTPS URL.


How did we do?


Powered by HelpDocs (opens in a new tab)