On this page
No Headings
Oauth 2.0 authentication
In: header
Scope: https://uri.paypal.com/services/customer/partner-referrals/readwrite
The ID of the partner-referrals data for which to show details.
application/json
application/json
curl -X GET "https://api-m.paypal.com/v1/customer/v1/customer/partner-referrals/string"{
"partner_referral_id": "string",
"submitter_payer_id": "string",
"referral_data": {
"customer_data": {
"customer_type": "CONSUMER",
"person_details": {
"email_address": "string",
"name": {
"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"phone_contacts": [
{
"phone_number_details": {
"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"home_address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st",
"identity_documents": [
{
"type": "SOCIAL_SECURITY_NUMBER",
"value": "string",
"partial_value": false,
"issuer_country_code": "string"
}
],
"account_owner_relationships": [
{
"name": {
"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"relation": "MOTHER",
"country_code_of_nationality": "st"
}
]
},
"business_details": {
"phone_contacts": [
{
"phone_number_details": {
"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"business_address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"business_type": "string",
"business_subtype": "ASSO_TYPE_INCORPORATED",
"category": "string",
"sub_category": "string",
"merchant_category_code": "string",
"purpose_code": [
"P0104"
],
"names": [
{
"type": "LEGAL",
"name": "string"
}
],
"business_description": "string",
"event_dates": [
{
"event_type": "BIRTH",
"event_date": "2019-08-24T14:15:22Z"
}
],
"website_urls": [
"http://example.com"
],
"annual_sales_volume_range": {
"minimum_amount": {
"currency": "string",
"value": "string"
},
"maximum_amount": {
"currency": "string",
"value": "string"
}
},
"average_monthly_volume_range": {
"minimum_amount": {
"currency": "string",
"value": "string"
},
"maximum_amount": {
"currency": "string",
"value": "string"
}
},
"identity_documents": [
{
"type": "SOCIAL_SECURITY_NUMBER",
"value": "string",
"partial_value": false,
"issuer_country_code": "string"
}
],
"email_contacts": [
{
"email_address": "string",
"role": "CUSTOMER_SERVICE"
}
],
"country_of_incorporation": "st",
"beneficial_owners": {
"individual_beneficial_owners": [],
"business_beneficial_owners": []
},
"office_bearers": []
},
"financial_instrument_data": {
"bank_details": [
{
"nick_name": "string",
"account_number": "string",
"account_type": "CHECKING",
"currency_code": "string",
"identifiers": [
{
"type": "ROUTING_NUMBER_1",
"value": "string"
}
],
"branch_location": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"mandate_agreed": true
}
]
},
"preferred_language_code": "string",
"primary_currency_code": null,
"referral_user_payer_id": {
"type": "PAYER_ID",
"value": "string"
},
"partner_specific_identifiers": [
{
"type": "TRACKING_ID",
"value": "string"
}
]
},
"requested_capabilities": [
{
"capability": "API_INTEGRATION",
"api_integration_preference": {
"partner_id": "string",
"rest_api_integration": {
"integration_method": "BRAINTREE",
"integration_type": "FIRST_PARTY",
"integration_channel": "DEFERRED_ONBOARDING"
},
"rest_third_party_details": {
"partner_client_id": "string",
"feature_list": [
"PAYMENT"
]
},
"rest_first_party_details": {
"partner_client_id": "string",
"feature_list": [
"PAYMENT"
],
"seller_nonce": "stringstringstringstringstringstringstringst"
}
},
"billing_agreement": {
"description": "string",
"billing_experience_preference": {
"experience_id": "string",
"billing_context_set": true
},
"merchant_custom_data": "string",
"approval_url": "http://example.com",
"ec_token": "string"
}
}
],
"web_experience_preference": {
"partner_logo_url": "http://example.com",
"return_url": "http://example.com",
"return_url_description": "string",
"action_renewal_url": "http://example.com",
"show_add_credit_card": true,
"show_mobile_confirm": true,
"use_mini_browser": true,
"use_hua_email_confirmation": true
},
"collected_consents": [
{
"type": "SHARE_DATA_CONSENT",
"granted": true
}
],
"products": [
"EXPRESS_CHECKOUT"
]
},
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
]
}{
"name": "string",
"message": "string",
"debug_id": "string",
"information_link": "string",
"details": [
{
"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}
],
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
]
}