Partner Referrals API

The Partner Referrals API enables a marketplace to add PayPal seller accounts. It supports the Connected Path marketplace models.
Important: PayPal for Marketplaces is a limited-release solution at this time. It is available to select partners for approved use cases. For more information, reach out to your PayPal account manager.
In the Connected Path, you host a button on your website that takes sellers to PayPal to create and configure a PayPal account. The Onboarding API enables you to collect seller data and pass it to the account creation and setup forms, reducing the burden on sellers during the signup and setup process. Call the create partner referral and show referral data methods for the Connected Path.

Partner referrals (resource group)

Enables you to create and get information about shared customer data.

Create partner referral

POST /v2/customer/partner-referrals
Creates a partner referral that is shared by the API caller. The referrals contains the client's personal, business, financial and operations that the partner wants to onbaord the client.

Request body

  • individual_owners

    array (contains the individual_owner object)

    List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.
  • business_entity

    Business entity of the account.
  • email

    string

    Email address of the customer used to create the account.

    Minimum length: 3.

    Maximum length: 254.

    Pattern: ^.+@[^"\-].+$.

  • preferred_language_code

    string

    The preferred locale code to use in the onboarding flow for the customer.

    Minimum length: 2.

    Maximum length: 10.

    Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$.

  • tracking_id

    string

    The partner's unique identifier for this customer in their system which can be used to track user in PayPal.

    Minimum length: 1.

    Maximum length: 127.

  • partner_config_override

    object

    The configuration property that the partner intends to override for this onboarding request.
  • financial_instruments

    object

    Array of financial instruments attached to the customer's account.
  • operations

    array (contains the operation object)

    An array of operations to perform for the customer while they share their data.
  • products

    array (contains the product_name object)

    An array of PayPal products to which the partner wants to onboard the customer.
  • legal_consents

    array (contains the legal_consent object)

    An array of all consents that the partner has received from this seller. If SHARE_DATA_CONSENT is not granted, PayPal does not store customer data.

Sample Request

curl -v -X POST https://api.sandbox.paypal.com/v2/customer/partner-referrals \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
  "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": "2025",
      "subcategory": "8931"
    },
    "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": "2025",
            "subcategory": "8931"
          },
          "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"
  ]
}'

Response

A successful request returns the HTTP 201 Created status code and a JSON response body that contains a HATEOAS link 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.

Sample Response

{
  "links": [
    {
      "href": "https://uri.paypal.com/v2/customer/partner-referrals/ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://www.paypal.com/merchantsignup/partner/onboardingentry?token=ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
      "rel": "action_url",
      "method": "GET"
    }
  ]
}

Show referral data

GET /v2/customer/partner-referrals/{partner_referral_id}
Shows details for referral data, by ID, that was shared by the API caller.

Path parameters

  • partner_referral_id

    string

    required

    The ID of the partner-referrals data for which to show details.

Sample Request

curl -v -X GET https://api.sandbox.paypal.com/v2/customer/partner-referrals/ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0= \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token"

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that shows referral data.
  • partner_referral_id

    string

    The ID to access the customer's data shared by the partner with PayPal.

    Read only.

  • submitter_payer_id

    string

    The payer ID of the partner who shared the referral data.

    Read only.

  • referral_data

    object

    The customer's referral data that partners share with PayPal.
  • links

    array (contains the link_description object)

    An array of request-related HATEOAS links.

    Read only.

Sample Response

{
  "partner_referral_id": "ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
  "submitter_payer_id": "RFYUH2QQDGUQU",
  "referral_data": {
    "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": "2025",
        "subcategory": "8931"
      },
      "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": "2025",
              "subcategory": "8931"
            },
            "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": "API_INTEGRATION",
        "api_integration_preference": {
          "classic_api_integration": {
            "integration_type": "THIRD_PARTY",
            "third_party_details": {
              "permissions": [
                "EXPRESS_CHECKOUT",
                "REFUND",
                "DIRECT_PAYMENT",
                "AUTH_CAPTURE",
                "BUTTON_MANAGER",
                "ACCOUNT_BALANCE",
                "TRANSACTION_DETAILS"
              ]
            },
            "first_party_details": "CERTIFICATE"
          },
          "rest_api_integration": {
            "integration_method": "PAYPAL",
            "integration_type": "THIRD_PARTY",
            "third_party_details": {
              "features": [
                "PAYMENT",
                "REFUND",
                "PARTNER_FEE"
              ]
            }
          }
        },
        "billing_agreement": {
          "description": "Billing Agreement Description Field",
          "billing_experience_preference": {
            "experience_id": "string",
            "billing_context_set": true
          },
          "merchant_custom_data": "PatnerMERCHANT23124",
          "approval_url": "wttps://www.paypal.com/agreements/approve?ba_token=BA-67944913LE886121E",
          "ec_token": "EC-1S970363DB536864M"
        }
      }
    ],
    "products": [
      "EXPRESS_CHECKOUT"
    ],
    "legal_consents": [
      {
        "type": "SHARE_DATA_CONSENT",
        "granted": true
      }
    ]
  },
  "links": [
    {
      "href": "https://uri.paypal.com/v2/customer/partner-referrals/ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://www.paypal.com/merchantsignup/partner/onboardingentry?token=ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
      "rel": "action_url",
      "method": "GET"
    }
  ]
}

Common object definitions

account

  • individual_owners

    array (contains the individual_owner object)

    List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.
  • business_entity

    object

    Business entity of the account.

address_details

  • street_number

    string

    The street number.

    Maximum length: 100.

  • street_name

    string

    The street name. Just Drury in Drury Lane.

    Maximum length: 100.

  • street_type

    string

    The street type. For example, avenue, boulevard, road, or expressway.

    Maximum length: 100.

  • delivery_service

    string

    The delivery service. Post office box, bag number, or post office name.

    Maximum length: 100.

  • building_name

    string

    A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.

    Maximum length: 100.

  • sub_building

    string

    The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.

    Maximum length: 100.

address_portable

  • address_line_1

    string

    The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

    Maximum length: 300.

  • address_line_2

    string

    The second line of the address. For example, suite or apartment number.

    Maximum length: 300.

  • address_line_3

    string

    The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.

    Maximum length: 100.

  • admin_area_4

    string

    The neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
    • The postal sorting code for Guernsey and many French territories, such as French Guiana.
    • The fine-grained administrative levels in China.

    Maximum length: 100.

  • admin_area_3

    string

    A sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
    • Brazil. Suburb, bairro, or neighborhood.
    • India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

    Maximum length: 100.

  • admin_area_2

    string

    A city, town, or village. Smaller than admin_area_level_1.

    Maximum length: 120.

  • admin_area_1

    string

    The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
    • UK. A county.
    • US. A state.
    • Canada. A province.
    • Japan. A prefecture.
    • Switzerland. A kanton.

    Maximum length: 300.

  • postal_code

    string

    The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

    Maximum length: 60.

  • country_code

    string

    required

    The two-character ISO 3166-1 code that identifies the country or region.
    Note: The country code for Great Britain is GB and not UK 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.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

  • address_details

    object

    The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
    For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.

