PayPal Partner-Referrals API

openapi: 3.2.0
info:
  title: Paypal Subscriptions Authorizations Partner Referrals API
  description: You can use billing plans and subscriptions to create subscriptions that process recurring PayPal payments for physical or digital goods, or services. A plan includes pricing and billing cycle information that defines the amount and frequency of charge for a subscription. You can also define a fixed plan, such as a $5 basic plan or a volume- or graduated-based plan with pricing tiers based on the quantity purchased. For more information, see <a href="/docs/subscriptions/">Subscriptions Overview</a>.
  version: '1.6'
  contact: {}
servers:
- url: https://api-m.sandbox.paypal.com
  description: PayPal Sandbox Environment
- url: https://api-m.paypal.com
  description: PayPal Live Environment
tags:
- name: Partner-Referrals
  description: Enables you to create and get information about shared customer data.
paths:
  /v2/customer/partner-referrals:
    post:
      summary: Paypal Create partner referral
      description: Creates a partner referral that is shared by the partner or API caller. The partner referral is used to onboard the seller, and contains the seller's personal, business, financial and operations.
      operationId: partner-referrals.create
      responses:
        '201':
          description: A successful request returns the HTTP `201 Created` status code and a JSON response body that contains a [HATEOAS link](/docs/api/overview/#hateoas-links) to show the referral data and an `action_url` to which you redirect the customer in a browser to complete the signup process. The `partner_referral_id` token is appended to the URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create_referral_data_response'
        '400':
          description: Request is not well-formed, syntactically incorrect, or violates schema.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error_400'
                - $ref: '#/components/schemas/400'
        '401':
          description: The API call is not authorized.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error_401'
                - $ref: '#/components/schemas/401'
        '403':
          description: Authorization failed due to insufficient permissions or missing scopes on the caller account.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error_403'
                - $ref: '#/components/schemas/403'
        '422':
          description: The caller is not a business account or the account is closed or locked.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error_422'
                - $ref: '#/components/schemas/422'
        '500':
          description: An internal server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_500'
        default:
          $ref: '#/components/responses/default'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/referral_data'
        required: true
      security:
      - Oauth2:
        - https://uri.paypal.com/services/customer/partner-referrals/readwrite
      tags:
      - Partner-Referrals
  /v2/customer/partner-referrals/{partner_referral_id}:
    get:
      summary: Paypal Show referral data
      description: Shows details by ID for referral data that was shared by the partner or API caller.
      operationId: partner-referrals.read
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that shows referral data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/referral_data_response'
              examples:
                referral_data:
                  value:
                    individual_owners:
                    - names:
                      - prefix: Mr.
                        given_name: John
                        surname: Doe
                        middle_name: Middle
                        suffix: Jr.
                        full_name: John Middle Doe Jr.
                        type: LEGAL
                      citizenship: US
                      addresses:
                      - address_line_1: One Washington Square
                        address_line_2: Apt 123
                        admin_area_2: San Jose
                        admin_area_1: CA
                        postal_code: '95112'
                        country_code: US
                        type: HOME
                      phones:
                      - country_code: '1'
                        national_number: '6692468839'
                        extension_number: '1234'
                        type: MOBILE
                      birth_details:
                        date_of_birth: '1955-12-29'
                      type: PRIMARY
                    business_entity:
                      business_type:
                        type: INDIVIDUAL
                        subtype: ASSO_TYPE_INCORPORATED
                      business_industry:
                        category: '1004'
                        mcc_code: '8931'
                        subcategory: '2025'
                      business_incorporation:
                        incorporation_country_code: US
                        incorporation_date: '1986-12-29'
                      names:
                      - business_name: Test Enterprise
                        type: LEGAL_NAME
                      emails:
                      - type: CUSTOMER_SERVICE
                        email: customerservice@example.com
                      website: https://mystore.testenterprises.com
                      addresses:
                      - address_line_1: One Washington Square
                        address_line_2: Apt 123
                        admin_area_2: San Jose
                        admin_area_1: CA
                        postal_code: '95112'
                        country_code: US
                        type: WORK
                      phones:
                      - country_code: '1'
                        national_number: '6692478833'
                        extension_number: '1234'
                        type: CUSTOMER_SERVICE
                      beneficial_owners:
                        individual_beneficial_owners:
                        - names:
                          - prefix: Mr.
                            given_name: John
                            surname: Doe
                            middle_name: Middle
                            suffix: Jr.
                            full_name: John Middle Doe Jr.
                            type: LEGAL
                          citizenship: US
                          addresses:
                          - address_line_1: One Washington Square
                            address_line_2: Apt 123
                            admin_area_2: San Jose
                            admin_area_1: CA
                            postal_code: '95112'
                            country_code: US
                            type: HOME
                          phones:
                          - country_code: '1'
                            national_number: '6692468839'
                            extension_number: '1234'
                            type: MOBILE
                          birth_details:
                            date_of_birth: '1955-12-29'
                          percentage_of_ownership: '50'
                        business_beneficial_owners:
                        - business_type:
                            type: INDIVIDUAL
                            subtype: ASSO_TYPE_INCORPORATED
                          business_industry:
                            category: '1004'
                            mcc_code: '8931'
                            subcategory: '2025'
                          business_incorporation:
                            incorporation_country_code: US
                            incorporation_date: '1986-12-29'
                          names:
                          - business_name: Test Enterprise
                            type: LEGAL_NAME
                          emails:
                          - type: CUSTOMER_SERVICE
                            email: customerservice@example.com
                          website: https://mystore.testenterprises.com
                          addresses:
                          - address_line_1: One Washington Square
                            address_line_2: Apt 123
                            admin_area_2: San Jose
                            admin_area_1: CA
                            postal_code: '95112'
                            country_code: US
                            type: WORK
                          phones:
                          - country_code: '1'
                            national_number: '6692478833'
                            extension_number: '1234'
                            type: CUSTOMER_SERVICE
                          percentage_of_ownership: '50'
                      office_bearers:
                      - names:
                        - prefix: Mr.
                          given_name: John
                          surname: Doe
                          middle_name: Middle
                          suffix: Jr.
                          full_name: John Middle Doe Jr.
                          type: LEGAL
                        citizenship: US
                        addresses:
                        - address_line_1: One Washington Square
                          address_line_2: Apt 123
                          admin_area_2: San Jose
                          admin_area_1: CA
                          postal_code: '95112'
                          country_code: US
                          type: HOME
                        phones:
                        - country_code: '1'
                          national_number: '6692468839'
                          extension_number: '1234'
                          type: MOBILE
                        birth_details:
                          date_of_birth: '1955-12-29'
                        role: DIRECTOR
                      annual_sales_volume_range:
                        minimum_amount:
                          currency_code: USD
                          value: '10000'
                        maximum_amount:
                          currency_code: USD
                          value: '50000'
                      average_monthly_volume_range:
                        minimum_amount:
                          currency_code: USD
                          value: '1000'
                        maximum_amount:
                          currency_code: USD
                          value: '50000'
                      purpose_code: P0104
                    email: accountemail@example.com
                    preferred_language_code: en-US
                    tracking_id: testenterprices123122
                    partner_config_override:
                      partner_logo_url: https://www.paypalobjects.com/webstatic/mktg/logo/pp_cc_mark_111x69.jpg
                      return_url: https://testenterprises.com/merchantonboarded
                      return_url_description: the url to return the merchant after the paypal onboarding process.
                      action_renewal_url: https://testenterprises.com/renew-exprired-url
                      show_add_credit_card: true
                    operations:
                    - operation: BANK_ADDITION
                    financial_instruments:
                      banks:
                      - nick_name: Bank of America
                        account_number: '123405668293'
                        account_type: CHECKING
                        currency_code: USD
                        identifiers:
                        - type: ROUTING_NUMBER_1
                          value: '123456789'
                    legal_consents:
                    - type: SHARE_DATA_CONSENT
                      granted: true
                    products:
                    - EXPRESS_CHECKOUT
        '401':
          description: The API call is not authorized.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error_401'
                - $ref: '#/components/schemas/401'
        '403':
          description: Authorization failed due to insufficient permissions or missing scopes on the caller Account.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error_403'
                - $ref: '#/components/schemas/403'
        '500':
          description: An internal server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_500'
        default:
          $ref: '#/components/responses/default'
      parameters:
      - $ref: '#/components/parameters/partner_referral_id'
      security:
      - Oauth2:
        - https://uri.paypal.com/services/customer/partner-referrals/readwrite
      - Oauth2:
        - https://uri.paypal.com/services/customer/partner-referrals
      tags:
      - Partner-Referrals
components:
  schemas:
    error_500:
      type: object
      title: Internal Server Error
      description: This is either a system or application error, and generally indicates that although the client appeared to provide a correct request, something unexpected has gone wrong on the server.
      properties:
        name:
          type: string
          enum:
          - INTERNAL_SERVER_ERROR
        message:
          type: string
          enum:
          - An internal server error occurred.
        debug_id:
          type: string
          description: The PayPal internal ID. Used for correlation purposes.
        links:
          description: An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).
          type: array
          minItems: 0
          maxItems: 10000
          items:
            $ref: '#/components/schemas/error_link_description'
      example:
        name: INTERNAL_SERVER_ERROR
        message: An internal server error occurred.
        debug_id: 90957fca61718
        links:
        - href: https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR
          rel: information_link
    link_description:
      type: object
      title: Link Description
      description: The request-related [HATEOAS link](/docs/api/reference/api-responses/#hateoas-links) information.
      required:
      - href
      - rel
      properties:
        href:
          type: string
          description: The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.
        rel:
          type: string
          description: The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).
        method:
          type: string
          description: The HTTP method required to make the related call.
          enum:
          - GET
          - POST
          - PUT
          - DELETE
          - HEAD
          - CONNECT
          - OPTIONS
          - PATCH
    currency_code:
      description: The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
      type: string
      format: ppaas_common_currency_code_v2
      minLength: 3
      maxLength: 3
    business_sub_type:
      description: Sub classification of the business type
      title: The business sub type.
      type: string
      pattern: ^[0-9A-Z_]+$
      minLength: 1
      maxLength: 255
      enum:
      - ASSO_TYPE_INCORPORATED
      - ASSO_TYPE_NON_INCORPORATED
      - GOVT_TYPE_ENTITY
      - GOVT_TYPE_EMANATION
      - GOVT_TYPE_ESTD_COMM
      - GOVT_TYPE_ESTD_FC
      - GOVT_TYPE_ESTD_ST_TR
    phone_type:
      type: string
      title: Phone Type
      description: The phone type.
      enum:
      - FAX
      - HOME
      - MOBILE
      - OTHER
      - PAGER
    error_400:
      type: object
      title: Bad Request Error
      description: Request is not well-formed, syntactically incorrect, or violates schema.
      properties:
        name:
          type: string
          enum:
          - INVALID_REQUEST
        message:
          type: string
          enum:
          - Request is not well-formed, syntactically incorrect, or violates schema.
        details:
          type: array
          items:
            $ref: '#/components/schemas/error_details'
        debug_id:
          type: string
          description: The PayPal internal ID. Used for correlation purposes.
        links:
          description: An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).
          type: array
          minItems: 0
          maxItems: 10000
          items:
            $ref: '#/components/schemas/error_link_description'
    business_name:
      type: object
      title: Business Name
      description: The business name of the party.
      properties:
        business_name:
          type: string
          description: Required. The business name of the party.
          maxLength: 300
    '401':
      properties:
        details:
          type: array
          items:
            anyOf:
            - title: AUTHORIZATION_ERROR
              properties:
                issue:
                  type: string
                  enum:
                  - AUTHORIZATION_ERROR
                description:
                  type: string
                  enum:
                  - This API call is not authorized
    error_401:
      type: object
      title: Unauthorized Error
      description: Authentication failed due to missing Authorization header, or invalid authentication credentials.
      properties:
        name:
          type: string
          enum:
          - AUTHENTICATION_FAILURE
        message:
          type: string
          enum:
          - Authentication failed due to missing authorization header, or invalid authentication credentials.
        details:
          type: array
          items:
            $ref: '#/components/schemas/error_details'
        debug_id:
          type: string
          description: The PayPal internal ID. Used for correlation purposes.
        links:
          description: An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).
          type: array
          minItems: 0
          maxItems: 10000
          items:
            $ref: '#/components/schemas/error_link_description'
    dependent_process: {}
    language:
      type: string
      description: The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/docs/integration/direct/rest/country-codes/).
      format: ppaas_common_language_v3
      maxLength: 10
      minLength: 2
      pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$
    business_entity:
      title: Business_entity
      description: The business entity of the account.
      allOf:
      - description: Common business information section.
        $ref: '#/components/schemas/business'
      - description: Additional business information section.
        properties:
          beneficial_owners:
            description: List of beneficial owners part of the entity. They can be either a Person or a business entity.
            $ref: '#/components/schemas/beneficial_owners'
          office_bearers:
            description: List of Directors present as part of the business entity.
            type: array
            items:
              $ref: '#/components/schemas/office_bearer'
            minItems: 0
            maxItems: 5
          annual_sales_volume_range:
            description: The range for the total annual sales volume of the business.
            $ref: '#/components/schemas/currency_range'
          average_monthly_volume_range:
            description: The range for the average monthly volume of the business.
            $ref: '#/components/schemas/currency_range'
          purpose_code:
            description: The account's purpose code.
            items:
              $ref: '#/components/schemas/purpose_code_enum'
          business_description:
            type: string
            description: The business goals description. For example, a mission statement.
            minLength: 1
            maxLength: 256
    business_address_detail:
      type: object
      title: Business_address_detail
      description: A simple postal address with coarse-grained fields.
      allOf:
      - $ref: '#/components/schemas/address_portable'
      - properties:
          type:
            description: The address type under which this is classified. For example, shipping or dropoff.
            $ref: '#/components/schemas/business_address_type'
          primary:
            type: boolean
            description: Whether this is the primary address of the user. This cannot be directly set to `false`, but rather it is toggled `false` in the datastore when another address is set to primary.
          inactive:
            type: boolean
            description: Whether this address has been inactivated.
            readOnly: true
      required:
      - type
    person:
      title: Person
      description: Details of the person or party.
      properties:
        id:
          description: The encrypted party ID.
          type: string
          readOnly: true
          minLength: 1
          maxLength: 20
          pattern: ^[0-9A-Z]+$
        names:
          description: The name of the person.
          type: array
          items:
            $ref: '#/components/schemas/person_name'
          minItems: 0
          maxItems: 5
        citizenship:
          description: The citizenship country code of the person.
          $ref: '#/components/schemas/country_code'
        addresses:
          description: The list of addresses associated with the person.
          type: array
          items:
            $ref: '#/components/schemas/person_address_detail'
          minItems: 0
          maxItems: 5
        phones:
          description: The list of phone numbers associated with the person.
          type: array
          items:
            $ref: '#/components/schemas/person_phone_detail'
          minItems: 0
          maxItems: 5
        birth_details:
          description: The person's birth details.
          $ref: '#/components/schemas/birth_details'
        documents:
          description: A person's or party's related document data collected from the customer. For example SSN, ITIN, or business registration number collected from the user. <blockquote><strong>Note:</strong> This field is not applicable for POST [/v2/customer/partner-referrals](/docs/api/partner-referrals/v2/#partner-referrals_create) API calls.</blockquote>
          type: array
          items:
            $ref: '#/components/schemas/person_document'
          minItems: 0
          maxItems: 20
    country_code-2:
      type: string
      description: The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote>
      format: ppaas_common_country_code_v2
      maxLength: 2
      minLength: 2
      pattern: ^([A-Z]{2}|C2)$
    business_type:
      description: The business types classified
      title: Business type
      type: string
      pattern: ^[0-9A-Z_]+$
      minLength: 1
      maxLength: 255
      enum:
      - ANY_OTHER_BUSINESS_ENTITY
      - ASSOCIATION
      - CORPORATION
      - GENERAL_PARTNERSHIP
      - GOVERNMENT
      - INDIVIDUAL
      - LIMITED_LIABILITY_PARTNERSHIP
      - LIMITED_LIABILITY_PROPRIETORS
      - LIMITED_LIABILITY_PRIVATE_CORPORATION
      - LIMITED_PARTNERSHIP
      - LIMITED_PARTNERSHIP_PRIVATE_CORPORATION
      - NONPROFIT
      - ONLY_BUY_OR_SEND_MONEY
      - OTHER_CORPORATE_BODY
      - PARTNERSHIP
      - PRIVATE_PARTNERSHIP
      - PROPRIETORSHIP
      - PROPRIETORSHIP_CRAFTSMAN
      - PROPRIETORY_COMPANY
      - PRIVATE_CORPORATION
      - PUBLIC_COMPANY
      - PUBLIC_CORPORATION
      - PUBLIC_PARTNERSHIP
      - REGISTERED_COOPERATIVE
    payout_attributes:
      type: object
      title: Payout Attributes
      additionalProperties: false
      description: Payout specific attributes.
      properties:
        marketplace:
          type: boolean
          description: If `true`, specifies that the merchant or platform is offering goods or services on behalf of 3rd party sellers.
        kyc_required:
          type: boolean
          description: If `true`, specifies that the Kyc is required for the merchant.
        country_transfer_method_currency_selection:
          type: array
          description: Requested country, transfer method and currency.
          minItems: 1
          maxItems: 50
          items:
            $ref: '#/components/schemas/country_transfer_method_currency_selection'
    '422':
      properties:
        details:
          type: array
          items:
            anyOf:
            - title: USER_NOT_FOUND
              properties:
                issue:
                  type: string
                  enum:
                  - USER_NOT_FOUND
                description:
                  type: string
                  enum:
                  - Account for this Partner ID does not exist.
            - title: ACCOUNT_STATUS_ERROR
              properties:
                issue:
                  type: string
                  enum:
                  - ACCOUNT_STATUS_ERROR
                description:
                  type: string
            - title: PRODUCT_PPCP_UNAUTHORIZED
              properties:
                issue:
                  type: string
                  enum:
                  - PRODUCT_PPCP_UNAUTHORIZED
                description:
                  type: string
                  enum:
                  - Account has not been configured to use PayPal Complete Payments
    person_name:
      type: object
      title: Person name
      description: The name of the person.
      allOf:
      - $ref: '#/components/schemas/name'
      - properties:
          type:
            description: 'The type of name. Currently supported values are: `LEGAL`.'
            $ref: '#/components/schemas/person_name_type'
      required:
      - type
    country_transfer_method_currency_selection:
      type: object
      title: Requested country, transfer method and currency
      additionalProperties: false
      description: Requested country, transfer method and currency.
      properties:
        country:
          description: Country.
          $ref: '#/components/schemas/country_code'
        transfer_methods:
          type: array
          description: Requested transfer method and currency for a country.
          minItems: 1
          maxItems: 50
          items:
            $ref: '#/components/schemas/transfer_method'
    error_409:
      type: object
      title: Resource Conflict Error
      description: The server has detected a conflict while processing this request.
      properties:
        name:
          type: string
          enum:
          - RESOURCE_CONFLICT
        message:
          type: string
          enum:
          - The server has detected a conflict while processing this request.
        details:
          type: array
          items:
            $ref: '#/components/schemas/error_details'
        debug_id:
          type: string
          description: The PayPal internal ID. Used for correlation purposes.
        links:
          description: An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).
          type: array
          minItems: 0
          maxItems: 10000
          items:
            $ref: '#/components/schemas/error_link_description'
    rest_endpoint_features_enum:
      type: string
      title: REST Endpoint Features
      description: The REST endpoint.
      minLength: 1
      maxLength: 100
      pattern: ^[0-9A-Z_-]+$
      enum:
      - PAYOUTS
      - PAYMENT
      - REFUND
      - FUTURE_PAYMENT
      - DIRECT_PAYMENT
      - PARTNER_FEE
      - DELAY_FUNDS_DISBURSEMENT
      - READ_SELLER_DISPUTE
      - UPDATE_SELLER_DISPUTE
      - ADVANCED_TRANSACTIONS_SEARCH
      - SWEEP_FUNDS_EXTERNAL_SINK
      - ACCESS_MERCHANT_INFORMATION
      - TRACKING_SHIPMENT_READWRITE
      - INVOICE_READ_WRITE
      - DISPUTE_READ_BUYER
      - UPDATE_CUSTOMER_DISPUTES
      - VAULT
      - BILLING_AGREEMENT
    business_phone_detail:
      type: object
      title: Phone details
      description: The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
      allOf:
      - $ref: '#/components/schemas/phone'
      - properties:
          contact_name:
            type: string
            description: The name that the phone number is connected to.
            minLength: 1
            maxLength: 900
          inactive:
            type: boolean
            description: Whether this phone number has been inactivated by the user.
            readOnly: true
          primary:
            type: boolean
            description: Whether this is the primary contact phone number of the user.
          type:
            $ref: '#/components/schemas/business_phone_type'
            description: The type of phone number provided. For example, home, work, or mobile.
          tags:
            type: array
            description: Array of tags for this phone number.
            items:
              $ref: '#/components/schemas/phone_number_tag'
            minItems: 0
            maxItems: 20
      required:
      - type
    operation:
      type: object
      title: Operation
      description: The required operation to share data.
      additionalProperties: false
      properties:
        operation:
          type: string
          minLength: 1
          maxLength: 255
          pattern: ^[0-9A-Z_-]+$
          description: The operation to enable for the customer. To enable the collection of the API permissions that you require to integrate with the customer, specify `API_INTEGRATION`. `BANK_ADDITION` is supported only for the US.
          enum:
          - API_INTEGRATION
          - BANK_ADDITION
          - BILLING_AGREEMENT
          - CONTEXTUAL_MARKETING_CONSENT
          - SALESFORCE_REFERRAL
        api_integration_preference:
          $ref: '#/components/schemas/integration_details'
        billing_agreement:
          $ref: '#/components/schemas/billing_agreement'
    create_referral_data_response:
      type: object
      title: Create Referral Data Response
      description: The shared referral data.
      properties:
        links:
          type: array
          title: Links
          description: An array of request-related [HATEOAS links](/docs/api/overview/#hateoas-links).
          readOnly: true
          additionalProperties: true
          minItems: 2
          maxItems: 10
          items:
            description: The reque

# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/paypal/refs/heads/main/openapi/paypal-partner-referrals-api-openapi.yml