Changelog

Summary

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

New Features

Third Party Customer Status Webhook

• What’s New: Platforms can now receive real-time webhook notifications when the status of a third party customer changes (e.g., from PENDING to APPROVED or REJECTED).
• How it Works: When a third party customer’s compliance status is updated, Redpin will send a webhook event to your configured endpoint with the latest status and customer reference.
• Benefits:
  • Enables instant updates to your platform when customer onboarding or compliance review is completed.
  • Reduces the need for polling the API for status changes.
• Event Payload Example:

  1
  {
  2
    "event_id": "3",
  3
    "event_timestamp": "2025-01-01T00:00:00Z",
  4
    "customer_id": "0201001008132685",
  5
    "client_customer_ref": "CUST_001",
  6
    "status": "APPROVED"
  7
  }

• Documentation: See Third Party Customer Webhook Events for integration details and setup instructions.

Bug Fixes

• N/A

Breaking Changes

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

Summary

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

New Documentation

Integration Guides

• Getting Started: Overview of Redpin’s APIs and core payment workflows
• Making Your First Payment: Step-by-step tutorial for processing test payments
• Error Handling: Best practices for handling API errors and implementing retry logic
• Integration Guidelines: Complete guide for partners choosing integration approaches
• Sandbox to Production: Requirements and checklist for production deployment

Summary

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

New Features

Create Third-Party Customer

• Api-Reference: Create Third Party Customer
• Endpoint: POST /api/v1/customers/{customer_id}/third-parties
• Purpose: Onboard end users (buyers/investors) for property transactions without creating direct Redpin customer relationships

Get Third-Party Customer

• Api-Reference: Get Third Party Customer
• Endpoint: GET /api/v1/customers/{customer_id}/third-parties/{client_customer_reference}
• Purpose: Retrieve customer profiles and compliance status for ongoing transaction management

Update Third-Party Customer

• Api-Reference: Update Third Party Customer
• Endpoint: PUT /api/v1/customers/{customer_id}/third-parties/{client_customer_reference}
• Purpose: Update customer information and trigger re-verification when needed

Create Payment Session API

• Endpoint: POST /api/v1/customers/:customer_id/sessions
• Purpose: Start a hosted payment session for cross-border payments.
• Highlights:
  • Generates a secure, time-limited session URL for embedding in your app or website
  • Supports multi-recipient payments with detailed recipient and bank account data
  • Configurable allowed origins and callback URLs for real-time status updates
  • Secured with OAuth 2.0 authentication
  • Sessions automatically expire at the defined timestamp; a new session must be created if the previous one expires before completion

Summary

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

Recipient API Endpoints

Add Recipient

• Endpoint: POST /v2/customers/:customer_id/recipients.
• Purpose: Register a new recipient with personal and bank account details for future payments.
• Highlights:
  • Supports both individual and corporate recipients.
  • Collects comprehensive recipient information (name, contact, address, country).
  • Flexible bank account input: IBAN, account number + SWIFT, routing codes, and more.

Update Recipient

• Endpoint: PUT /v2/customers/:customer_id/recipients/:recipient_id.
• Purpose: Update an existing recipient’s details, such as contact information or bank account data.
• Highlights:
  • Modify recipient personal, contact, or bank details.
  • Maintain up-to-date records for compliance and payment accuracy.

Get All Recipients

• Endpoint: GET /v2/customers/:customer_id/recipients.
• Purpose: Retrieve a list of all recipients registered for a specific customer.
• Highlights:
  • List all recipients for a customer, including their details and status.
  • Supports pagination for large recipient lists.
  • Useful for displaying recipient options in your application.

Summary

🔔 New Webhook Events: Added webhook APIs for real-time status updates on customers, virtual accounts, and payments.

New Features

Customer Status Updated Webhook

• Event: customer_status_updated
• Purpose: Receive notifications when a customer’s status changes (e.g., active/inactive).
• Payload: Includes customer details, status, and required documents.

Virtual Account Status Updated Webhook

• Event: virtual_account_status_updated
• Purpose: Get notified when a virtual account becomes active or closed.
• Payload: Includes virtual account details, status, and bank information.

Payment Status Updated Webhook

• Event: payment_status_updated
• Purpose: Track the full payment journey with granular status updates (e.g., awaiting funds, FX completed, payout credited, etc.).
• Payload: Status-specific data for each payment event, including amounts, currencies, recipients, and more.

Summary

🚀 New API Endpoints: Added the “Create Quote” and “Get Recipient Details” APIs to the B2B API suite, enabling businesses to request currency quotations and retrieve recipient information for seamless payment processing.

New Features

Create Quote API

• Endpoint: POST /v1/customers/:customer_id/quotes
• Purpose: Request fixed price quotations for currency exchange
• Key Features:
  • Supports both BUY and SELL fixed side scenarios
  • Validates currency codes and amount precision
  • Returns comprehensive quote details with expiry timestamps
  • Provides real-time exchange rates and converted amounts
  • Includes detailed validation for supported currency combinations

Get Recipient Details API

• Endpoint: GET /v2/customers/:customer_id/recipients/:recipient_id
• Purpose: Retrieve detailed recipient information for payment processing
• Key Features:
  • Returns complete recipient profile including bank details
  • Supports both Individual and Corporate recipient types
  • Includes address validation and formatting standards
  • Provides comprehensive bank account information (IBAN, SWIFT, routing codes)
  • Returns recipient status and validation information

Technical Features

• Authentication: OAuth 2.0 Bearer token authentication required
• Validation: Comprehensive input validation with detailed error messages
• Documentation: Complete API documentation with practical examples
• Error Handling: Detailed error responses with field-level information
• Examples: Realistic request/response examples for seamless integration

Summary

🚀 New API Endpoints: Added the “Create Payment” and “Get Bank Transfer Instructions” APIs to the B2B API suite, enabling businesses to create FX conversions and retrieve detailed bank transfer instructions for pending international payments.

New Features

Create Payment API

• Endpoint: POST /v3/customers/:customer_id/payments
• Purpose: Create FX conversion and payment with recipient details
• Key Features:
  • Supports single and multiple recipient payments
  • Validates payment amounts against quote details
  • Generates unique payment IDs for tracking
  • Returns comprehensive payment status and recipient information

Get Bank Transfer Instructions API

• Endpoint: GET /v3/customers/:customer_id/payments/:payment_id/bank-transfer-instructions
• Purpose: Retrieve detailed bank transfer instructions for pending payments
• Key Features:
  • Returns complete bank account details (account number, routing number, SWIFT/BIC codes)
  • Provides payment-specific reference information
  • Includes transfer amount and currency details
  • Returns clear payment instructions and notes

Summary

🎉 Welcome to Redpin! Initial release of the Redpin API documentation with comprehensive guides and reference materials.