Changelog

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.

Webhook event simulator: Expanded the sandbox webhook event simulator to support new realistic failure and edge-case status flows: "Cancel Payment — Funding Failure", "Cancel Payment — Payout Failure", and "Bounced Back". These updates allow developers to test end-to-end integration and error handling paths in a scripted environment.

Webhook event simulator: Added a partner-facing guide for the sandbox webhook event simulator at simulator.sandbox.redpincompany.com, which lets you exercise your webhook handler against a scripted sequence of payment lifecycle events for a given session.

🚀 Hosted Sessions Listing API: Added a new read endpoint to list hosted payment sessions for a customer, including idempotency lookup by client_reference_id.

• Updated the payment reconciliation guide to include a retry recovery pattern:
  • If session creation response is lost or a retry occurs, first query sessions by client_reference_id for the same customer_id to fetch the existing session and avoid duplicate creation.

🚀 Hosted Payment Sessions Multi-Currency & Non-IBAN Support: Enhanced Hosted Payment Sessions to support multiple currencies and non-IBAN regions by enabling developers to reference pre-created recipients instead of embedding recipient details in session requests.

⚠️ Important: This is a breaking change for existing integrations using Hosted Payment Sessions.

The recipient_details structure in payment session requests has changed. Instead of embedding full recipient objects (name, address, bank details) directly in the session request, you must now reference pre-created recipients using recipient_id. This change enables support for multiple currencies and non-IBAN bank detail formats.

• Create Payment Session - Updated request structure
• Add a New Recipient - Required before creating sessions
• Integration Guidelines - Updated workflow documentation

🚀 Currency Expansion & Recipient Management Enhancements: Added support for payout currencies and enhanced recipient management with currency-specific fields for better compliance and data management.

• None. All changes are additive and backward compatible.

🚀 Create Payment API Enhancement: The Create Payment API now supports optional FX conversion, allowing you to create same-currency payments without requiring a quote. FX conversion is optional - provide a quote_id only when currency conversion is needed.

• None. The quote_id field remains optional, maintaining backward compatibility with existing integrations.

📋 Legacy Payment APIs Documentation: Documented legacy v2 Payment API endpoints and provided migration guidance to help existing integrations transition to the improved v3 Payments API.

Regulatory Compliance Updates: Added comprehensive guides for Confirmation of Payee (CoP) and Verification of Payee (VoP), covering all error codes, step-by-step resolution workflows, and updated API support for regulatory verification retries.

Third Party Customer Status Webhook: Added webhook notifications for third party customer status updates.

• N/A

• None. This is a non-breaking, additive change.

📖 New Integration Guides: Added comprehensive documentation to help developers integrate with Redpin’s APIs more effectively.

🚀 New Third Party Customer APIs: Added APIs for property developers and real estate platforms to manage end-user customer profiles.

🚀 New Recipient Management APIs: The B2B API suite now includes new endpoints to add, update, and retrieve recipient details, making it easier to manage business payments.