Skip to main content
Release type: API Change (Webhooks) Applies to: Collection Accounts — all collection_account.* webhook events The Collection Account webhook payload now matches the response of Get Collection Account (GET /v3/collection_account/{id}). data is the collection account. Details of the request that triggered the event are in the data.requests array. Every Collection Account event uses this same structure.

What changed

No existing webhook key is removed or renamed. The payload gains new keys, and four existing keys now carry the values of the collection account instead of the request. In this entry, “request events” means every collection_account.* event except creation_succeeded, disablement_succeeded, and reenable_succeeded. The request events are listed under Upcoming Webhook Events.

Existing keys with new values

creation_succeeded, disablement_succeeded, and reenable_succeeded already sent the account ID, status, and timestamps. For these three events, only data.currencies changes value.

New keys in data

payment_method_type and metadata were sent only on these three events. They are now sent on every event. data.failure_reason is unchanged. It is still sent on *_failed events, and the same value is in requests[].failure_reason.

Action required

If your integration reads data.id or data.status to track a request, update it:
  1. Read the account ID from data.id. It is now always the cva_ / cwa_ ID, which you can pass to Get Collection Account.
  2. Read the request status from status on the matching entry in data.requests, not from data.status.
  3. Read the list of currencies the account accepts from data.currencies, or the status of every currency from data.currency_status.
On disablement_failed, disablement_cancelled, disablement_requires_action, and disablement_under_processing, data.status is enabled, because the account still accepts funds. Before this change, data.status showed the request status, such as failed.

Example webhook payload

This collection_account.creation_succeeded payload shows the new structure: