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

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

API Updates

Create Payment

  • Endpoint: POST /v3/customers/:customer_id/payments
  • What’s New: FX conversion is now optional in the payment creation workflow
  • Key Changes:
    • FX Conversion (Optional): If you need to convert currency, provide a quote_id from an active quote
      • The quote must be active and not expired
      • Quote validation ensures accurate FX rates and conversion amounts
    • Same Currency Payment: If no currency conversion is needed (same currency payment), do not send quote_id
      • Enables direct same-currency payments without requiring a quote
      • Streamlines payment creation for domestic or same-currency transfers

Usage Guidelines:

  • For FX Conversion Payments: Include quote_id in the request payload. The quote must be active and not expired.
  • For Same Currency Payments: Omit quote_id from the request payload. The payment will be processed without currency conversion.

Webhook Updates

Payment Status Updated Event

Updated payment status descriptions to clarify when each status applies:

StatusDescriptionApplies To
PROCESSINGPayment is being processed. Immediately after the response from Payment v3 call for same-currency paymentsSame currency payments only
AWAITING_FUNDSPayment created, waiting for funds to be receivedFX conversion payments
RECEIVED_FUNDSFunds have been received and credited to customer’s Redpin walletFX conversion payments

Status Flow Differences:

  • Same Currency Payments: Start with PROCESSING status immediately after payment creation
  • FX Conversion Payments: Start with AWAITING_FUNDS status, then transition to RECEIVED_FUNDS when funds are received

Breaking Changes

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