address_portable

  • address_line_1

    string

    The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

    Maximum length: 300.

  • address_line_2

    string

    The second line of the address. For example, suite or apartment number.

    Maximum length: 300.

  • address_line_3

    string

    The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.

    Maximum length: 100.

  • admin_area_4

    string

    The neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
    • The postal sorting code for Guernsey and many French territories, such as French Guiana.
    • The fine-grained administrative levels in China.

    Maximum length: 100.

  • admin_area_3

    string

    A sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
    • Brazil. Suburb, bairro, or neighborhood.
    • India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

    Maximum length: 100.

  • admin_area_2

    string

    A city, town, or village. Smaller than admin_area_level_1.

    Maximum length: 120.

  • admin_area_1

    string

    The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
    • UK. A county.
    • US. A state.
    • Canada. A province.
    • Japan. A prefecture.
    • Switzerland. A kanton.

    Maximum length: 300.

  • postal_code

    string

    The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

    Maximum length: 60.

  • country_code

    string

    required

    The two-character ISO 3166-1 code that identifies the country or region.
    Note: The country code for Great Britain is GB and not UK 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.
  • address_details

    object

    The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
    For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.

address_portable_postal_code_validation

  • address_portable_postal_code_validation

address_portable_postal_code_validation

  • address_portable_postal_code_validation

beneficial_owners

billing_agreement

  • description

    string

    The billing agreement description.

    Minimum length: 1.

    Maximum length: 125.

  • billing_experience_preference

    object

    The preference that customizes the billing experience of the customer.
  • merchant_custom_data

    string

    The custom data for the billing agreement.

    Minimum length: 1.

    Maximum length: 125.

  • approval_url

    string

    The URL to which to redirect seller to accept the billing agreement.

    Minimum length: 1.

    Maximum length: 125.

  • ec_token

    string

    The billing agreement token for the agreement.

    Minimum length: 1.

    Maximum length: 50.

billing_experience_preference

  • experience_id

    string

    The ID of the payment web experience profile.

    Minimum length: 1.

    Maximum length: 20.

  • billing_context_set

    boolean

    Indicates whether the partner has already displayed the billing context to the seller.

birth_details

  • date_of_birth

    string

    required

    date of birth, fomrat Internet date and time format.

    Minimum length: 10.

    Maximum length: 10.

    Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$.

business

  • business_type

    object

    Information related to the business like the nature of business, started date etc.
  • business_industry

    object

    Information related to the business like the nature of business, started date etc.
  • business_incorporation

    object

    Information related to the business like the nature of business, started date etc.
  • names

    array (contains the business_name_detail object)

    Name of the business.
  • emails

    array (contains the email object)

    Email addresses of the business.
  • website

    string

    Website of the business.

    Minimum length: 1.

    Maximum length: 50.

  • addresses

    array (contains the business_address_detail object)

    List of addresses associated with the business entity.
  • phones

    array (contains the business_phone_detail object)

    List of phone number associated with the business.
  • documents

    array (contains the business_document object)

    Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.

business.business_incorporation

  • incorporation_country_code

    string

    The incorporation country code.
  • incorporation_date

    string

    date of incorporation

business_address_detail

  • address_line_1

    string

    The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

    Maximum length: 300.

  • address_line_2

    string

    The second line of the address. For example, suite or apartment number.

    Maximum length: 300.

  • address_line_3

    string

    The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.

    Maximum length: 100.

  • admin_area_4

    string

    The neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
    • The postal sorting code for Guernsey and many French territories, such as French Guiana.
    • The fine-grained administrative levels in China.

    Maximum length: 100.

  • admin_area_3

    string

    A sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
    • Brazil. Suburb, bairro, or neighborhood.
    • India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

    Maximum length: 100.

  • admin_area_2

    string

    A city, town, or village. Smaller than admin_area_level_1.

    Maximum length: 120.

  • admin_area_1

    string

    The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
    • UK. A county.
    • US. A state.
    • Canada. A province.
    • Japan. A prefecture.
    • Switzerland. A kanton.

    Maximum length: 300.

  • postal_code

    string

    The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

    Maximum length: 60.

  • country_code

    string

    required

    The two-character ISO 3166-1 code that identifies the country or region.
    Note: The country code for Great Britain is GB and not UK 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.
  • address_details

    object

    The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
    For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
  • type

    enum

    The address type under which this is classified. For example, shipping or dropoff. The possible values are:
    • WORK. The address of the business.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

  • primary

    boolean

    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

    boolean

    Whether this address has been inactivated.

    Read only.

business_address_detail

  • address_line_1

    string

    The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

    Maximum length: 300.

  • address_line_2

    string

    The second line of the address. For example, suite or apartment number.

    Maximum length: 300.

  • address_line_3

    string

    The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.

    Maximum length: 100.

  • admin_area_4

    string

    The neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
    • The postal sorting code for Guernsey and many French territories, such as French Guiana.
    • The fine-grained administrative levels in China.

    Maximum length: 100.

  • admin_area_3

    string

    A sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
    • Brazil. Suburb, bairro, or neighborhood.
    • India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

    Maximum length: 100.

  • admin_area_2

    string

    A city, town, or village. Smaller than admin_area_level_1.

    Maximum length: 120.

  • admin_area_1

    string

    The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
    • UK. A county.
    • US. A state.
    • Canada. A province.
    • Japan. A prefecture.
    • Switzerland. A kanton.

    Maximum length: 300.

  • postal_code

    string

    The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

    Maximum length: 60.

  • country_code

    string

    required

    The two-character ISO 3166-1 code that identifies the country or region.
    Note: The country code for Great Britain is GB and not UK 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.
  • address_details

    object

    The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
    For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
  • type

    enum

    The address type under which this is classified. For example, shipping or dropoff. The possible values are:
    • WORK. The address of the business.

business_address_type

  • business_address_type

    enum

    Address type under which the provided address is tagged The possible values are:
    • WORK. The address of the business.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

business_beneficial_owner

  • business_type

    object

    Information related to the business like the nature of business, started date etc.
  • business_industry

    object

    Information related to the business like the nature of business, started date etc.
  • business_incorporation

    object

    Information related to the business like the nature of business, started date etc.
  • names

    array (contains the business_name_detail object)

    Name of the business.
  • emails

    array (contains the email object)

    Email addresses of the business.
  • website

    string

    Website of the business.

    Minimum length: 1.

    Maximum length: 50.

  • addresses

    array (contains the business_address_detail object)

    List of addresses associated with the business entity.
  • phones

    array (contains the business_phone_detail object)

    List of phone number associated with the business.
  • documents

    array (contains the business_document object)

    Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.
  • percentage_of_ownership

    string

    The percentage of shares this person owns in the company.

