Create partner referral

Creates a partner referral that is shared by the partner or API caller. The partner referral is used to onboard the seller, and contains the seller's personal, business, financial and operations.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage external referral data with PayPalhttps://uri.paypal.com/services/customer/partner-referrals/readwrite

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api-m.paypal.com/v2/customer/v2/customer/partner-referrals" \  -H "Content-Type: application/json" \  -d '{}'

{
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "debug_id": "string",
  "links": [],
  "details": [
    {
      "issue": "INVALID_STRING_LENGTH",
      "description": "the value of a field is either too short or too long"
    }
  ]
}

{
  "name": "AUTHENTICATION_FAILURE",
  "message": "Authentication failed due to missing authorization header, or invalid authentication credentials.",
  "debug_id": "string",
  "links": [],
  "details": [
    {
      "issue": "AUTHORIZATION_ERROR",
      "description": "This API call is not authorized"
    }
  ]
}

{
  "name": "NOT_AUTHORIZED",
  "message": "Authorization failed due to insufficient permissions.",
  "debug_id": "string",
  "links": [],
  "details": [
    {
      "issue": "PERMISSION_DENIED",
      "description": "You do not have permission to access or perform operations on this resource."
    }
  ]
}

{
  "name": "UNPROCESSABLE_ENTITY",
  "message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
  "debug_id": "string",
  "links": [],
  "details": [
    {
      "issue": "USER_NOT_FOUND",
      "description": "Account for this Partner ID does not exist."
    }
  ]
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred.",
  "debug_id": "90957fca61718",
  "links": [
    {
      "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR",
      "rel": "information_link"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage external referral data with PayPalhttps://uri.paypal.com/services/customer/partner-referrals/readwrite

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

individual_owners?array<Person & Individual_owner>

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

Items0 <= items <= 2

business_entity?

Business entity of the account.

email?email_address

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.

Match^.+@[^"\-].+$

Formatppaas_common_email_address_v2

Length3 <= length <= 254

preferred_language_code?language

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

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

Formatppaas_common_language_v3

Length2 <= length <= 10

tracking_id?string

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

Length1 <= length <= 127

partner_config_override?

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

financial_instruments?

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

operations*array<>

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

Items1 <= items <= 5

products?array<>

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

Items1 <= items <= 5

capabilities?array<>

An array of capabilities which the partner wants to enable for the selected products. Supported only when products are specified.

Items1 <= items <= 5

outside_process_dependencies?array<dependent_process>

An array of dependent processes.

Items1 <= items <= 5

legal_consents*array<>

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.

Items1 <= items <= 5

payout_attributes?

Payout specific attributes.

legal_country_code?country_code

The incorporation country code.

Match^([A-Z]{2}|C2)$

Formatppaas_common_country_code_v2

Length2 <= length <= 2

{ "name": "INVALID_REQUEST", "message": "Request is not well-formed, syntactically incorrect, or violates schema.", "debug_id": "string", "links": [], "details": [ { "issue": "INVALID_STRING_LENGTH", "description": "the value of a field is either too short or too long" } ] }

{ "name": "AUTHENTICATION_FAILURE", "message": "Authentication failed due to missing authorization header, or invalid authentication credentials.", "debug_id": "string", "links": [], "details": [ { "issue": "AUTHORIZATION_ERROR", "description": "This API call is not authorized" } ] }

{ "name": "NOT_AUTHORIZED", "message": "Authorization failed due to insufficient permissions.", "debug_id": "string", "links": [], "details": [ { "issue": "PERMISSION_DENIED", "description": "You do not have permission to access or perform operations on this resource." } ] }

{ "name": "UNPROCESSABLE_ENTITY", "message": "The requested action could not be performed, semantically incorrect, or failed business validation.", "debug_id": "string", "links": [], "details": [ { "issue": "USER_NOT_FOUND", "description": "Account for this Partner ID does not exist." } ] }

{ "name": "INTERNAL_SERVER_ERROR", "message": "An internal server error occurred.", "debug_id": "90957fca61718", "links": [ { "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR", "rel": "information_link" } ] }

{ "name": "INVALID_REQUEST", "message": "Request is not well-formed, syntactically incorrect, or violates schema.", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "debug_id": "string", "links": [] }

Create partner referral

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

422application/json

500application/json

defaultapplication/json

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Create partner referral

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

422application/json

500application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`