# Home

> Welcome to Redpin API documentation. Integrate with our international payment and currency services platform.

Welcome to the Redpin API documentation. This comprehensive guide will help you integrate with our international payment and currency services platform.

## Quick Start

#### [Get Started](/api-guide/getting-started)

Begin integrating with Redpin's payment APIs

#### [API Guides](/api-guide/affiliates/property-transaction-fees)

Learn how to handle international property transactions

#### [API Reference](/api-reference)

Complete API documentation with schemas and examples

## What You Can Do

* Process international property transaction payments
* Handle currency conversions and transfers
* Manage referrals and affiliate programs
* Set up webhooks for real-time payment notifications
* Access comprehensive transaction and fee data

## Need Help?

If you have any questions or need assistance, please refer to our API Guide or contact our support team.

> Welcome to Redpin API documentation. Integrate with our international payment and currency services platform.

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.redpincompany.com/_mcp/server

## Docs

- [Getting started](https://docs.redpincompany.com/api-guide/getting-started.md): Introduction to Redpin's APIs for international property payments
- [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
- [Integration guidelines](https://docs.redpincompany.com/api-guide/partners/integration-guidelines.md): Comprehensive guide for property developers integrating with Redpin's payment APIs
- [Quickstart Setup](https://docs.redpincompany.com/api-guide/partners/quickstart-setup.md): Get started with Redpin B2B API integration - complete setup guide for API and Hosted UI integration
- [Test webhooks with the simulator](https://docs.redpincompany.com/api-guide/partners/webhook-simulator.md): Trigger sandbox payment event sequences and verify your webhook handler receives each callback correctly
- [Property transaction fees](https://docs.redpincompany.com/api-guide/affiliates/property-transaction-fees.md): Calculate property transaction fees across multiple countries
- [Customer referrals](https://docs.redpincompany.com/api-guide/affiliates/referrals.md): Submit customer referrals for property-related currency services
- [Webhooks overview](https://docs.redpincompany.com/api-guide/webhooks/webhooks.md): Introduction to Redpin Webhooks
- [Payment reconciliation](https://docs.redpincompany.com/api-guide/webhooks/reconciliation.md): Guide to reconciling all payment types (hosted sessions, API-integrated []third-party, non-third-party]) with your internal systems
- [UK Confirmation of Payee regulations](https://docs.redpincompany.com/api-guide/regulatory-guides/cop-guide.md)
- [SEPA Verification of Payee regulations](https://docs.redpincompany.com/api-guide/regulatory-guides/vop-guide.md)
- [Legacy APIs](https://docs.redpincompany.com/api-reference/customers/api-integration.md): Deprecated API endpoints that are no longer the standard version
- [Changelog](https://docs.redpincompany.com/changelog.md)
- [Changelog (all entries)](https://docs.redpincompany.com/changelog/llms.txt)

## API Docs

- Affiliates [Property buyer fees](https://docs.redpincompany.com/api-reference/affiliates/calculate-property-fees.md)
- Affiliates [Submit a new referral](https://docs.redpincompany.com/api-reference/affiliates/create-referral.md)
- API Integration > Customers [Get Customer's ID](https://docs.redpincompany.com/api-reference/customers/api-integration/customers/get-customer-id.md)
- API Integration > Customers [Register a Customer](https://docs.redpincompany.com/api-reference/customers/api-integration/customers/register-customer.md)
- API Integration > Customers [Get Customer](https://docs.redpincompany.com/api-reference/customers/api-integration/customers/get-customer-details.md)
- API Integration > Customers [Upload Documents](https://docs.redpincompany.com/api-reference/customers/api-integration/customers/upload-documents.md)
- API Integration > Contacts [Add Contact](https://docs.redpincompany.com/api-reference/customers/api-integration/contacts/add-customer-contact.md)
- API Integration > Contacts [Update a Contact](https://docs.redpincompany.com/api-reference/customers/api-integration/contacts/update-customer-contact.md)
- API Integration > Third Parties [Create Third-Party Customer](https://docs.redpincompany.com/api-reference/customers/api-integration/third-parties/create-third-party-customer.md)
- API Integration > Third Parties [Get Third-Party Customer](https://docs.redpincompany.com/api-reference/customers/api-integration/third-parties/get-third-party-customer.md)
- API Integration > Third Parties [Update Third-Party Customer](https://docs.redpincompany.com/api-reference/customers/api-integration/third-parties/update-third-party-customer.md)
- API Integration > Quotes [Create Quote](https://docs.redpincompany.com/api-reference/customers/api-integration/quotes/create-quote.md)
- API Integration > Recipients [Get Recipients](https://docs.redpincompany.com/api-reference/customers/api-integration/recipients/get-recipients.md)
- API Integration > Recipients [Add a new recipient](https://docs.redpincompany.com/api-reference/customers/api-integration/recipients/add-a-new-recipient.md)
- API Integration > Recipients [Get recipient details](https://docs.redpincompany.com/api-reference/customers/api-integration/recipients/get-recipient.md)
- API Integration > Recipients [Update a recipient's account](https://docs.redpincompany.com/api-reference/customers/api-integration/recipients/update-a-recipients-account.md)
- API Integration > Recipients [Delete recipient](https://docs.redpincompany.com/api-reference/customers/api-integration/recipients/delete-recipient.md)
- API Integration > Rates [Get Exchange Rates](https://docs.redpincompany.com/api-reference/customers/api-integration/rates/get-exchange-rates.md)
- API Integration > Conversions [View Conversions](https://docs.redpincompany.com/api-reference/customers/api-integration/conversions/view-conversions.md)
- API Integration > Conversions [Request Conversion](https://docs.redpincompany.com/api-reference/customers/api-integration/conversions/request-conversion.md)
- API Integration > Conversions [Get a Conversion](https://docs.redpincompany.com/api-reference/customers/api-integration/conversions/get-conversion.md)
- API Integration > Balances [Get Balances](https://docs.redpincompany.com/api-reference/customers/api-integration/balances/get-balances.md)
- API Integration > Balances [Get a Balance](https://docs.redpincompany.com/api-reference/customers/api-integration/balances/get-balance.md)
- API Integration > Payments [Get Payment Details](https://docs.redpincompany.com/api-reference/customers/api-integration/payments/get-payment-details.md)
- API Integration > Payments [List Payments](https://docs.redpincompany.com/api-reference/customers/api-integration/payments/list-payments.md)
- API Integration > Payments [Create payment](https://docs.redpincompany.com/api-reference/customers/api-integration/payments/create-payment.md)
- API Integration > Payments [Get Bank Transfer Instructions](https://docs.redpincompany.com/api-reference/customers/api-integration/payments/get-payment-bank-transfer-instructions.md)
- API Integration > Statements [View Statements](https://docs.redpincompany.com/api-reference/customers/api-integration/statements/get-statements.md)
- API Integration > References [Currencies](https://docs.redpincompany.com/api-reference/customers/api-integration/references/get-currencies.md)
- API Integration > References [Transaction Purposes](https://docs.redpincompany.com/api-reference/customers/api-integration/references/get-transaction-purposes.md)
- API Integration > References [Employment Status](https://docs.redpincompany.com/api-reference/customers/api-integration/references/get-employment-statuses.md)
- API Integration > References [Employment Industry](https://docs.redpincompany.com/api-reference/customers/api-integration/references/get-employment-industries.md)
- API Integration > Virtual Accounts [View virtual accounts](https://docs.redpincompany.com/api-reference/customers/api-integration/virtual-accounts/get-virtual-accounts.md)
- API Integration > Virtual Accounts [Request a virtual account](https://docs.redpincompany.com/api-reference/customers/api-integration/virtual-accounts/request-virtual-account.md)
- API Integration > Virtual Accounts [View a virtual account](https://docs.redpincompany.com/api-reference/customers/api-integration/virtual-accounts/get-virtual-account-by-vban.md)
- API Integration > Webhooks [Create a webhook](https://docs.redpincompany.com/api-reference/customers/api-integration/webhooks/create-webhook.md)
- API Integration > Webhooks [Unsubscribe from status updates](https://docs.redpincompany.com/api-reference/customers/api-integration/webhooks/delete-webhook.md)
- API Integration > Legacy APIs > Legacy Payments [Make a Payment](https://docs.redpincompany.com/api-reference/customers/api-integration/legacy-ap-is/legacy-payments/create-payment-v-2.md)
- API Integration > Legacy APIs > Legacy Payments [Review Payments](https://docs.redpincompany.com/api-reference/customers/api-integration/legacy-ap-is/legacy-payments/review-payments.md)
- API Integration > Legacy APIs > Legacy Payments [View a Payment](https://docs.redpincompany.com/api-reference/customers/api-integration/legacy-ap-is/legacy-payments/view-payment.md)
- Hosted Experience > Sessions [List payment sessions](https://docs.redpincompany.com/api-reference/customers/hosted-experience/sessions/list-payment-sessions.md)
- Hosted Experience > Sessions [Create a payment session](https://docs.redpincompany.com/api-reference/customers/hosted-experience/sessions/create-payment-session.md)
- Webhook Reference > Referrals [Referral Created Event](https://docs.redpincompany.com/api-reference/webhooks/referrals/webhook-referral-created.md)
- Webhook Reference > Customers [Customer Status Updated Event](https://docs.redpincompany.com/api-reference/webhooks/customers/webhook-customer-status-updated.md)
- Webhook Reference > Virtual Accounts [Virtual Account Status Updated Event](https://docs.redpincompany.com/api-reference/webhooks/virtual-accounts/webhook-virtual-account-status-updated.md)
- Webhook Reference > Payments [Payment Status Updated Event](https://docs.redpincompany.com/api-reference/webhooks/payments/webhook-payment-status-updated.md)
- Webhook Reference > Third Party Customers [Third Party Customer Status Updated Event](https://docs.redpincompany.com/api-reference/webhooks/third-party-customers/webhook-third-party-customer-status-updated.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.redpincompany.com/openapi.json)
- [OpenAPI YAML](https://docs.redpincompany.com/openapi.yaml)