business_beneficial_owner

  • business_type

    object

    Information related to the business like the nature of business, started date etc.
  • business_industry

    object

    Information related to the business like the nature of business, started date etc.
  • business_incorporation

    object

    Information related to the business like the nature of business, started date etc.
  • names

    array (contains the business_name_detail object)

    Name of the business.
  • emails

    array (contains the email object)

    Email addresses of the business.
  • website

    string

    Website of the business.

    Minimum length: 1.

    Maximum length: 50.

  • addresses

    array (contains the business_address_detail object)

    List of addresses associated with the business entity.
  • phones

    array (contains the business_phone_detail object)

    List of phone number associated with the business.
  • documents

    array (contains the business_document object)

    Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.
  • percentage_of_ownership

    string

    The percentage of shares this person owns in the company.

business_document

  • id

    string

    The encrypted identifier for the document.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • labels

    array (contains the labels object)

    The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.
  • name

    string

    The file name.

    Minimum length: 1.

    Maximum length: 100.

  • identification_number

    string

    The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

    Minimum length: 1.

    Maximum length: 100.

  • issue_date

    string

    The issue date of the document.
  • expiry_date

    string

    The expire data of the document.
  • issuing_country_code

    string

    The country code of the document.
  • files

    array (contains the file_reference object)

    The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
  • links

    array (contains the link_description object)

    The HATEOAS links.

    Read only.

  • type

    enum

    The actual type of the document. The possible values are:
    • SOCIAL_SECURITY_NUMBER. A social security number.
    • EMPLOYMENT_IDENTIFICATION_NUMBER. The employee identification number.
    • TAX_IDENTIFICATION_NUMBER. The tax identification number.
    • PASSPORT_NUMBER. A passport number.
    • PENSION_FUND_ID. A pension fund ID.
    • MEDICAL_INSURANCE_ID. A medical insurance ID.
    • CNPJ. The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil.
    • CPF. A Brazilian individual's taxpayer registry identification number.
    • PAN. The Permanent account number issued by the Indian Income Tax Department.

business_document

  • id

    string

    The encrypted identifier for the document.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • labels

    array (contains the labels object)

    The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.
  • name

    string

    The file name.

    Minimum length: 1.

    Maximum length: 100.

  • identification_number

    string

    The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

    Minimum length: 1.

    Maximum length: 100.

  • issue_date

    string

    The issue date of the document.
  • expiry_date

    string

    The expire data of the document.
  • issuing_country_code

    string

    The country code of the document.
  • files

    array (contains the file_reference object)

    The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
  • links

    array (contains the link_description object)

    The HATEOAS links.

    Read only.

  • type

    enum

    The actual type of the document. The possible values are:
    • SOCIAL_SECURITY_NUMBER. A social security number.
    • EMPLOYMENT_IDENTIFICATION_NUMBER. The employee identification number.
    • TAX_IDENTIFICATION_NUMBER. The tax identification number.
    • PASSPORT_NUMBER. A passport number.
    • PENSION_FUND_ID. A pension fund ID.
    • MEDICAL_INSURANCE_ID. A medical insurance ID.
    • CNPJ. The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil.
    • CPF. A Brazilian individual's taxpayer registry identification number.
    • PAN. The Permanent account number issued by the Indian Income Tax Department.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

business_document_type

  • business_document_type

    enum

    The type of documents. The possible values are:
    • SOCIAL_SECURITY_NUMBER. A social security number.
    • EMPLOYMENT_IDENTIFICATION_NUMBER. The employee identification number.
    • TAX_IDENTIFICATION_NUMBER. The tax identification number.
    • PASSPORT_NUMBER. A passport number.
    • PENSION_FUND_ID. A pension fund ID.
    • MEDICAL_INSURANCE_ID. A medical insurance ID.
    • CNPJ. The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil.
    • CPF. A Brazilian individual's taxpayer registry identification number.
    • PAN. The Permanent account number issued by the Indian Income Tax Department.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

business_entity

  • business_type

    object

    Information related to the business like the nature of business, started date etc.
  • business_industry

    object

    Information related to the business like the nature of business, started date etc.
  • business_incorporation

    object

    Information related to the business like the nature of business, started date etc.
  • names

    array (contains the business_name_detail object)

    Name of the business.
  • emails

    array (contains the email object)

    Email addresses of the business.
  • website

    string

    Website of the business.

    Minimum length: 1.

    Maximum length: 50.

  • addresses

    array (contains the business_address_detail object)

    List of addresses associated with the business entity.
  • phones

    array (contains the business_phone_detail object)

    List of phone number associated with the business.
  • documents

    array (contains the business_document object)

    Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.
  • beneficial_owners

    object

    List of beneficial owners part of the entity. They can be either a Person or a business entity.
  • office_bearers

    array (contains the office_bearer object)

    List of Directors present as part of the business entity.
  • annual_sales_volume_range

    object

    The range for the total annual sales volume of the business.
  • average_monthly_volume_range

    object

    The range for the average monthly volume of the business.
  • purpose_code

    (contains the purpose_code object)

    The account's purpose code.
  • business_description

    string

    The business goals description. For example, a mission statement.

    Minimum length: 1.

    Maximum length: 256.

business_incorporation

  • incorporation_country_code

    string

    The incorporation country code.
  • incorporation_date

    string

    date of incorporation
  • incorporation_province_code

    string

    The province of incorporation.

    Minimum length: 1.

    Maximum length: 50.

business_industry

  • category

    string

    required

    The customer's business category code. PayPal uses industry standard seller category codes.

    Minimum length: 1.

    Maximum length: 20.

    Pattern: ^\d+$.

  • mcc_code

    string

    required

    The customer's business seller category code. PayPal uses industry standard seller category codes.

    Minimum length: 1.

    Maximum length: 20.

    Pattern: ^\d+$.

  • subcategory

    string

    required

    The customer's business subcategory code. PayPal uses industry standard seller subcategory codes.

    Minimum length: 1.

    Maximum length: 20.

    Pattern: ^\d+$.

business_name

  • business_name

    string

    Required. The business name of the party.

    Maximum length: 300.

business_name_detail

  • business_name

    string

    Required. The business name of the party.

    Maximum length: 300.

  • type

    enum

    The type of business name. For example, trading name. The possible values are:
    • DOING_BUSINESS_AS. The trading name of the business.
    • LEGAL_NAME. The legal name of the business.

business_name_detail

  • business_name

    string

    Required. The business name of the party.

    Maximum length: 300.

  • id

    string

    The encrypted ID for the business name.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • type

    enum

    The type of business name. For example, trading name. The possible values are:
    • DOING_BUSINESS_AS. The trading name of the business.
    • LEGAL_NAME. The legal name of the business.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

business_name_type

  • business_name_type

    enum

    Business name type The possible values are:
    • DOING_BUSINESS_AS. The trading name of the business.
    • LEGAL_NAME. The legal name of the business.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

business_name_validation

  • business_name_validation

