Referral Created Event | Redpin

{
  "partner_id": "0201110000749410",
  "referral_id": "2cd722f4-c42a-4238-86fb-541575371ef8",
  "status": "CREATED",
  "event_name": "REFERRAL_CREATED",
  "referral_date": "2025-05-20T19:14:05.878",
  "additional_details": {
    "client_reference_id": "REF120536",
    "service_required": "Other",
    "country_moving_to": "USA",
    "ccy_pair": "GBPUSD",
    "etv": "50,000 - 100,000"
  },
  "company": {
    "name": "Downweed Ltd.",
    "registration_number": "3283273"
  },
  "contact": {
    "last_name": "Daviess1",
    "email": "usertest126@example.com",
    "phone_number": "+614455666544",
    "first_name": "Joes2",
    "date_of_birth": "1995-06-01",
    "mobile_number": "+447128645157",
    "address": {
      "street": "123 High Street",
      "city": "London",
      "country": "UK",
      "state": "",
      "post_code": "SW1A 1AA"
    }
  }
}

Sent when a referral is created successfully or when referral creation fails. This webhook helps you track the status of your referrals in real-time.

Payload

The payload of this webhook request is an object.

partner_idstringRequired

Partner ID of the partner referring the customer (not required unless using multiple partner accounts)

referral_idstringRequired

Unique identifier for the referral

statusstringRequired

Status of the referral

event_namestringRequired

Event name

customer_idstringOptional

Unique Customer Id generated post registration

failure_messagestringOptional

Failure message to be returned in case status - FAILED

referral_datedatetimeOptional

registration_datedatetimeOptional

first_trade_datedatetimeOptional

additional_detailsobjectOptional

Additional details about the referral's requirements

companyobjectOptional

Company details (required if customer_type is Corporate)

contactobjectOptional

Contact details for the referral

Response

200

Webhook received successfully

400

Invalid payload