GuidesAPI ReferenceChangelog
Changelog

v1.0.41

  1. 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/events and /v2/webhooks/subscriptions endpoints (details below)

  2. Added Recipient RFI: RFI cases whose subject is a recipient, served by the same case endpoints with subject.type set to RECIPIENT, documented in a new Recipient RFI section under 3rd Party Withdrawals → Recipients

  3. Added the recipient RFI webhook events rfi.recipient.action_required, rfi.recipient.answered, rfi.recipient.rejected and rfi.recipient.closed

  4. Added the recipient-only document_type values STANDARD_RECIPIENT_INFORMATION, RECIPIENT_BUSINESS_DETAILS, RECIPIENT_ADDRESS_REGISTRATION and RECIPIENT_CONTACT_DETAILS; each case class has its own list of supported types and a type outside it is rejected with 400

  5. 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

MethodEndpointPurpose
GET/v2/webhooks/eventsFind 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}/deliveriesInspect delivery history.
GET/v2/webhooks/subscriptionsList active webhook destinations.
POST/v2/webhooks/events/{event_id}/replaysRequest 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=FAILED or an event-name prefix such as deposit.*. An event is FAILED when all target deliveries have finished and at least one failed.
  • A replay can target all active subscriptions, one subscription, or only subscriptions currently in FAILED status. It requires a UUID Idempotency-Key and returns 202 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.rejected and rfi.recipient.closed.
  • Recipient-only document_type values: 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_type values; a submission with a type outside the case's list is rejected with 400.
  • 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.