Skip to navigation

Changelog

Stay up-to-date with the latest improvements, new features, and changes to the Redpin Platform API.

We regularly update our API to provide better functionality and security. All changes are backwards compatible unless explicitly noted.

What’s in a changelog entry?

Each changelog entry includes:

  • Summary: Overview of the release
  • New Features: Fresh functionality added to the API
  • Bug Fixes: Issues resolved in this version
  • Breaking Changes: Any changes that might affect existing integrations

Summary

Breaking change in @redpincompany/hosted-payment-sdk 2.0.0: The hosted thank-you page no longer posts VIEW_ALL_PAYMENTS. It posts REDPIN_PAYMENT_TRACKING_EXITED. The SDK maps that message to onPaymentFlowExited (() => void). onViewAllPayments is not called.

Summary

List payment sessions: GET /v1/customers/{customer_id}/sessions now includes payment_method once the buyer has selected a payment method. The path, query parameters, and pagination envelope are unchanged.

Summary

Payment scheme note in bank transfer instructions: The Get Bank Transfer Instructions response now includes an optional payment_scheme_note field.

Integration Notes

Check for the presence of the key before rendering it. Clients that ignore unknown fields require no change.

Summary

Hosted analytics consent: Documented the embedded hosted-session contract for forwarding analytics consent from the host application. Hosts send a SET_ANALYTICS_CONSENT message so product analytics and session diagnostics stay off until analytics consent is granted. The hosted page listens for that message and does not emit a consent-ready event.

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.

Summary

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.

Summary

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.

Summary

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

Documentation Updates

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

Summary

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

Hosted Payment Sessions now support all currencies and bank detail formats, enabling international expansion beyond UAE/IBAN regions. Developers can now create recipients once and reuse them across multiple payment sessions.

Breaking Changes

⚠️ 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.

API Reference Updates

Summary

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

Recipient APIs now support currency-specific additional details, enabling compliance with local regulatory requirements for different payout currencies.

Breaking Changes

  • None. All changes are additive and backward compatible.

Summary

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

The Create Payment API now provides flexible payment creation workflows. For same-currency payments, simply omit the quote_id. For FX conversions, provide an active quote_id from a valid quote.

Breaking Changes

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

Summary

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

All Legacy API endpoints have been superseded by newer versions that offer improved functionality and consistency. We strongly recommend migrating to the latest versions for better performance, enhanced tracking, and improved error handling.

Summary

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.

Summary

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