Affiliates

Customer referrals

The Referrals API allows partners to submit potential customer information for property-related currency services.

Our Referrals API enables partners to seamlessly transfer customer information directly into our CRM system. This integration helps ensure timely follow-up with potential customers interested in currency exchange services for property transactions.

Common Use Cases
  • Real estate agents referring clients who need currency exchange for property purchases.
  • Property websites capturing interest from international buyers.
  • Mortgage brokers referring clients who need to transfer funds internationally.
  • Relocation companies supporting clients moving to new countries.

For detailed API specifications including request parameters, response structure, and examples, please refer to the API Reference.

Data Requirements

The API supports two types of customers:

  • Personal: Individual customers with a foreign exchange requirement
  • Corporate: Business entities with a foreign exchange requirement

At minimum, the following contact information is required:

  • Contact name
  • Email address
  • Phone number

For corporate customers, a company name should also be captured.

Additional fields like address, currency pair and estimated transaction value are optional but recommended for better customer service.

The additional details below can be captured to

  • partner_id: Only relevant if you use multiple partner IDs e.g. to assign referrals to specific branches
  • client_reference_id: Your internal reference ID
  • enquiry_notes: Any information which may help us when contacting the referral
  • service_required: The type of service needed
  • country_moving_to: Destination country if relevant
  • ccy_pair: Currency pair for the exchange (e.g. GBPEUR)
  • etv: Estimated transaction value range

Implementation Best Practices

Error Handling

For a complete list of status codes and error responses, please refer to the API Reference.

Common error scenarios to handle in your implementation:

If any required fields are missing, the API will return a 400 error with a specific error code identifying the missing field.

Solution: Implement client-side validation to ensure all required fields are completed before submission.

Email addresses, phone numbers, and dates must be in the correct format.

Solution: Validate formats before submission:

  • Email: valid email format
  • Phone numbers: include country code with + prefix
  • Date of birth: use ISO 8601 format (YYYY-MM-DD)

Data Privacy Considerations

All partners must ensure they have proper consent to share customer data. This includes:

  • Clear disclosure to customers that their data will be shared with Currencies Direct
  • Explicit consent for this data sharing
  • Privacy policy that mentions third-party data sharing

Partners are responsible for maintaining records of consent in accordance with applicable data protection regulations.

Support

For technical assistance with the Referrals API, please contact api-support@redpincompany.com.

For urgent referrals or high-value clients, we recommend following up with your account manager after submitting the referral through the API.