business_phone_detail

  • country_code

    string

    required

    The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 3.

    Pattern: ^[0-9]{1,3}?$.

  • national_number

    string

    required

    The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 14.

    Pattern: ^[0-9]{1,14}?$.

  • extension_number

    string

    The extension number.

    Minimum length: 1.

    Maximum length: 15.

    Pattern: ^[0-9]{1,15}?$.

  • contact_name

    string

    The name that the phone number is connected to.

    Minimum length: 1.

    Maximum length: 900.

  • inactive

    boolean

    Whether this phone number has been inactivated by the user.

    Read only.

  • primary

    boolean

    Whether this is the primary contact phone number of the user.
  • type

    enum

    The type of phone number provided. For example, home, work, or mobile. The possible values are:
    • CUSTOMER_SERVICE. The customer service phone number.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

  • tags

    array (contains the phone_number_tag object)

    Array of tags for this phone number.

business_phone_detail

  • country_code

    string

    required

    The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 3.

    Pattern: ^[0-9]{1,3}?$.

  • national_number

    string

    required

    The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 14.

    Pattern: ^[0-9]{1,14}?$.

  • extension_number

    string

    The extension number.

    Minimum length: 1.

    Maximum length: 15.

    Pattern: ^[0-9]{1,15}?$.

  • type

    enum

    The type of phone number provided. For example, home, work, or mobile. The possible values are:
    • CUSTOMER_SERVICE. The customer service phone number.

business_phone_type

  • business_phone_type

    enum

    The type of phone number provided. For example, home, work, or mobile. The possible values are:
    • CUSTOMER_SERVICE. The customer service phone number.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

business_sub_type

  • business_sub_type

    enum

    Sub classification of the business type The possible values are:
    • ASSO_TYPE_INCORPORATED. The asso type incorporated.
    • ASSO_TYPE_NON_INCORPORATED. The asso type non incorporated.
    • GOVT_TYPE_ENTITY. The govt type entity.
    • GOVT_TYPE_EMANATION. The govt type emanation.
    • GOVT_TYPE_ESTD_COMM. The govt type estd comm.
    • GOVT_TYPE_ESTD_FC. The govt type estd fc.
    • GOVT_TYPE_ESTD_ST_TR. The govt type estd st tr.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

business_type

  • business_type

    enum

    The business types classified The possible values are:
    • ANY_OTHER_BUSINESS_ENTITY. The any other business entity.
    • ASSOCIATION. The association.
    • CORPORATION. The corporation.
    • GENERAL_PARTNERSHIP. The general partnership.
    • GOVERNMENT. The government.
    • INDIVIDUAL. The individual.
    • LIMITED_LIABILITY_PARTNERSHIP. The limited liability partnership.
    • LIMITED_LIABILITY_PROPRIETORS. The limited liability proprietors.
    • LIMITED_LIABILITY_PRIVATE_CORPORATION. The limited liability private corporation.
    • LIMITED_PARTNERSHIP. The limited partnership.
    • LIMITED_PARTNERSHIP_PRIVATE_CORPORATION. The limited partnership private corporation.
    • NONPROFIT. The nonprofit.
    • ONLY_BUY_OR_SEND_MONEY. The only buy and send money.
    • OTHER_CORPORATE_BODY. The other corporate body.
    • PARTNERSHIP. The partnership.
    • PRIVATE_PARTNERSHIP. The private partnership.
    • PROPRIETORSHIP. The proprietorship.
    • PROPRIETORSHIP_CRAFTSMAN. The proprietorship craftsman.
    • PROPRIETORY_COMPANY. The proprietory company.
    • PRIVATE_CORPORATION. The private corporation.
    • PUBLIC_COMPANY. The public company.
    • PUBLIC_CORPORATION. The public corporation.
    • PUBLIC_PARTNERSHIP. The public partnership.
    • REGISTERED_COOPERATIVE. Registered Co-operative.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

business_type_info

  • type

    enum

    Type of business entity like corporation, sole prop, governmental. The possible values are:
    • ANY_OTHER_BUSINESS_ENTITY. The any other business entity.
    • ASSOCIATION. The association.
    • CORPORATION. The corporation.
    • GENERAL_PARTNERSHIP. The general partnership.
    • GOVERNMENT. The government.
    • INDIVIDUAL. The individual.
    • LIMITED_LIABILITY_PARTNERSHIP. The limited liability partnership.
    • LIMITED_LIABILITY_PROPRIETORS. The limited liability proprietors.
    • LIMITED_LIABILITY_PRIVATE_CORPORATION. The limited liability private corporation.
    • LIMITED_PARTNERSHIP. The limited partnership.
    • LIMITED_PARTNERSHIP_PRIVATE_CORPORATION. The limited partnership private corporation.
    • NONPROFIT. The nonprofit.
    • ONLY_BUY_OR_SEND_MONEY. The only buy and send money.
    • OTHER_CORPORATE_BODY. The other corporate body.
    • PARTNERSHIP. The partnership.
    • PRIVATE_PARTNERSHIP. The private partnership.
    • PROPRIETORSHIP. The proprietorship.
    • PROPRIETORSHIP_CRAFTSMAN. The proprietorship craftsman.
    • PROPRIETORY_COMPANY. The proprietory company.
    • PRIVATE_CORPORATION. The private corporation.
    • PUBLIC_COMPANY. The public company.
    • PUBLIC_CORPORATION. The public corporation.
    • PUBLIC_PARTNERSHIP. The public partnership.
    • REGISTERED_COOPERATIVE. Registered Co-operative.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

  • subtype

    enum

    The sub classification of the business type. The possible values are:
    • ASSO_TYPE_INCORPORATED. The asso type incorporated.
    • ASSO_TYPE_NON_INCORPORATED. The asso type non incorporated.
    • GOVT_TYPE_ENTITY. The govt type entity.
    • GOVT_TYPE_EMANATION. The govt type emanation.
    • GOVT_TYPE_ESTD_COMM. The govt type estd comm.
    • GOVT_TYPE_ESTD_FC. The govt type estd fc.
    • GOVT_TYPE_ESTD_ST_TR. The govt type estd st tr.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

country_code

  • country_code

    string

    The two-character ISO 3166-1 code that identifies the country or region.
    Note: The country code for Great Britain is GB and not UK 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.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

country_code

  • country_code

    string

    The two-character ISO 3166-1 code that identifies the country or region.
    Note: The country code for Great Britain is GB and not UK 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.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

create_referral_data_response

currency_code

currency_range

  • minimum_amount

    object

    The minimum inclusive amount for the range.
  • maximum_amount

    object

    The maximum inclusive amount for the range.

date_no_time

  • date_no_time

    string

    The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

    Minimum length: 10.

    Maximum length: 10.

    Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$.

date_time

  • date_time

    string

    The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
    Note: The regular expression provides guidance but does not reject all invalid dates.

    Minimum length: 20.

    Maximum length: 64.

    Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

document

  • id

    string

    The encrypted identifier for the document.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • labels

    array (contains the labels object)

    The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.
  • name

    string

    The file name.

    Minimum length: 1.

    Maximum length: 100.

  • identification_number

    string

    The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

    Minimum length: 1.

    Maximum length: 100.

  • issue_date

    string

    The issue date of the document.
  • expiry_date

    string

    The expire data of the document.
  • issuing_country_code

    string

    The country code of the document.
  • files

    array (contains the file_reference object)

    The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
  • links

    array (contains the link_description object)

    The HATEOAS links.

    Read only.

