List all webhooks
Lists all webhook configurations for the company account.
To make this request, your API credential must have one of the following roles:
- Management API—Webhooks read
- Management API—Webhooks read and write
Query Parameters
The number of items to have on a page, maximum 100. The default is 10 items on a page.
The number of the page to fetch.
Path Parameters
Unique identifier of the company account.
Response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
200 - OK
The request has succeeded.
Show moreShow less_linksobjectPagination references.
prevobjectThe previous page. Only present if there is a previous page.
hrefstringaccountReferencestringReference to the account.
dataarray[object]The list of webhooks configured for this account.
_linksobjectReferences to resources connected with this webhook.
companyobjectThe company account that the webhook is configured for. Only present for company-level webhooks.
hrefstringmerchantobjectThe merchant account that the webhook is configured for. Only present for merchant-level webhooks.
hrefstringacceptsExpiredCertificatebooleanIndicates if expired SSL certificates are accepted. Default value: false.
acceptsSelfSignedCertificatebooleanIndicates if self-signed SSL certificates are accepted. Default value: false.
acceptsUntrustedRootCertificatebooleanIndicates if untrusted SSL certificates are accepted. Default value: false.
accountReferencestringReference to the account the webook is set on.
activebooleanIndicates if the webhook configuration is active. The field must be true for you to receive webhooks about events related an account.
additionalSettingsobjectAdditional shopper and transaction information to be included in your standard notifications. Find out more about the available additional settings.
excludeEventCodesarray[string]Object containing list of event codes for which the notifcation will not be sent.
includeEventCodesarray[string]Object containing list of event codes for which the notifcation will be sent.
propertiesobjectObject containing boolean key-value pairs. The key can be any standard webhook additional setting, and the value indicates if the setting is enabled. For example,
captureDelayHours
: true means the standard notifications you get will contain the number of hours remaining until the payment will be captured.certificateAliasstringThe alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias.
communicationFormatstringFormat or protocol for receiving webhooks. Possible values:
- soap
- http
- json
descriptionstringYour description for this webhook configuration.
encryptionProtocolstringSSL version to access the public webhook URL specified in the
url
field. Possible values:- TLSv1.3
- TLSv1.2
- HTTP - Only allowed on Test environment.
If not specified, the webhook will use
sslVersion
: TLSv1.2.filterMerchantAccountTypestringShows how merchant accounts are included in company-level webhooks. Possible values:
- includeAccounts
- excludeAccounts
- allAccounts: Includes all merchant accounts, and does not require specifying
filterMerchantAccounts
.
filterMerchantAccountsarray[string]A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for
filterMerchantAccountType
.Required if
filterMerchantAccountType
is either:- includeAccounts
- excludeAccounts
Not needed for
filterMerchantAccountType
: allAccounts.hasErrorbooleanIndicates if the webhook configuration has errors that need troubleshooting. If the value is true, troubleshoot the configuration using the testing endpoint.
hasPasswordbooleanIndicates if the webhook is password protected.
hmacKeyCheckValuestringThe checksum of the HMAC key generated for this webhook. You can use this value to uniquely identify the HMAC key configured for this webhook.
idstringUnique identifier for this webhook.
networkTypestringNetwork type for Terminal API details webhooks.
populateSoapActionHeaderbooleanIndicates if the SOAP action header needs to be populated. Default value: false.
Only applies if
communicationFormat
: soap.typestringThe type of webhook. Possible values are:
- standard
- account-settings-notification
- banktransfer-notification
- boletobancario-notification
- directdebit-notification
- ach-notification-of-change-notification
- pending-notification
- ideal-notification
- ideal-pending-notification
- report-notification
- terminal-api-notification
- terminal-settings
- terminal-boarding
Find out more about standard notification webhooks and other types of notifications.
urlstringPublic URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.
usernamestringUsername to access the webhook URL.
itemsTotalintegerTotal number of items.
pagesTotalintegerTotal number of pages.
400 - Bad Request
A problem reading or understanding the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.