Changelog

Summary

Payment status and webhook payload optimization: Removed all references to the REFUNDED status across our API schemas, webhook event flows, and documentation to align with current API capabilities. Additionally, simplified webhook payloads for CANCELLED and BOUNCED_BACK events by removing metadata parameters (reason_description and bounce_reason), streamlining downstream event consumption.

API Changes

Schema updates

• Payment status enums: Removed the REFUNDED state from payment and recipient status tracking schemas.
• Webhook event payloads:
  • Removed reason_description from the CANCELLED webhook event schema.
  • Removed bounce_reason from the BOUNCED_BACK webhook event schema.
  • Removed refund-related attributes (refund_amount, refund_reason) from webhook schemas.

Documentation Updates

Page updates

• Payment reconciliation guide — Updated status diagrams, flowchart paths, and JSON payload examples to exclude REFUNDED state references and associated cancellation/bounce reasons.
• Webhook simulator — Streamlined the “Bounced Back” simulation scenario documentation to reflect the removed bounce metadata.
• Integration guidelines — Removed references to refund failure notifications.