{
"id": "123e4567-e89b-12d3-a456-426614174000",
"subscription_id": "123e4567-e89b-12d3-a456-426614174000",
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"membership_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "v1/beneficiaries",
"created_at": "2025-01-27T22:05:07.000Z",
"data": {
"event": "created",
"id": "ce91bc4e-68d6-4ab0-bfab-4a9403f7f316",
"name": "Alice In Wonderland",
"status": "pending",
"iban": "FR7630006000011234567890189",
"bic": "AGRIFRPP",
"trusted": true,
"created_at": "2021-01-27T22:05:07.000Z",
"updated_at": "2021-01-27T22:05:07.000Z"
}
}
Supported webhooks
v1/beneficiaries
OAuth scope: organization.read
Webhook that delivers events related to beneficiaries.
Supported events:
createdupdateddeleted
WEBHOOK
v1
/
beneficiaries
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"subscription_id": "123e4567-e89b-12d3-a456-426614174000",
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"membership_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "v1/beneficiaries",
"created_at": "2025-01-27T22:05:07.000Z",
"data": {
"event": "created",
"id": "ce91bc4e-68d6-4ab0-bfab-4a9403f7f316",
"name": "Alice In Wonderland",
"status": "pending",
"iban": "FR7630006000011234567890189",
"bic": "AGRIFRPP",
"trusted": true,
"created_at": "2021-01-27T22:05:07.000Z",
"updated_at": "2021-01-27T22:05:07.000Z"
}
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"subscription_id": "123e4567-e89b-12d3-a456-426614174000",
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"membership_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "v1/beneficiaries",
"created_at": "2025-01-27T22:05:07.000Z",
"data": {
"event": "created",
"id": "ce91bc4e-68d6-4ab0-bfab-4a9403f7f316",
"name": "Alice In Wonderland",
"status": "pending",
"iban": "FR7630006000011234567890189",
"bic": "AGRIFRPP",
"trusted": true,
"created_at": "2021-01-27T22:05:07.000Z",
"updated_at": "2021-01-27T22:05:07.000Z"
}
}
Authorizations
The signature header follows the format t={timestamp},v1={signature}.
Verification steps:
- Extract the timestamp and signature from the signature header
- Reject the request if the timestamp is older than 5 minutes
- Recreate the signed payload: '{timestamp}.{raw_request_body}'
- Compute HMAC-SHA256 of the signed payload using your webhook secret as the key
- Compare the computed signature with the one in the header
Body
application/json
Unique identifier for this webhook event
Example:
"123e4567-e89b-12d3-a456-426614174000"
ID of the webhook subscription that received the event
Example:
"123e4567-e89b-12d3-a456-426614174000"
ID of the organization that owns the bank account
Example:
"123e4567-e89b-12d3-a456-426614174000"
ID of the membership associated with subscription
Example:
"123e4567-e89b-12d3-a456-426614174000"
Available options:
v1/transactions, v1/accounts, v1/organizations, v1/memberships, v1/consent-revocations, v1/cards, v1/payment-links, v1/payment-links-connections, v1/beneficiaries, v1/client-invoices, v1/terminal-payments, v1/clients, v1/products, v1/transfers, v1/recurring-transfers Example:
"v1/transactions"
Timestamp when the webhook event was created
Example:
"2025-01-24T10:55:00Z"
Show child attributes
Show child attributes
Response
200
Webhook received successfully
Was this page helpful?