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-update | when a setting is updated. |
password-update | when a password is updated. |
processor-create | when a processor is created. |
processor-update | when a processor is updated. |
processor-delete | when a processor is deleted. |
credit-card-create | when a card is created. |
credit-card-update | when a card is updated. |
credit-card-delete | when a card is deleted. |
bank-account-create | when a bank account is created. |
bank-account-update | when a bank account is updated. |
bank-account-delete | when a bank account is deleted. |
payment-processing | when a payment is processed. |
nacha-file-generation | when a NACHA file is generated. |
You will find the key-value pairs for the callback
entity below.
Key-value pairs
Value: | Definition: |
---|---|
id | The callback's ID. |
user_id | The ID of the user who created the callback. |
event | The name describing the callback event. |
url | The target url of the callback. |
enabled | Determines whether the callback is enabled or disabled. |
created | The callback's creation date. |