email

  • type

    enum

    required

    The role of the email address. The possible values are:
    • CUSTOMER_SERVICE. The email ID to be used to contact the customer service of the business.

    Minimum length: 1.

    Maximum length: 50.

  • email

    string

    required

    The internationalized email address.
    Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

email

  • type

    enum

    required

    The role of the email address. The possible values are:
    • CUSTOMER_SERVICE. The email ID to be used to contact the customer service of the business.

    Minimum length: 1.

    Maximum length: 50.

  • email

    string

    required

    The internationalized email address.
    Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

    Minimum length: 3.

    Maximum length: 254.

    Pattern: ^.+@[^"\-].+$.

email_address

  • email_address

    string

    The internationalized email address.
    Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

    Minimum length: 3.

    Maximum length: 254.

    Pattern: ^.+@[^"\-].+$.

email_address

  • email_address

    string

    The internationalized email address.
    Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

    Minimum length: 3.

    Maximum length: 254.

    Pattern: ^.+@[^"\-].+$.

error

  • name

    string

    required

    The human-readable, unique name of the error.
  • message

    string

    required

    The message that describes the error.
  • debug_id

    string

    required

    The PayPal internal ID. Used for correlation purposes.
  • information_link

    string

    The information link, or URI, that shows detailed information about this error for the developer.

    Read only.

  • details

    array (contains the error_details object)

    An array of additional details about the error.
  • links

    array (contains the link_description object)

    An array of request-related HATEOAS links.

    Read only.

error_details

  • field

    string

    The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.
  • value

    string

    The value of the field that caused the error.
  • location

    string

    The location of the field that caused the error. Value is body, path, or query.

    Default: body.

  • issue

    string

    required

    The unique, fine-grained application-level error code.
  • description

    string

    The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.

file_reference

  • id

    string

    The ID of the referenced file.

    Minimum length: 1.

    Maximum length: 255.

  • reference_url

    string

    The reference URL for the file.

    Minimum length: 1.

    Maximum length: 2000.

  • content_type

    string

    The Internet Assigned Numbers Authority (IANA) media type of the file.
  • create_time

    string

    The date and time when the file was created, in Internet date and time format.

    Minimum length: 20.

    Maximum length: 64.

    Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

  • size

    string

    The size of the file, in bytes.

    Pattern: ^[0-9]+$.

first_party_details

  • features

    array (contains the rest_endpoint_feature object)

    required

    An array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.
  • seller_nonce

    string

    required

    S256 - The code verifier must be high-entropy cryptographic random string with a byte length of 43-128 range.

    Minimum length: 44.

    Maximum length: 128.

individual_beneficial_owner

  • id

    string

    The encrypted party ID.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • names

    array (contains the person_name object)

    The name of the person.
  • citizenship

    string

    The citizenship country code of the person.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

  • addresses

    array (contains the person_address_detail object)

    The list of addresses associated with the person.
  • phones

    array (contains the person_phone_detail object)

    The list of phone numbers associated with the person.
  • birth_details

    object

    The person's birth details.
  • documents

    array (contains the person_document object)

    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.
  • percentage_of_ownership

    string

    The percentage of shares this person owns in the company.

    Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$.

individual_beneficial_owner

  • id

    string

    The encrypted party ID.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • names

    array (contains the person_name object)

    The name of the person.
  • citizenship

    string

    The citizenship country code of the person.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

  • addresses

    array (contains the person_address_detail object)

    The list of addresses associated with the person.
  • phones

    array (contains the person_phone_detail object)

    The list of phone numbers associated with the person.
  • birth_details

    object

    The person's birth details.
  • documents

    array (contains the person_document object)

    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.
  • percentage_of_ownership

    string

    The percentage of shares this person owns in the company.

individual_owner

  • id

    string

    The encrypted party ID.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • names

    array (contains the person_name object)

    The name of the person.
  • citizenship

    string

    The citizenship country code of the person.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

  • addresses

    array (contains the person_address_detail object)

    The list of addresses associated with the person.
  • phones

    array (contains the person_phone_detail object)

    The list of phone numbers associated with the person.
  • birth_details

    object

    The person's birth details.
  • documents

    array (contains the person_document object)

    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.
  • type

    enum

    The actual role of this user on the account, PRIMARY/SECONDARY. The possible values are:
    • PRIMARY. Primary account holder.

individual_owner

  • id

    string

    The encrypted party ID.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • names

    array (contains the person_name object)

    The name of the person.
  • citizenship

    string

    The citizenship country code of the person.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

  • addresses

    array (contains the person_address_detail object)

    The list of addresses associated with the person.
  • phones

    array (contains the person_phone_detail object)

    The list of phone numbers associated with the person.
  • birth_details

    object

    The person's birth details.
  • documents

    array (contains the person_document object)

    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.
  • type

    enum

    The actual role of this user on the account, PRIMARY/SECONDARY. The possible values are:
    • PRIMARY. Primary account holder.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

individual_owner_type

  • individual_owner_type

    enum

    Role of the person party played in the account. The possible values are:
    • PRIMARY. Primary account holder.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

integration_details

  • classic_api_integration

    object

    The integration details for PayPal CLASSIC endpoints.
  • rest_api_integration

    object

    The integration details for PayPal REST endpoints.

labels

  • labels

    string

    A document label.

language

money

  • currency_code

    string

    required

    The three-character ISO-4217 currency code that identifies the currency.

    Minimum length: 3.

    Maximum length: 3.

  • value

    string

    required

    The value, which might be:
    • An integer for currencies like JPY that are not typically fractional.
    • A decimal fraction for currencies like TND that are subdivided into thousandths.
    For the required number of decimal places for a currency code, see Currency Codes.

    Maximum length: 32.

    Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$.

name

  • prefix

    string

    The prefix, or title, to the party's name.

    Maximum length: 140.

  • given_name

    string

    When the party is a person, the party's given, or first, name.

    Maximum length: 140.

  • surname

    string

    When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

    Maximum length: 140.

  • middle_name

    string

    When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

    Maximum length: 140.

  • suffix

    string

    The suffix for the party's name.

    Maximum length: 140.

  • full_name

    string

    When the party is a person, the party's full name.

    Maximum length: 300.

name_validation

  • name_validation

office_bearer

  • id

    string

    The encrypted party ID.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • names

    array (contains the person_name object)

    The name of the person.
  • citizenship

    string

    The citizenship country code of the person.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

  • addresses

    array (contains the person_address_detail object)

    The list of addresses associated with the person.
  • phones

    array (contains the person_phone_detail object)

    The list of phone numbers associated with the person.
  • birth_details

    object

    The person's birth details.
  • documents

    array (contains the person_document object)

    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.
  • role

    enum

    The role of the office bearer in the company. The possible values are:
    • CEO. The ceo.
    • CHAIRMAN. The chairman.
    • DIRECTOR. Director of the business
    • SECRETARY. The secretary.
    • TREASURER. The treasurer.
    • TRUSTEE. The trustee.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

office_bearer

  • id

    string

    The encrypted party ID.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • names

    array (contains the person_name object)

    The name of the person.
  • citizenship

    string

    The citizenship country code of the person.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

  • addresses

    array (contains the person_address_detail object)

    The list of addresses associated with the person.
  • phones

    array (contains the person_phone_detail object)

    The list of phone numbers associated with the person.
  • birth_details

    object

    The person's birth details.
  • documents

    array (contains the person_document object)

    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.
  • role

    enum

    The role of the office bearer in the company. The possible values are:
    • CEO. The ceo.
    • CHAIRMAN. The chairman.
    • DIRECTOR. Director of the business
    • SECRETARY. The secretary.
    • TREASURER. The treasurer.
    • TRUSTEE. The trustee.

office_bearer_role

  • office_bearer_role

    enum

    Role of the person party played in the business. The possible values are:
    • CEO. The ceo.
    • CHAIRMAN. The chairman.
    • DIRECTOR. Director of the business
    • SECRETARY. The secretary.
    • TREASURER. The treasurer.
    • TRUSTEE. The trustee.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

operation

  • operation

    enum

    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. The possible values are:
    • API_INTEGRATION. The operation used by partner request permission for customers api access.
    • BANK_ADDITION. Captured state of an order.
    • BILLING_AGREEMENT. The operation to create a billing agreement.
    • CONTEXTUAL_MARKETING_CONSENT. The operation to create a contextual marketing consent.

    Minimum length: 1.

    Maximum length: 255.

  • api_integration_preference

    object

    The integration details for the partner and customer relationship. Required if operation is API_INTEGRATION.
  • billing_agreement

    object

    The details of the billing agreement between the partner and a seller.

partner_configuration_override

  • partner_logo_url

    string

    The partner logo URL to display in the customer's onboarding flow.

    Minimum length: 1.

    Maximum length: 127.

  • return_url

    string

    The URL to which to redirect the customer upon completion of the onboarding process.

    Minimum length: 1.

    Maximum length: 127.

  • return_url_description

    string

    The description of the return URL.

    Minimum length: 1.

    Maximum length: 127.

  • action_renewal_url

    string

    If renew_action_url expires, redirect the customer to this URL.

    Minimum length: 1.

    Maximum length: 127.

  • show_add_credit_card

    boolean

    Indicates whether to show an add credit card page.

percentage

  • percentage

    string

    The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.

    Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$.

person

  • id

    string

    The encrypted party ID.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • names

    array (contains the person_name object)

    The name of the person.
  • citizenship

    string

    The citizenship country code of the person.

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

  • addresses

    array (contains the person_address_detail object)

    The list of addresses associated with the person.
  • phones

    array (contains the person_phone_detail object)

    The list of phone numbers associated with the person.
  • birth_details

    object

    The person's birth details.
  • documents

    array (contains the person_document object)

    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.

person_address_detail

  • address_line_1

    string

    The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

    Maximum length: 300.

  • address_line_2

    string

    The second line of the address. For example, suite or apartment number.

    Maximum length: 300.

  • address_line_3

    string

    The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.

    Maximum length: 100.

  • admin_area_4

    string

    The neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
    • The postal sorting code for Guernsey and many French territories, such as French Guiana.
    • The fine-grained administrative levels in China.

    Maximum length: 100.

  • admin_area_3

    string

    A sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
    • Brazil. Suburb, bairro, or neighborhood.
    • India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

    Maximum length: 100.

  • admin_area_2

    string

    A city, town, or village. Smaller than admin_area_level_1.

    Maximum length: 120.

  • admin_area_1

    string

    The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
    • UK. A county.
    • US. A state.
    • Canada. A province.
    • Japan. A prefecture.
    • Switzerland. A kanton.

    Maximum length: 300.

  • postal_code

    string

    The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

    Maximum length: 60.

  • country_code

    string

    required

    The two-character ISO 3166-1 code that identifies the country or region.
    Note: The country code for Great Britain is GB and not UK 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.
  • address_details

    object

    The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
    For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
  • type

    enum

    The address type under which this is classified. The possible values are:
    • HOME. The home address of the customer.

person_address_detail

  • address_line_1

    string

    The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

    Maximum length: 300.

  • address_line_2

    string

    The second line of the address. For example, suite or apartment number.

    Maximum length: 300.

  • address_line_3

    string

    The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.

    Maximum length: 100.

  • admin_area_4

    string

    The neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
    • The postal sorting code for Guernsey and many French territories, such as French Guiana.
    • The fine-grained administrative levels in China.

    Maximum length: 100.

  • admin_area_3

    string

    A sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
    • Brazil. Suburb, bairro, or neighborhood.
    • India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

    Maximum length: 100.

  • admin_area_2

    string

    A city, town, or village. Smaller than admin_area_level_1.

    Maximum length: 120.

  • admin_area_1

    string

    The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
    • UK. A county.
    • US. A state.
    • Canada. A province.
    • Japan. A prefecture.
    • Switzerland. A kanton.

    Maximum length: 300.

  • postal_code

    string

    The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

    Maximum length: 60.

  • country_code

    string

    required

    The two-character ISO 3166-1 code that identifies the country or region.
    Note: The country code for Great Britain is GB and not UK 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.
  • address_details

    object

    The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
    For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
  • type

    enum

    The address type under which this is classified. The possible values are:
    • HOME. The home address of the customer.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

  • primary

    boolean

    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

    boolean

    Whether this address has been inactivated.

    Read only.

person_address_type

  • person_address_type

    enum

    The address type under which the provided address is tagged. The possible values are:
    • HOME. The home address of the customer.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

person_document

  • id

    string

    The encrypted identifier for the document.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • labels

    array (contains the labels object)

    The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.
  • name

    string

    The file name.

    Minimum length: 1.

    Maximum length: 100.

  • identification_number

    string

    The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

    Minimum length: 1.

    Maximum length: 100.

  • issue_date

    string

    The issue date of the document.
  • expiry_date

    string

    The expire data of the document.
  • issuing_country_code

    string

    The country code of the document.
  • files

    array (contains the file_reference object)

    The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
  • links

    array (contains the link_description object)

    The HATEOAS links.

    Read only.

  • type

    enum

    The actual type of the document. It could be ID_CARD, PASSPORT, etc. The possible values are:
    • SOCIAL_SECURITY_NUMBER. A social security number.
    • EMPLOYMENT_IDENTIFICATION_NUMBER. The employee identification number.
    • TAX_IDENTIFICATION_NUMBER. A tax identification number.
    • PASSPORT_NUMBER. The passport number.
    • PENSION_FUND_ID. A pension fund ID.
    • MEDICAL_INSURANCE_ID. The medical insurance ID.
    • CNPJ. The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil.
    • CPF. A Brazilian individual's taxpayer registry identification number.
    • PAN. The permanent account number issued by the Indian Income Tax Department.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

person_document

  • id

    string

    The encrypted identifier for the document.

    Read only.

    Minimum length: 1.

    Maximum length: 20.

  • labels

    array (contains the labels object)

    The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.
  • name

    string

    The file name.

    Minimum length: 1.

    Maximum length: 100.

  • identification_number

    string

    The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

    Minimum length: 1.

    Maximum length: 100.

  • issue_date

    string

    The issue date of the document.
  • expiry_date

    string

    The expire data of the document.
  • issuing_country_code

    string

    The country code of the document.
  • files

    array (contains the file_reference object)

    The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
  • links

    array (contains the link_description object)

    The HATEOAS links.

    Read only.

  • type

    enum

    The actual type of the document. It could be ID_CARD, PASSPORT, etc. The possible values are:
    • SOCIAL_SECURITY_NUMBER. A social security number.
    • EMPLOYMENT_IDENTIFICATION_NUMBER. The employee identification number.
    • TAX_IDENTIFICATION_NUMBER. A tax identification number.
    • PASSPORT_NUMBER. The passport number.
    • PENSION_FUND_ID. A pension fund ID.
    • MEDICAL_INSURANCE_ID. The medical insurance ID.
    • CNPJ. The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil.
    • CPF. A Brazilian individual's taxpayer registry identification number.
    • PAN. The permanent account number issued by the Indian Income Tax Department.

person_document_type

  • person_document_type

    enum

    The type of documents. The possible values are:
    • SOCIAL_SECURITY_NUMBER. A social security number.
    • EMPLOYMENT_IDENTIFICATION_NUMBER. The employee identification number.
    • TAX_IDENTIFICATION_NUMBER. A tax identification number.
    • PASSPORT_NUMBER. The passport number.
    • PENSION_FUND_ID. A pension fund ID.
    • MEDICAL_INSURANCE_ID. The medical insurance ID.
    • CNPJ. The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil.
    • CPF. A Brazilian individual's taxpayer registry identification number.
    • PAN. The permanent account number issued by the Indian Income Tax Department.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

person_name

  • prefix

    string

    The prefix, or title, to the party's name.

    Maximum length: 140.

  • given_name

    string

    When the party is a person, the party's given, or first, name.

    Maximum length: 140.

  • surname

    string

    When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

    Maximum length: 140.

  • middle_name

    string

    When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

    Maximum length: 140.

  • suffix

    string

    The suffix for the party's name.

    Maximum length: 140.

  • full_name

    string

    When the party is a person, the party's full name.

    Maximum length: 300.

  • type

    enum

    The type of name. Currently supported values are: LEGAL. The possible values are:
    • LEGAL. Indicates that this name is the legal name of the user.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

person_name

  • prefix

    string

    The prefix, or title, to the party's name.

    Maximum length: 140.

  • given_name

    string

    When the party is a person, the party's given, or first, name.

    Maximum length: 140.

  • surname

    string

    When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

    Maximum length: 140.

  • middle_name

    string

    When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

    Maximum length: 140.

  • suffix

    string

    The suffix for the party's name.

    Maximum length: 140.

  • full_name

    string

    When the party is a person, the party's full name.

    Maximum length: 300.

  • type

    enum

    The type of name. Currently supported values are: LEGAL. The possible values are:
    • LEGAL. Indicates that this name is the legal name of the user.

person_name_type

  • person_name_type

    enum

    The person's name type. The possible values are:
    • LEGAL. Indicates that this name is the legal name of the user.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

person_phone_detail

  • country_code

    string

    required

    The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 3.

    Pattern: ^[0-9]{1,3}?$.

  • national_number

    string

    required

    The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 14.

    Pattern: ^[0-9]{1,14}?$.

  • extension_number

    string

    The extension number.

    Minimum length: 1.

    Maximum length: 15.

    Pattern: ^[0-9]{1,15}?$.

  • type

    enum

    The type of phone number provided. For example, home, work, or mobile. The possible values are:
    • FAX. A fax machine.
    • HOME. A home phone.
    • MOBILE. A mobile phone.
    • OTHER. Other.
    • PAGER. A pager.

person_phone_detail

  • country_code

    string

    required

    The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 3.

    Pattern: ^[0-9]{1,3}?$.

  • national_number

    string

    required

    The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 14.

    Pattern: ^[0-9]{1,14}?$.

  • extension_number

    string

    The extension number.

    Minimum length: 1.

    Maximum length: 15.

    Pattern: ^[0-9]{1,15}?$.

  • contact_name

    string

    The name that the phone number is connected to.

    Minimum length: 1.

    Maximum length: 900.

  • inactive

    boolean

    Whether this phone number has been inactivated by the user.

    Read only.

  • primary

    boolean

    Whether this is the primary contact phone number of the user.
  • primary_mobile

    boolean

    Whether this is the primary mobile phone number of the user.
  • type

    enum

    The type of phone number provided. For example, home, work, or mobile. The possible values are:
    • FAX. A fax machine.
    • HOME. A home phone.
    • MOBILE. A mobile phone.
    • OTHER. Other.
    • PAGER. A pager.
  • tags

    array (contains the phone_number_tag object)

    Array of tags for this phone number.

phone

  • country_code

    string

    required

    The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 3.

    Pattern: ^[0-9]{1,3}?$.

  • national_number

    string

    required

    The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

    Minimum length: 1.

    Maximum length: 14.

    Pattern: ^[0-9]{1,14}?$.

  • extension_number

    string

    The extension number.

    Minimum length: 1.

    Maximum length: 15.

    Pattern: ^[0-9]{1,15}?$.

phone_number_tag

  • phone_number_tag

    enum

    Tag associated with the phone number. The possible values are:
    • MOBILE. The mobile telephone number.
    • LANDLINE. The landline telephone number.

    Minimum length: 1.

    Maximum length: 255.

    Pattern: ^[0-9A-Z_]+$.

phone_type

  • phone_type

    enum

    The phone type. The possible values are:
    • FAX. A fax machine.
    • HOME. A home phone.
    • MOBILE. A mobile phone.
    • OTHER. Other.
    • PAGER. A pager.

product_name

  • product_name

    enum

    The PayPal product for which the customer is onboarded. The possible values are:
    • EXPRESS_CHECKOUT. Express checkout product
    • PPPLUS. Paypal PLUS product.
    • WEBSITE_PAYMENT_PRO. Paypal Professional product
    • PPCP. PayPal Complete Payments product

    Minimum length: 1.

    Maximum length: 127.

purpose_code

  • purpose_code

    enum

    The purpose code. Required only for India. For more information, see the Reserve Bank Of India web site. Value is:
    • P0104. Cross border delivery of goods and services.
    • P0301. Business related travel purchase.
    • P0801. Hardware consulting.
    • P0802. Software consulting.
    • P0803. Data processing consulting.
    • P0805. Freelance journalism.
    • P0806. Other information services.
    • P0902. Licensing revenues.
    • P1004. Legal.
    • P1005. Accounting and tax.
    • P1006. Business and management consultancy.
    • P1007. Advertising and market research.
    • P1008. Research and development.
    • P1009. Architectural services.
    The possible values are:
    • P0104. Cross border delivery of goods and services.
    • P0301. Business related travel purchase.
    • P0801. Hardware consulting.
    • P0802. Software consulting.
    • P0803. Data processing consulting.
    • P0805. Freelance journalism.
    • P0806. Other information services.
    • P0902. Licensing revenues.
    • P1004. Legal.
    • P1005. Accounting and tax.
    • P1006. Business and management consultancy.
    • P1007. Advertising and market research.
    • P1008. Research and development.
    • P1009. Architectural services.

    Minimum length: 1.

    Maximum length: 50.

referral_data

  • individual_owners

    array (contains the individual_owner object)

    List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.
  • business_entity

    object

    Business entity of the account.
  • email

    string

    Email address of the customer used to create the account.

    Minimum length: 3.

    Maximum length: 254.

    Pattern: ^.+@[^"\-].+$.

  • preferred_language_code

    string

    The preferred locale code to use in the onboarding flow for the customer.

    Minimum length: 2.

    Maximum length: 10.

    Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$.

  • tracking_id

    string

    The partner's unique identifier for this customer in their system which can be used to track user in PayPal.

    Minimum length: 1.

    Maximum length: 127.

  • partner_config_override

    object

    The configuration property that the partner intends to override for this onboarding request.
  • financial_instruments

    object

    Array of financial instruments attached to the customer's account.
  • operations

    array (contains the operation object)

    An array of operations to perform for the customer while they share their data.
  • products

    array (contains the product_name object)

    An array of PayPal products to which the partner wants to onboard the customer.
  • legal_consents

    array (contains the legal_consent object)

    An array of all consents that the partner has received from this seller. If SHARE_DATA_CONSENT is not granted, PayPal does not store customer data.

referral_data-bank

  • nick_name

    string

    The user-provided short name for the user's bank account.

    Minimum length: 1.

    Maximum length: 50.

  • account_number

    string

    required

    The bank account number.

    Minimum length: 1.

    Maximum length: 50.

    Pattern: \d+.

  • account_type

    enum

    required

    The type of bank account. The possible values are:
    • CHECKING. Checking account.
    • SAVINGS. Savings account.

    Minimum length: 1.

    Maximum length: 50.

  • currency_code

    string

    The primary currency code of the bank account.
  • identifiers

    array (contains the referral_data-identifier object)

    An array of instrument institute attributes. Used with the account number to uniquely identify the instrument. Value is:
    • For banks with IBAN information, the IBAN number.
    • For banks with BBAN information, the BBAN number.
    • For banks with both IBAN and BBAN information, the IBAN number.
  • branch_location

    object

    The branch location, if applicable.
  • mandate

    object

    Mandate for this bank account.

referral_data-bank.address_portable

  • address_line_1

    string

    The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

    Maximum length: 300.

  • address_line_2

    string

    The second line of the address. For example, suite or apartment number.

    Maximum length: 300.

  • admin_area_2

    string

    A city, town, or village. Smaller than admin_area_level_1.

    Maximum length: 120.

  • admin_area_1

    string

    The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
    • UK. A county.
    • US. A state.
    • Canada. A province.
    • Japan. A prefecture.
    • Switzerland. A kanton.

    Maximum length: 300.

  • postal_code

    string

    The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

    Maximum length: 60.

  • country_code

    string

    required

    The two-character ISO 3166-1 code that identifies the country or region.
    Note: The country code for Great Britain is GB and not UK 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.

referral_data-classic_api_integration

referral_data-financial_instruments

  • banks

    array (contains the referral_data-bank object)

    An array of banks attached to this managed account.

referral_data-identifier

  • type

    enum

    The bank account ID type. The possible values are:
    • BANK_CODE. The bank code.
    • BI_CODE. The BI code.
    • BRANCH_CODE. The bank branch code.
    • ROUTING_NUMBER_1. The bank routing number.
    • ROUTING_NUMBER_2. The bank routing number.
    • ROUTING_NUMBER_3. The bank routing number.
    • SWIFT_CODE. The bank swift code.
    • BRANCH_CODE. Branch code.
    • INTERMEDIARY_SWIFT_CODE. Swift code.
    • BBAN. BBAN.
    • BBAN_ENCRYPTED. BBAN enrypted.
    • BBAN_HMAC. BBAN HMAC.
    • AGGREGATOR_YODLEE. Aggregator Yodlee.

    Minimum length: 1.

    Maximum length: 125.

  • value

    string

    The value of account identifier.

    Minimum length: 1.

    Maximum length: 125.

referral_data-mandate

  • accepted

    boolean

    required

    Whether mandate was accepted or not.

referral_data-rest_api_integration

  • integration_method

    enum

    The REST-credential integration method. The possible values are:
    • BRAINTREE. Braintree integration method.
    • PAYPAL. PayPal integration method.

    Default: PAYPAL.

    Minimum length: 1.

    Maximum length: 255.

  • integration_type

    enum

    The type of REST-endpoint integration. To integrate with Braintree v.zero for PayPal REST endpoints, specify third_party_details. The possible values are:
    • FIRST_PARTY. A first-party integration.
    • THIRD_PARTY. A third-party integration.

    Minimum length: 1.

    Maximum length: 255.

  • first_party_details

    object

    required

    The integration details for PayPal first party REST endpoints.
  • third_party_details

    object

    required

    The integration details for PayPal REST endpoints.

referral_data_response

  • partner_referral_id

    string

    The ID to access the customer's data shared by the partner with PayPal.

    Read only.

  • submitter_payer_id

    string

    The payer ID of the partner who shared the referral data.

    Read only.

  • referral_data

    object

    The customer's referral data that partners share with PayPal.
  • links

    array (contains the link_description object)

    An array of request-related HATEOAS links.

    Read only.

rest_endpoint_feature

  • rest_endpoint_feature

    enum

    The REST endpoint. The possible values are:
    • PAYMENT. Payment feature.
    • REFUND. Refund feature.
    • FUTURE_PAYMENT. Future Payment feature.
    • DIRECT_PAYMENT. Direct Payment feature.
    • PARTNER_FEE. Partner fee feature.
    • DELAY_FUNDS_DISBURSEMENT. Delay funds disbursement feature.
    • READ_SELLER_DISPUTE. Read seller dispute feature.
    • UPDATE_SELLER_DISPUTE. update seller dispute feature.
    • ADVANCED_TRANSACTIONS_SEARCH. Advanced transaction search feature.
    • SWEEP_FUNDS_EXTERNAL_SINK. Sweep funds external sink feature.
    • ACCESS_MERCHANT_INFORMATION. Access merchant information feature.
    • TRACKING_SHIPMENT_READWRITE. Tracking Shipment readwrite feature.
    • INVOICE_READ_WRITE. Invoice readwrite feature.
    • DISPUTE_READ_BUYER. Read the buyer disputes.
    • UPDATE_CUSTOMER_DISPUTES. Update the buyer disputes.

third_party_details

  • features

    array (contains the rest_endpoint_feature object)

    required

    An array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.

Additional API information

Popular Search Queries
PayPal Help
FAQ's

FAQ's
Forum

Tech Support Community
PayPal Community