List all Webhooks Notifications
List all Webhooks Notifications
GET {{Environment_URL}}/v1/payments/webhook/notifications
Lists all webhook notifications
Headers
Name
Value
Authorization
Bearer <token>
Query Params
Name
Description
Value
filter.url
The URL specified at the time of the webhook trigger.
http://haleigh.com
filter.type
Type of notification
EXTERNAL_DEPOSIT
filter.payment.id
Payment Identifier
7267ba49-2f3d-46d2-acf4-bfcba7e10df2
filer.payout.id
Payout Identifier
fc935b6c-aa3a-4f4a-aaa4-446ccb81eda6
filter.accountStatement.id
Statement Identifier
7dfd4ef9-1d79-41d2-b60b-98c723f5b83c
page
page to paginate
0
limit
limit to paginate
10
Response
{
"data": [
{
"id": "4568b610-adb3-44f4-8d33-33bacbfd0f09",
"agentId": 1,
"url": "http://hazel.biz",
"token": null,
"secret": null,
"type": "PAYMENT_EXPIRED",
"payload": {
"data": {
"id": 1,
"amount": 1000000,
"status": "EXPIRED",
"externalId": "ext_001",
"ownerDocument": "11.222.333/0001-44",
"transactionEndToEndId": ""
},
"type": "PAYMENT_EXPIRED"
},
"payout": null,
"payment": {
"id": 1,
"externalId": "ext_001",
"status": "EXPIRED"
},
"accountStatement": null,
"history": [
{
"status": 200,
"endTime": "2024-12-05T01:00:02.777Z",
"startTime": "2024-12-05T01:00:02.594Z"
}
],
"createdAt": "2024-12-05T01:00:02.381Z",
"updatedAt": "2024-12-05T01:00:02.932Z"
},
{
"id": "d183ff40-47e8-4310-9cad-73c93bb5f116",
"agentId": 1,
"url": "https://lillian.info",
"token": null,
"secret": null,
"type": "EXTERNAL_DEPOSIT",
"payload": {
"data": {
"debtorName": "Mr. Aaron Lindgren",
"statementId": "acs-01",
"debtorAccount": {
"bank": "Ernser - Lueilwitz",
"branch": "0001",
"number": "999999999"
},
"debtorDocument": "11111111111"
},
"type": "EXTERNAL_DEPOSIT"
},
"payout": null,
"payment": null,
"accountStatement": {
"id": "b5eec16c-80e1-4389-878a-ea6a033d4001"
},
"history": [
{
"status": 200,
"endTime": "2024-12-05T01:00:02.777Z",
"startTime": "2024-12-05T01:00:02.594Z"
}
],
"createdAt": "2024-12-05T01:00:02.381Z",
"updatedAt": "2024-12-05T01:00:02.932Z"
}
],
"meta": {
"itemsPerPage": 2,
"totalItems": 3408,
"currentPage": 1,
"totalPages": 228,
"sortBy": [
[
"createdAt",
"ASC"
]
]
},
"links": {
"current": "{{Environment_URL}}/v1/payments/webhook/notifications?page=1&limit=15&sortBy=createdAt:ASC",
"next": "{{Environment_URL}}/v1/payments/webhook/notifications?page=2&limit=15&sortBy=createdAt:ASC",
"last": "{{Environment_URL}}/v1/payments/webhook/notifications?page=228&limit=15&sortBy=createdAt:ASC"
}
}
