PayPal · Schema

Referral Data Response

The share referral data response.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
partner_referral_id	string	The ID to access the customer's data shared by the partner with PayPal.
submitter_payer_id	string	The payer ID of the partner who shared the referral data.
referral_data	object
links	array	An array of request-related [HATEOAS links](/docs/api/overview/#hateoas-links).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/referral_data_response",
  "title": "Referral Data Response",
  "type": "object",
  "description": "The share referral data response.",
  "properties": {
    "partner_referral_id": {
      "type": "string",
      "description": "The ID to access the customer's data shared by the partner with PayPal.",
      "readOnly": true,
      "pattern": "^[0-9A-Za-z_-.]+$",
      "minLength": 1,
      "maxLength": 255
    },
    "submitter_payer_id": {
      "type": "string",
      "description": "The payer ID of the partner who shared the referral data.",
      "readOnly": true,
      "minLength": 1,
      "maxLength": 20,
      "pattern": "^[0-9A-Z]+$"
    },
    "referral_data": {
      "$ref": "#/components/schemas/referral_data"
    },
    "links": {
      "title": "Links",
      "type": "array",
      "description": "An array of request-related [HATEOAS links](/docs/api/overview/#hateoas-links).",
      "readOnly": true,
      "additionalProperties": true,
      "items": {
        "$ref": "#/components/schemas/link_description"
      },
      "minItems": 0,
      "maxItems": 2
    }
  }
}