PayPal Partner-Referrals API is one of 37 APIs that PayPal publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Partner-Referrals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes
2 operations
across 2 paths,
and defines 94 schemas.
It is described by OpenAPI 3.0.3, at version 1.6.
Requests are made against 2 base URLs: https://api-m.sandbox.paypal.com, https://api-m.paypal.com.
The identity and technical contract details declared by the specification.
phone_number_tag
string
Tag associated with the phone number.
billing_experience_preference
object
The preference that customizes the billing experience of the customer.
2 properties
person
object
Details of the person or party.
7 properties
link_description
object
The request-related [HATEOAS link](/docs/api/reference/api-responses/hateoas-links) information.
3 properties
2 required
error_422
object
The requested action cannot be performed and may require interaction with APIs or processes outside of the current request. This is distinct from a 500 respons…
5 properties
billing_agreement
object
The details of the billing agreement between the partner and a seller.
5 properties
product
string
The PayPal product for which the customer is onboarded.
error_link_description
object
The request-related [HATEOAS link](/api/rest/responses/hateoas-links) information.
3 properties
2 required
phone
object
The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
3 properties
2 required
individual_owner
The individual owner of the account.
business_incorporation
object
Business incorporation information.
3 properties
error_default
The default error response.
business_name_detail
object
Name of the business provided.
1 required
business_name
object
The business name of the party.
1 property
person_phone_detail
object
The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
1 required
business_sub_type
string
Sub classification of the business type
business_beneficial_owner
The business beneficial owner of the account.
payout_attributes
object
Payout specific attributes.
3 properties
error_401
object
Authentication failed due to missing Authorization header, or invalid authentication credentials.
5 properties
person_document
The documents associated with the person.
purpose_code_enum
string
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 s…
account
object
Common account object to hold the account related details of the customer.
2 properties
person_name_type
string
The person's name type.
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 accep…
date_time
string
The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339section-5.6). Seconds are required while fractional seconds are option…
language
string
The [language tag](https://tools.ietf.org/html/bcp47section-2) for the language in which to localize the error-related strings, such as messages, issues, and s…
currency_code-2
string
The [three-character ISO-4217 currency code](/docs/api/reference/currency-codes/) that identifies the currency.
error_403
object
The client is not authorized to access this resource, although it may have valid credentials.
5 properties
capabilities
string
Optional capabilities of the selected PayPal product for which the customer is being onboarded.
name
object
The name of the party.
6 properties
birth_details
object
Date of birth data provided by the user
1 property
1 required
classic_api_integration
object
The integration details for PayPal CLASSIC endpoints.
rest_api_integration
object
The integration details for PayPal REST endpoints.
4 properties
business_type
string
The business types classified
person_address_detail
object
A simple postal address with coarse-grained fields.
1 required
currency_range
object
The currency range, from the minimum inclusive amount to the maximum inclusive amount.
2 properties
business_type_info
object
The type and subtype of the business.
2 properties
country_code
string
The [two-character ISO 3166-1 code](/docs/api/reference/country-codes/) that identifies the country or region. Note: The country code for Great Britain is GB a…
referral_data
object
The customer's referral data that partners share with PayPal.
2 required
business_name_type
string
Business name type
address_portable-2
object
The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) an…
10 properties
1 required
business_phone_type
string
The type of phone number provided. For example, home, work, or mobile.
business
object
9 properties
file_reference
object
The file reference. Can be a file in PayPal MediaServ, PayPal DMS, or another custom store.
5 properties
business_document_type
string
The type of documents.
error_404
object
The server has not found anything matching the request URI. This either means that the URI is incorrect or the resource is not available.
5 properties
mandate
object
Seller’s consent to operate on this financial instrument.
1 property
1 required
phone_type
string
The phone type.
operation
object
The required operation to share data.
3 properties
create_referral_data_response
object
The shared referral data.
1 property
error_details
object
The error details. Required for client-side 4XX errors.
5 properties
1 required
legal_consent
object
The customer-provided consent.
2 properties
2 required
bank
object
The bank account information.
7 properties
2 required
identifier
object
The bank account ID. An ID with ROUTINGNUMBER1 is required.
2 properties
referral_data_response
object
The share referral data response.
4 properties
person_address_type
string
The address type under which the provided address is tagged.
business_address_type
string
Address type under which the provided address is tagged
error_503
object
The server is temporarily unable to handle the request, for example, because of planned maintenance or downtime.
4 properties
currency_code
string
The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
business_entity
The business entity of the account.
person_document_type
string
The type of documents.
business_industry
object
The category, subcategory and MCC code of the business.
3 properties
3 required
email
object
An email address at which the person or business can be contacted.
2 properties
2 required
document
object
The document object.
9 properties
business_document
The documents associated with the business.
error_500
object
This is either a system or application error, and generally indicates that although the client appeared to provide a correct request, something unexpected has…
4 properties
person_name
object
The name of the person.
1 required
individual_owner_type
string
Role of the person party played in the account.
error_409
object
The server has detected a conflict while processing this request.
5 properties
date_no_time
string
The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339section-5.6). To represent special legal values, such as a date of…
office_bearer_role
string
Role of the person party played in the business.
individual_beneficial_owner
The individual owner of the account.
beneficial_owners
object
Beneficial owners of the entity.
2 properties
financial_instruments
object
Financial instruments attached to this account.
1 property
error_location
string
The location of the field that caused the error. Value is body, path, or query.
business_phone_detail
object
The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
1 required
money
object
The currency and amount for a financial transaction, such as a balance or payment due.
2 properties
2 required
office_bearer
The office bearer associated to the account.
address_portable
object
The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) an…
10 properties
1 required
transfer_method
object
Requested transfer method and currency for a country.
2 properties
error_400
object
Request is not well-formed, syntactically incorrect, or violates schema.
5 properties
integration_details
object
The integration details for the partner and customer relationship. Required if operation is APIINTEGRATION.
2 properties
country_code-2
string
The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region. Note: The country code for Great Brita…
business_address_detail
object
A simple postal address with coarse-grained fields.
1 required
country_transfer_method_currency_selection
object
Requested country, transfer method and currency.
2 properties
error_415
object
The server does not support the request payload's media type.
5 properties
percentage
string
The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
rest_endpoint_features_enum
string
The REST endpoint.
partner_config_override
object
The preference to customize the web experience of the customer by overriding that is set at the Partner's Account.
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs PayPal publishes across the network.
