v1.0.41
-
Added webhook recovery and replay: find events with failed deliveries, inspect their delivery history and subscriptions, and replay a saved notification through the new
/v2/webhooks/eventsand/v2/webhooks/subscriptionsendpoints (details below) -
Added Recipient RFI: RFI cases whose subject is a recipient, served by the same case endpoints with
subject.typeset toRECIPIENT, documented in a new Recipient RFI section under 3rd Party Withdrawals → Recipients -
Added the recipient RFI webhook events
rfi.recipient.action_required,rfi.recipient.answered,rfi.recipient.rejectedandrfi.recipient.closed -
Added the recipient-only
document_typevaluesSTANDARD_RECIPIENT_INFORMATION,RECIPIENT_BUSINESS_DETAILS,RECIPIENT_ADDRESS_REGISTRATIONandRECIPIENT_CONTACT_DETAILS; each case class has its own list of supported types and a type outside it is rejected with400 -
Corrected the RFI get-case example and submission guidance to use
accepted_document_types: any one of the listed values completes a FILE requirement
Webhook recovery and replay
You can now find webhook events with failed deliveries, inspect the affected subscriptions, and replay a saved notification. A replay does not repeat the underlying deposit, transfer, or other business action.
New endpoints
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /v2/webhooks/events | Find events, including those with failed targets. |
| GET | /v2/webhooks/events/{event_id} | Retrieve one event and its subscription statuses. |
| GET | /v2/webhooks/events/{event_id}/deliveries | Inspect delivery history. |
| GET | /v2/webhooks/subscriptions | List active webhook destinations. |
| POST | /v2/webhooks/events/{event_id}/replays | Request a replay to one or more active subscriptions. |
| GET | /v2/webhooks/events/{event_id}/replays/{replay_id} | Check the outcome of an accepted replay. |
Behavior
- Filter events with
status=FAILEDor an event-name prefix such asdeposit.*. An event isFAILEDwhen all target deliveries have finished and at least one failed. - A replay can target all active subscriptions, one subscription, or only subscriptions currently in
FAILEDstatus. It requires a UUIDIdempotency-Keyand returns202 Accepted; check the replay endpoint for delivery outcomes. - Manual replays make one HTTP send attempt after sending starts. Automatic webhook retries are unchanged. Replayed notifications retain the original
X-Webhook-Event-Id. - Event discovery covers the last 30 × 24 hours. A replay receipt remains available for 30 × 24 hours after acceptance, even if the event leaves the discovery window.
- ReadOnly API keys can inspect events and replays; requesting a replay requires a Standard API key.
See Recover Missed Webhooks for the recommended workflow.
Recipient RFI and recipient document types
RFI cases can now have a recipient as their subject. The case endpoints serve transaction and recipient cases alike; subject.type (TRANSACTION or RECIPIENT) tells them apart, and the list endpoint returns both unless filtered by subject_type.
New
- Recipient RFI section under 3rd Party Withdrawals → Recipients: overview, list cases, get case, respond, webhooks.
- Webhook events
rfi.recipient.action_required,rfi.recipient.answered,rfi.recipient.rejectedandrfi.recipient.closed. - Recipient-only
document_typevalues:STANDARD_RECIPIENT_INFORMATION,RECIPIENT_BUSINESS_DETAILS,RECIPIENT_ADDRESS_REGISTRATION,RECIPIENT_CONTACT_DETAILS. Recipient cases use their own, shorter list.
Behavior
- Each case class has its own list of supported
document_typevalues; a submission with a type outside the case's list is rejected with400. - A FILE requirement lists
accepted_document_types; any one of them completes it. Supporting files of other supported types are stored as voluntary evidence and do not complete a requirement.
See Recipient RFI for the full flow.
