Webhook Messages
The Webhook Messages API allows you to inspect and manage individual webhook delivery attempts. This is useful for debugging webhook issues.
You must include your Bearer token in the request header.
Retrieves a paginated list of webhook messages, optionally filtered by date range and status.
Filter messages created from this date (YYYY-MM-DD).
2025-04-26
Filter messages created up to this date (YYYY-MM-DD).
2025-04-27
Number of items to return per page in a paginated response.
15
The current page number for paginated results.
1
Sort direction for the message list.
desc
Possible values: Field to sort the message list by.
created_at
Possible values: Filter messages by their delivery status.
delivered
Possible values: GET /api/v1/webhooks_messages HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
[
{
"uuid": "c1a9b8d7-e6f5-4321-ba98-7654321fedcb",
"created_at": 1745825706,
"status": "delivered",
"account_uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
"account": {
"uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
"account_number": "LT433400015000036002",
"currency": "EUR",
"balance": 100.5,
"balance_national": 100.5,
"book_balance": 0,
"book_balance_national": 0,
"available_balance": 100.5,
"available_balance_national": 100.5,
"hold": 0,
"cards_reserved_amount": 0,
"cards_reserved_amount_national": 0
},
"transaction": {
"uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"parent_transaction_uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"status": "processed",
"operation_date": "2025-04-27",
"operation_date_time": "2025-04-27T10:30:00Z",
"operation_date_unix": 1745821800,
"amount": 1234.56,
"currency": "EUR",
"payment_type": "SEPA",
"transaction_type": "payment",
"payment_urgency": "NORMAL",
"payment_details": "Invoice #INV-123 Payment",
"payment_code": "SALARY",
"end_to_end_ident": "E2E-XYZ789",
"direction": "CREDIT",
"document_number": "DOC-456",
"created_at": 1745820000,
"payer": {
"name": "John Doe",
"iban": "DE89 3704 0044 0532 0130 00",
"address": "123 Main St, Anytown",
"country_code": "DE",
"agency_id": "DEUTDEFF",
"agency_name": "Deutsche Bank",
"agency_address": "Taunusanlage 12, Frankfurt",
"ultimate": {
"name": "Ultimate Payer Corp"
}
},
"recipient": {
"name": "Jane Smith",
"iban": "FR76 3000 6000 0112 3456 7890 189",
"address": "456 Oak Ave, Otherville",
"country_code": "FR",
"agency_id": "SOGEFRPP",
"agency_name": "Société Générale",
"agency_address": "29 Boulevard Haussmann, Paris",
"ultimate": {
"name": "Ultimate Recipient Inc"
}
}
}
}
]
Retrieves the details of a specific webhook message by its UUID.
Universally Unique Identifier (UUID) as defined by RFC 4122.
e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g
Pattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
GET /api/v1/webhooks_messages/{uuid} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"uuid": "c1a9b8d7-e6f5-4321-ba98-7654321fedcb",
"created_at": 1745825706,
"status": "delivered",
"account_uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
"account": {
"uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
"account_number": "LT433400015000036002",
"currency": "EUR",
"balance": 100.5,
"balance_national": 100.5,
"book_balance": 0,
"book_balance_national": 0,
"available_balance": 100.5,
"available_balance_national": 100.5,
"hold": 0,
"cards_reserved_amount": 0,
"cards_reserved_amount_national": 0
},
"transaction": {
"uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"parent_transaction_uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"status": "processed",
"operation_date": "2025-04-27",
"operation_date_time": "2025-04-27T10:30:00Z",
"operation_date_unix": 1745821800,
"amount": 1234.56,
"currency": "EUR",
"payment_type": "SEPA",
"transaction_type": "payment",
"payment_urgency": "NORMAL",
"payment_details": "Invoice #INV-123 Payment",
"payment_code": "SALARY",
"end_to_end_ident": "E2E-XYZ789",
"direction": "CREDIT",
"document_number": "DOC-456",
"created_at": 1745820000,
"payer": {
"name": "John Doe",
"iban": "DE89 3704 0044 0532 0130 00",
"address": "123 Main St, Anytown",
"country_code": "DE",
"agency_id": "DEUTDEFF",
"agency_name": "Deutsche Bank",
"agency_address": "Taunusanlage 12, Frankfurt",
"ultimate": {
"name": "Ultimate Payer Corp"
}
},
"recipient": {
"name": "Jane Smith",
"iban": "FR76 3000 6000 0112 3456 7890 189",
"address": "456 Oak Ave, Otherville",
"country_code": "FR",
"agency_id": "SOGEFRPP",
"agency_name": "Société Générale",
"agency_address": "29 Boulevard Haussmann, Paris",
"ultimate": {
"name": "Ultimate Recipient Inc"
}
}
}
}
Allows updating the status of a specific webhook message.
Universally Unique Identifier (UUID) as defined by RFC 4122.
e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g
Pattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
The new status to set for the webhook message.
PATCH /api/v1/webhooks_messages/{uuid}?status=processing HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"uuid": "c1a9b8d7-e6f5-4321-ba98-7654321fedcb",
"created_at": 1745825706,
"status": "delivered",
"account_uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
"account": {
"uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
"account_number": "LT433400015000036002",
"currency": "EUR",
"balance": 100.5,
"balance_national": 100.5,
"book_balance": 0,
"book_balance_national": 0,
"available_balance": 100.5,
"available_balance_national": 100.5,
"hold": 0,
"cards_reserved_amount": 0,
"cards_reserved_amount_national": 0
},
"transaction": {
"uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"parent_transaction_uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"status": "processed",
"operation_date": "2025-04-27",
"operation_date_time": "2025-04-27T10:30:00Z",
"operation_date_unix": 1745821800,
"amount": 1234.56,
"currency": "EUR",
"payment_type": "SEPA",
"transaction_type": "payment",
"payment_urgency": "NORMAL",
"payment_details": "Invoice #INV-123 Payment",
"payment_code": "SALARY",
"end_to_end_ident": "E2E-XYZ789",
"direction": "CREDIT",
"document_number": "DOC-456",
"created_at": 1745820000,
"payer": {
"name": "John Doe",
"iban": "DE89 3704 0044 0532 0130 00",
"address": "123 Main St, Anytown",
"country_code": "DE",
"agency_id": "DEUTDEFF",
"agency_name": "Deutsche Bank",
"agency_address": "Taunusanlage 12, Frankfurt",
"ultimate": {
"name": "Ultimate Payer Corp"
}
},
"recipient": {
"name": "Jane Smith",
"iban": "FR76 3000 6000 0112 3456 7890 189",
"address": "456 Oak Ave, Otherville",
"country_code": "FR",
"agency_id": "SOGEFRPP",
"agency_name": "Société Générale",
"agency_address": "29 Boulevard Haussmann, Paris",
"ultimate": {
"name": "Ultimate Recipient Inc"
}
}
}
}
Last updated
Was this helpful?