Callbacks

This section provides an overview on callbacks in Secure Payments.

Callbacks can be used to track events in Secure Payments. When you perform a request and a callback is triggered, think of it as sending a letter. When our API completes your request, it will send a response letter to the address you specify.

You can retrieve all information about your callbacks, create a new callback, or update an existing callback.

For more information on how to setup a callback within the UI, see our Secure Payments > Adding Secure Payments Events article.

When creating a callback through the API, the following events can be used to trigger a callback:

Event:Description:
settings-updatewhen a setting is updated.
password-updatewhen a password is updated.
processor-createwhen a processor is created.
processor-updatewhen a processor is updated.
processor-deletewhen a processor is deleted.
credit-card-createwhen a card is created.
credit-card-updatewhen a card is updated.
credit-card-deletewhen a card is deleted.
bank-account-createwhen a bank account is created.
bank-account-updatewhen a bank account is updated.
bank-account-deletewhen a bank account is deleted.
payment-processingwhen a payment is processed.
nacha-file-generationwhen a NACHA file is generated.

You will find the key-value pairs for the callback entity below.

Key-value pairs

Value:Definition:
idThe callback's ID.
user_idThe ID of the user who created the callback.
eventThe name describing the callback event.
urlThe target url of the callback.
enabledDetermines whether the callback is enabled or disabled.
createdThe callback's creation date.