> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.redpincompany.com/api-guide/getting-started/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.redpincompany.com/_mcp/server.

# Getting Started

## Docs

- [Environments](https://docs.redpincompany.com/api-guide/getting-started/environments.md): Understanding Redpin's sandbox and production environments for development and testing
- [Authentication](https://docs.redpincompany.com/api-guide/getting-started/authentication.md): Learn how to authenticate with the Redpin APIs
- [Making your first payment](https://docs.redpincompany.com/api-guide/getting-started/making-your-first-payment.md): Step-by-step tutorial to complete your first test payment in sandbox
- [Error handling](https://docs.redpincompany.com/api-guide/getting-started/error-handling.md): Comprehensive guide to handling errors and implementing robust error recovery
- [API versioning](https://docs.redpincompany.com/api-guide/getting-started/api-versioning.md): Understanding how Redpin versions APIs and manages breaking changes
- [Sandbox to production](https://docs.redpincompany.com/api-guide/getting-started/sandbox-to-production.md): Complete guide for migrating from sandbox to production environment


> **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.redpincompany.com/api-guide/getting-started/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.redpincompany.com/_mcp/server.

# Getting started

> Introduction to Redpin's APIs for international property payments

Redpin's APIs enable property developers, real estate platforms, and fintech companies to seamlessly integrate international payment capabilities into their platforms, facilitating cross-border property transactions with compliance and efficiency.

## Overview

Redpin provides a comprehensive suite of APIs designed to address the complex requirements of international property payments. Our platform serves as the financial infrastructure that enables property technology companies to offer their customers seamless cross-border payment solutions without the complexity of building and maintaining international banking relationships.

### Common use cases

#### Property Developers

* Facilitating international buyer payments for new developments
* Enabling overseas investors to purchase units in residential and commercial projects
* Streamlining payment collection for pre-sales and off-plan purchases
* Managing multi-currency transactions for global property portfolios

#### Asset Management Platforms

* Processing investor transactions for managed property portfolios
* Handling rental income distributions to international investors
* Managing acquisition and disposal payments for real estate funds
* Facilitating property investment platform operations

#### Fractional Investment Platforms

* Managing partial property ownership payments from multiple investors
* Coordinating fractional real estate investment transactions
* Processing dividend distributions to fractional property owners
* Enabling crowd-funded real estate investment payments

#### Title Company Software

* Processing closing transactions for international property purchases
* Handling escrow payments for cross-border real estate transactions
* Managing settlement payments between international parties
* Facilitating secure fund transfers for property closings

#### Sales Management Solutions

* Coordinating international property purchase payments
* Managing sales pipeline payments for overseas buyers
* Processing deposit and completion payments for property sales
* Enabling CRM integration with international payment capabilities

> **Note**
>
> Redpin eliminates the complexity of international banking relationships while ensuring regulatory compliance across multiple jurisdictions.

### API categories

#### Customer APIs

**For platforms with direct customer relationships**

Comprehensive payment infrastructure for property technology companies that manage end-to-end customer journeys:

* **Third-party customer onboarding** - Collect compliance data for property buyers without creating direct relationships
* **Currency exchange** - Real-time quotes and competitive conversion rates
* **Payment processing** - International wire transfers with full tracking
* **Recipient management** - Property developer and vendor bank account registration
* **Webhook notifications** - Real-time status updates for customer service integration

**Ideal for**: Property investment platforms, fractional ownership platforms, real estate asset management systems

#### Affiliate APIs

**For partners providing specialized services**

Focused tools for property professionals who need specific functionality without full payment processing:

* **Property transaction fees** - Calculate stamp duty, taxes, and costs across multiple countries
* **Customer referrals** - Submit qualified leads for international property finance
* **Lightweight integration** - Single-purpose endpoints for specialized use cases

**Ideal for**: Property portals, real estate agencies, mortgage brokers, property consultants

> **Info**
>
> Need help choosing the right approach for your platform? See our [Integration Guidelines](/api-guide/partners/integration-guidelines) for detailed comparison and decision framework.

## Core payment flow

> **Info**
>
> Understanding the fundamental payment workflow is essential for successful integration.

### Basic flow diagram

```mermaid
flowchart LR
    A[Third-party<br />Customer Data] --> B[Quote<br />Generation]
    B --> C[Recipient<br />Setup]
    C --> D[Payment<br />Creation]
    D --> E[Fund<br />Transfer]
    E --> F[Completion]
    
    A -.-> A1[Third-party data<br />collection]
    B -.-> B1[Currency pair<br />and amount]
    C -.-> C1[Beneficiary<br />bank details]
    D -.-> D1[Payment order<br />execution]
    E -.-> E1[Bank transfer<br />instructions]
    F -.-> F1[Webhook<br />notifications]
    
    style A fill:#f8fafc,stroke:#1f2937
    style B fill:#f8fafc,stroke:#1f2937
    style C fill:#f8fafc,stroke:#1f2937
    style D fill:#f8fafc,stroke:#1f2937
    style E fill:#f8fafc,stroke:#1f2937
    style F fill:#f8fafc,stroke:#1f2937
```

#### Flow breakdown

#### Third-party customer data submission

* Collect third-party customer information
* Submit compliance data for verification
* Handle verification requirements
* Activate customer for payments

#### Quote generation

* Request currency conversion rates
* Specify amount and currency pair
* Receive quoted rate with expiry
* Customer accepts or declines quote

#### Recipient setup

* Register beneficiary bank details
* Validate recipient information
* Store for future transactions
* Link to specific customers

#### Payment creation

* Create payment order using quote
* Link recipient and customer
* Generate payment instructions
* Initiate transfer process

#### Fund transfer

* Provide bank details to customer
* Customer executes wire transfer
* Monitor payment status
* Confirm receipt and processing

#### Completion

* Execute currency conversion
* Transfer funds to recipient
* Send completion notifications
* Update all system records

## Next steps

#### [Start coding](/api-guide/getting-started/making-your-first-payment)

Follow the step-by-step tutorial to complete your first test payment

#### [Choose integration](/api-guide/partners/integration-guidelines)

Compare API vs Hosted approaches to find the best fit for your platform

#### [Set up authentication](/api-guide/getting-started/authentication)

Implement OAuth 2.0 security following best practices

#### [Configure webhooks](/api-guide/webhooks)

Set up real-time notifications for payment status updates

#### [Test webhooks with the simulator](/api-guide/partners/webhook-simulator)

Trigger sandbox payment event sequences and verify your handler against every status transition

> **Note**
>
> **Ready to dive deeper?** Explore the complete endpoint documentation in the API Reference section, or test all flows in our sandbox environment before production deployment.