Managed Accounts API
Important: PayPal for Partners 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.
The Managed Accounts API enables a partner to add PayPal managed accounts. It supports the Connected path and Managed path partner models:
With 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.
With Managed path, you create and configure reference accounts that enable you to make payments to sellers on your platform. The Managed Accounts API enables you to create reference accounts without involving your sellers.
Partner merchant (resource group)
Create managed account
Request body
-
The account holder's information.
-
The business information for the merchant.
-
account_status
enum
The account status. -
The three-character ISO-4217 currency code for the account.
-
secondary_currency
array (contains the currency_code object)
An array of the three-character ISO-4217 currency codes for the secondary currencies. -
payment_receiving_preferences
The account preferences for receipt of payments. -
An array of account relationships.
-
account_permissions
array (contains the account_permissions object)
An array of permissions to assign to the account. -
timezone
enum
The time zone. -
partner_merchant_external_id
string
An ID that the partner creates for the managed account. -
loginable
boolean
Indicates whether the account allows the merchant to log in. -
partner_tax_reporting
boolean
Indicates whether the partner reports taxes for the account. -
signup_options
The options, preferences, and agreements for the account. -
financial_instruments
An array of financial instruments.
Sample Request
curl -v -X POST https://api.sandbox.paypal.com/v1/customer/partners/merchant-accounts \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
"owner_info": {
"email": "demo-201@example.com",
"name": {
"prefix": "Mr",
"given_name": "John",
"surname": "Collins",
"middle_name": "Davis",
"suffix": "Jr"
},
"country_code_of_nationality": "US",
"addresses": [
{
"type": "HOME",
"line1": "150 E San Fernando St",
"line2": "apt #1",
"city": "San Jose",
"state": "CA",
"country_code": "US",
"postal_code": "95112"
}
],
"date_of_birth": "1990-01-01",
"identifications": [
{
"type": "SOCIAL_SECURITY_NUMBER",
"value": "123456789",
"masked": true,
"issuer_country_code": "US"
}
],
"phones": [
{
"type": "HOME",
"country_code": "1",
"national_number": "4089679174",
"extension_number": "123"
},
{
"type": "MOBILE",
"country_code": "1",
"national_number": "4089679175",
"extension_number": "123"
}
]
},
"business_info": {
"type": "INDIVIDUAL",
"names": [
{
"type": "LEGAL",
"name": "US Business"
},
{
"type": "DOING_BUSINESS_AS",
"name": "Doing Business As Name"
}
],
"identifications": [
{
"type": "EMPLOYMENT_IDENTIFICATION_NUMBER",
"value": "111234501",
"masked": false,
"issuer_country_code": "US"
}
],
"addresses": [
{
"type": "WORK",
"line1": "585 Franklin Str",
"line2": "apt #1",
"city": "Mountain View",
"state": "CA",
"country_code": "US",
"postal_code": "94041"
}
],
"phones": [
{
"type": "WORK",
"country_code": "1",
"national_number": "4089672222",
"extension_number": "123"
},
{
"type": "BUSINESS",
"country_code": "1",
"national_number": "4081234567"
}
],
"category": "1004",
"sub_category": "2940",
"merchant_category_code": "3011",
"date_business_established": "2001-01-17",
"date_of_registration": "2011-04-17",
"dispute_email": "dispute@example.com",
"business_sales_details": {
"average_price": {
"minimum_amount": {
"currency_code": "USD",
"value": "10"
},
"maximum_amount": {
"currency_code": "USD",
"value": "100"
}
},
"average_monthly_volume": {
"minimum_amount": {
"currency_code": "USD",
"value": "1000"
},
"maximum_amount": {
"currency_code": "USD",
"value": "2000"
}
},
"sales_venues": [
{
"type": "EBAY",
"ebay_id": "ebayid123",
"description": "ebay venue"
},
{
"type": "ANOTHER_MARKET_PLACE",
"description": "description"
}
],
"website": "https://example.com",
"revenue_from_online_sales": {
"minimum_percent": 0,
"maximum_percent": 25
}
},
"customer_service": {
"email": "customer-service@example.com",
"phone": {
"country_code": "1",
"national_number": "4089673333",
"extension_number": "123"
},
"message": [
{
"type": "ONLINE",
"headline": "Your online purchase",
"logo_image_url": "https://example.com/logo/online/",
"service_image_url": "https://example.com/service/online/",
"seller_message": "Your online purchase"
},
{
"type": "RETAIL",
"headline": "Your retail purchase",
"logo_image_url": "https://example.com/logo/retail/",
"service_image_url": "https://example.com/service/retail/",
"seller_message": "Your retail purchase"
}
]
}
},
"account_status": "A",
"account_currency": "USD",
"secondary_currency": [
"CAD",
"JPY"
],
"payment_receiving_preferences": {
"block_unconfirmed_us_address_payments": true,
"block_non_us_payments": true,
"block_echeck_payments": true,
"block_cross_currency_payments": true,
"block_send_money_payments": true,
"alternate_payment_url": "https://example.com/alternate/",
"display_instructions_text_input": true,
"cc_soft_descriptor": "USCCSOFTDES",
"cc_soft_descriptor_extended": "USCCSOFTDESEXT"
},
"account_relations": [
{
"type": "PARTNER"
}
],
"account_permissions": [
{
"permissions": [
"EXPRESS_CHECKOUT",
"RECURRING_PAYMENT",
"EXTENDED_PRO_PROCESSING",
"EXCEPTION_PROCESSING",
"MASS_PAY",
"ENCRYPTED_WEBSITE_PAYMENTS"
]
}
],
"timezone": "America/Los_Angeles",
"partner_merchant_external_id": "abc123",
"loginable": false,
"partner_tax_reporting": true
}'
Response
201 Created
status code and a JSON response body that shows managed account details.-
payer_id
string
The payer ID. If the account was not created, this value is blank. -
partner_merchant_external_id
string
The partner-specified ID for the account, which was passed in thepartner_merchant_external_id
request parameter. -
merchant_authorization_code
string
The merchant authorization code. -
custom_data
array (contains the keyvalue object)
An array of key-and-value pairs that contain custom data. For example,aa_token
. -
errors
array (contains the error object)
An array of errors, if any, that occurred during account creation. -
links
array (contains the link_description object)
An array of request-related HATEOAS links.
Sample Response
{
"payer_id": "7G4EPEEPEF74L",
"partner_merchant_external_id": "abc123",
"links": [
{
"href": "https://api.paypal.com/v1/customer/partners/merchant-accounts/7G4EPEEPEF74L",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.paypal.com/v1/customer/partners/merchant-accounts/7G4EPEEPEF74L",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api.paypal.com/v1/customer/partners/merchant-accounts/7G4EPEEPEF74L",
"rel": "replace",
"method": "PUT"
}
]
}
Repopulate managed account
Important: This method is deprecated as of v1.1. Please use the PUT method.
Path parameters
-
merchant_payer_id
string
required
The payer ID of the merchant for which to repopulate an account.
Request body
-
The account holder's information.
-
The business information for the merchant.
-
account_status
enum
The account status. -
The three-character ISO-4217 currency code for the account.
-
secondary_currency
array (contains the currency_code object)
An array of the three-character ISO-4217 currency codes for the secondary currencies. -
payment_receiving_preferences
The account preferences for receipt of payments. -
An array of account relationships.
-
account_permissions
array (contains the account_permissions object)
An array of permissions to assign to the account. -
timezone
enum
The time zone. -
partner_merchant_external_id
string
An ID that the partner creates for the managed account. -
loginable
boolean
Indicates whether the account allows the merchant to log in. -
partner_tax_reporting
boolean
Indicates whether the partner reports taxes for the account. -
signup_options
The options, preferences, and agreements for the account. -
financial_instruments
An array of financial instruments.
Sample Request
curl -v -X POST https://api.sandbox.paypal.com/v1/customer/partners/merchant-accounts/F9E99K66P3G77 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
"owner_info": {
"email": "demo-201@example.com",
"name": {
"prefix": "Mr",
"given_name": "John",
"surname": "Collins",
"middle_name": "Davis",
"suffix": "Jr"
},
"country_code_of_nationality": "US",
"addresses": [
{
"type": "HOME",
"line1": "150 E San Fernando St",
"line2": "apt #1",
"city": "San Jose",
"state": "CA",
"country_code": "US",
"postal_code": "95112"
}
],
"date_of_birth": "1990-01-01",
"phones": [
{
"type": "HOME",
"country_code": "1",
"national_number": "4089679174",
"extension_number": "123"
},
{
"type": "MOBILE",
"country_code": "1",
"national_number": "4089679175",
"extension_number": "123"
}
],
"identifications": [
{
"type": "SOCIAL_SECURITY_NUMBER",
"value": "1234",
"masked": true,
"issuer_country_code": "US"
}
]
},
"business_info": {
"type": "INDIVIDUAL",
"names": [
{
"type": "LEGAL",
"name": "US Business"
},
{
"type": "DOING_BUSINESS_AS",
"name": "Doing Business As Name"
}
],
"identifications": [
{
"type": "EMPLOYMENT_IDENTIFICATION_NUMBER",
"value": "111234501",
"masked": false,
"issuer_country_code": "US"
}
],
"addresses": [
{
"type": "WORK",
"line1": "585 Franklin Str",
"line2": "apt #1",
"city": "Mountain View",
"state": "CA",
"country_code": "US",
"postal_code": "94041"
}
],
"phones": [
{
"type": "WORK",
"country_code": "1",
"national_number": "4089672222",
"extension_number": "123"
},
{
"type": "BUSINESS",
"country_code": "1",
"national_number": "4081234567"
}
],
"category": "1004",
"sub_category": "2940",
"merchant_category_code": "3011",
"date_business_established": "2001-01-17",
"date_of_registration": "2011-04-17",
"dispute_email": "dispute@example.com",
"business_sales_details": {
"average_price": {
"minimum_amount": {
"currency_code": "USD",
"value": "10"
},
"maximum_amount": {
"currency_code": "USD",
"value": "100"
}
},
"average_monthly_volume": {
"minimum_amount": {
"currency_code": "USD",
"value": "1000"
},
"maximum_amount": {
"currency_code": "USD",
"value": "2000"
}
},
"sales_venues": [
{
"type": "EBAY",
"ebay_id": "ebayid123",
"description": "ebay venue"
},
{
"type": "ANOTHER_MARKET_PLACE",
"description": "description"
}
],
"website": "https://example.com",
"revenue_from_online_sales": {
"minimum_percent": 0,
"maximum_percent": 25
}
},
"customer_service": {
"email": "customer-service@example.com",
"phone": {
"country_code": "1",
"national_number": "4089673333",
"extension_number": "123"
},
"message": [
{
"type": "ONLINE",
"headline": "Your online purchase",
"logo_image_url": "https://example.com/logo/online/",
"service_image_url": "https://example.com/service/online/",
"seller_message": "Your online purchase"
},
{
"type": "RETAIL",
"headline": "Your retail purchase",
"logo_image_url": "https://example.com/logo/retail/",
"service_image_url": "https://example.com/service/retail/",
"seller_message": "Your retail purchase"
}
]
}
},
"account_status": "A",
"account_currency": "USD",
"secondary_currency": [
"CAD",
"JPY"
],
"payment_receiving_preferences": {
"block_unconfirmed_us_address_payments": true,
"block_non_us_payments": true,
"block_echeck_payments": true,
"block_cross_currency_payments": true,
"block_send_money_payments": true,
"alternate_payment_url": "https://example.com/alternate/",
"display_instructions_text_input": true,
"cc_soft_descriptor": "USCCSOFTDES",
"cc_soft_descriptor_extended": "USCCSOFTDESEXT"
},
"account_relations": [
{
"type": "PARTNER"
}
],
"account_permissions": [
{
"permissions": [
"EXPRESS_CHECKOUT",
"RECURRING_PAYMENT",
"EXTENDED_PRO_PROCESSING",
"EXCEPTION_PROCESSING",
"MASS_PAY",
"ENCRYPTED_WEBSITE_PAYMENTS"
]
}
],
"timezone": "America/Los_Angeles",
"partner_merchant_external_id": "abc123",
"loginable": false,
"partner_tax_reporting": true
}'
Response
201 Created
status code and a JSON response body that shows managed account details.-
payer_id
string
The payer ID. If the account was not created, this value is blank. -
partner_merchant_external_id
string
The partner-specified ID for the account, which was passed in thepartner_merchant_external_id
request parameter. -
merchant_authorization_code
string
The merchant authorization code. -
custom_data
array (contains the keyvalue object)
An array of key-and-value pairs that contain custom data. For example,aa_token
. -
errors
array (contains the error object)
An array of errors, if any, that occurred during account creation. -
links
array (contains the link_description object)
An array of request-related HATEOAS links.
Sample Response
{
"payer_id": "7G4EPEEPEF74L",
"partner_merchant_external_id": "abc123",
"links": [
{
"href": "https://api.paypal.com/v1/customer/partners/merchant-accounts/7G4EPEEPEF74L",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api.paypal.com/v1/customer/partners/merchant-accounts/7G4EPEEPEF74L",
"rel": "edit",
"method": "POST"
}
]
}
Partially update managed account
Path parameters
-
merchant_payer_id
string
required
The ID of the merchant.
Request body
-
patch_request
array (contains the patch object)
An array of JSON patch objects to apply partial updates to resources.
Sample Request
curl -v -X PATCH https://api.sandbox.paypal.com/v1/customer/partners/merchant-accounts/F9E99K66P3G77 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '[
{
"op": "replace",
"path": "create_account_details/owner_info/name/given_name",
"value": "John"
},
{
"op": "replace",
"path": "create_account_details/owner_info/address/line1",
"value": "123 Garden St."
}
]'
Response
204 No Content
status code with no JSON response body.Sample Response
204 No Content
Update managed account
Path parameters
-
merchant_payer_id
string
required
The payer ID of the merchant for which to update account information.
Request body
-
owner_info
The account holder's information. -
business_info
The business information for the merchant. -
account_status
The account status. -
account_currency
The currency code for the account. -
secondary_currency
array (contains the currency_code object)
An array of secondary currencies. In addition to the account currency, the managed account can accept transactions in other currencies. -
payment_receiving_preferences
The account preferences for receipt of payments. -
account_relations
array (contains the account_relations object)
An array of account relationships between the parent and this account. -
account_permissions
array (contains the account_permissions object)
An array of permissions to assign to the account. -
timezone
The time zone. -
partner_merchant_external_id
string
An ID that the partner creates for the managed account.Note: You cannot fetch this information.
-
loginable
boolean
Indicates whether the account enables the merchant to log in. You cannot log in to accounts that are only managed by their parent. -
partner_tax_reporting
boolean
Indicates whether the partner reports taxes for the account.Note: You cannot fetch this information.
-
signup_options
The partner options to assign to the managed account. -
errors
array (contains the error object)
An array of errors for adding bundles to a given customer account.
Sample Request
curl -v -X POST https://api.sandbox.paypal.com/v1/customer/partners/merchant-accounts/F9E99K66P3G77 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
"owner_info": {
"email": "owner-info@example.com",
"name": {
"prefix": "US Prefix",
"given_name": "USFirstName",
"surname": "US LastName",
"middle_name": "US MiddleName",
"suffix": "US Suffix"
},
"country_code_of_nationality": "US",
"addresses": [
{
"type": "HOME",
"line1": "150 E San Fernando St",
"line2": "apt #1",
"city": "San Jose",
"state": "CA",
"country_code": "US",
"postal_code": "95112"
}
],
"date_of_birth": "1990-01-01",
"phones": [
{
"type": "HOME",
"country_code": "1",
"national_number": "4089679174",
"extension_number": "123"
},
{
"type": "MOBILE",
"country_code": "1",
"national_number": "4089679175",
"extension_number": "123"
}
],
"identifications": [
{
"type": "SOCIAL_SECURITY_NUMBER",
"value": "1234",
"masked": true,
"issuer_country_code": "US"
}
]
},
"business_info": {
"type": "INDIVIDUAL",
"names": [
{
"type": "LEGAL",
"name": "US Business"
},
{
"type": "DOING_BUSINESS_AS",
"name": "Doing Business As Name"
}
],
"identifications": [
{
"type": "EMPLOYMENT_IDENTIFICATION_NUMBER",
"value": "111234501",
"masked": false,
"issuer_country_code": "US"
}
],
"addresses": [
{
"type": "WORK",
"line1": "585 Franklin Str",
"line2": "apt #1",
"city": "Mountain View",
"state": "CA",
"country_code": "US",
"postal_code": "94041"
}
],
"phones": [
{
"type": "WORK",
"country_code": "1",
"national_number": "4089672222",
"extension_number": "123"
},
{
"type": "BUSINESS",
"country_code": "1",
"national_number": "4081234567"
}
],
"category": "1004",
"sub_category": "2940",
"merchant_category_code": "3011",
"date_business_established": "2001-01-17",
"date_of_registration": "2011-04-17",
"dispute_email": "dispute@example.com",
"business_sales_details": {
"average_price": {
"minimum_amount": {
"currency_code": "USD",
"value": "10"
},
"maximum_amount": {
"currency_code": "USD",
"value": "100"
}
},
"average_monthly_volume": {
"minimum_amount": {
"currency_code": "USD",
"value": "1000"
},
"maximum_amount": {
"currency_code": "USD",
"value": "2000"
}
},
"sales_venues": [
{
"type": "EBAY",
"ebay_id": "ebayid123",
"description": "ebay venue"
},
{
"type": "ANOTHER_MARKET_PLACE",
"description": "description"
}
],
"website": "https://example.com",
"revenue_from_online_sales": {
"minimum_percent": 0,
"maximum_percent": 25
}
},
"customer_service": {
"email": "customer-service@example.com",
"phone": {
"country_code": "1",
"national_number": "4089673333",
"extension_number": "123"
},
"message": [
{
"type": "ONLINE",
"headline": "headline1",
"logo_image_url": "https://example.com/logoimage/",
"service_image_url": "https://example.com/serviceimageurl1/",
"seller_message": "seller message"
},
{
"type": "RETAIL",
"headline": "headline2",
"logo_image_url": "https://example.com/logoimageurl2/",
"service_image_url": "https://example.com/serviceimageurl2/",
"seller_message": "seller message"
}
]
}
},
"account_status": "A",
"account_currency": "USD",
"secondary_currency": [
"CAD",
"JPY"
],
"payment_receiving_preferences": {
"block_unconfirmed_us_address_payments": true,
"block_non_us_payments": true,
"block_echeck_payments": true,
"block_cross_currency_payments": true,
"block_send_money_payments": true,
"alternate_payment_url": "www.original.com",
"display_instructions_text_input": true,
"cc_soft_descriptor": "USCCSOFTDES",
"cc_soft_descriptor_extended": "USCCSOFTDESEXT"
},
"account_relations": [
{
"type": "PARTNER"
}
],
"account_permissions": [
{
"permissions": [
"EXPRESS_CHECKOUT",
"RECURRING_PAYMENT",
"EXTENDED_PRO_PROCESSING",
"EXCEPTION_PROCESSING",
"MASS_PAY",
"ENCRYPTED_WEBSITE_PAYMENTS"
]
}
],
"timezone": "America/Los_Angeles",
"partner_merchant_external_id": "abc123",
"loginable": false,
"partner_tax_reporting": true
}'
Response
204 No Content
status code with no JSON response body.Sample Response
204 No Content
Show managed account details
Path parameters
-
merchant_payer_id
string
required
The payer ID of the merchant for which to show account details.
Sample Request
curl -v -X GET https://api.sandbox.paypal.com/v1/customer/partners/merchant-accounts/9KGJMW85LN4KC \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token"
Response
200 OK
status code and a JSON response body that shows managed account details.-
owner_info
The account holder's information. -
business_info
The business information for the merchant. -
account_status
The account status. -
account_currency
The currency code for the account. -
secondary_currency
array (contains the currency_code object)
An array of secondary currencies. In addition to the account currency, the managed account can accept transactions in other currencies. -
payment_receiving_preferences
The account preferences for receipt of payments. -
account_relations
array (contains the account_relations object)
An array of account relationships between the parent and this account. -
account_permissions
array (contains the account_permissions object)
An array of permissions to assign to the account. -
timezone
The time zone. -
partner_merchant_external_id
string
An ID that the partner creates for the managed account.Note: You cannot fetch this information.
-
loginable
boolean
Indicates whether the account enables the merchant to log in. You cannot log in to accounts that are only managed by their parent. -
partner_tax_reporting
boolean
Indicates whether the partner reports taxes for the account.Note: You cannot fetch this information.
-
signup_options
The partner options to assign to the managed account. -
errors
array (contains the error object)
An array of errors for adding bundles to a given customer account. -
links
array (contains the link_description object)
An array of request-related HATEOAS links.
Sample Response
{
"owner_info": {
"email": "owner-info@example.com",
"name": {
"prefix": "US Prefix",
"given_name": "USFirstName",
"surname": "US LastName",
"middle_name": "US MiddleName",
"suffix": "US Suffix"
},
"country_code_of_nationality": "US",
"addresses": [
{
"type": "HOME",
"line1": "150 E San Fernando St",
"line2": "apt #1",
"city": "San Jose",
"state": "CA",
"country_code": "US",
"postal_code": "95112"
}
],
"date_of_birth": "1990-01-01",
"identifications": [
{
"type": "SOCIAL_SECURITY_NUMBER",
"value": "****",
"masked": true,
"issuer_country_code": "US"
}
],
"phones": [
{
"type": "HOME",
"country_code": "1",
"national_number": "4089679174",
"extension_number": "123"
},
{
"type": "MOBILE",
"country_code": "1",
"national_number": "4089679175",
"extension_number": "123"
}
]
},
"business_info": {
"type": "INDIVIDUAL",
"names": [
{
"type": "LEGAL",
"name": "US Business"
},
{
"type": "DOING_BUSINESS_AS",
"name": "Doing Business As Name"
}
],
"identifications": [
{
"type": "EMPLOYMENT_IDENTIFICATION_NUMBER",
"value": "****",
"masked": false,
"issuer_country_code": "US"
}
],
"addresses": [
{
"type": "WORK",
"line1": "585 Franklin Str",
"line2": "apt #1",
"city": "Mountain View",
"state": "CA",
"country_code": "US",
"postal_code": "94041"
}
],
"phones": [
{
"type": "WORK",
"country_code": "1",
"national_number": "4089672222",
"extension_number": "123"
},
{
"type": "BUSINESS",
"country_code": "1",
"national_number": "4081234567"
}
],
"category": "1004",
"sub_category": "2940",
"merchant_category_code": "3011",
"date_business_established": "2001-01-17",
"date_of_registration": "2011-04-17",
"dispute_email": "dispute@example.com",
"business_sales_details": {
"average_price": {
"minimum_amount": {
"currency_code": "USD",
"value": "10"
},
"maximum_amount": {
"currency_code": "USD",
"value": "100"
}
},
"average_monthly_volume": {
"minimum_amount": {
"currency_code": "USD",
"value": "1000"
},
"maximum_amount": {
"currency_code": "USD",
"value": "2000"
}
},
"sales_venues": [
{
"type": "EBAY",
"ebay_id": "ebayid123",
"description": "ebay venue"
},
{
"type": "ANOTHER_MARKET_PLACE",
"description": "description"
}
],
"website": "https://example.com",
"revenue_from_online_sales": {
"minimum_percent": 0,
"maximum_percent": 25
}
},
"customer_service": {
"email": "customer-service@example.com",
"phone": {
"country_code": "1",
"national_number": "4089673333",
"extension_number": "123"
},
"message": [
{
"type": "ONLINE",
"headline": "headline1",
"logo_image_url": "https://example.com/logoimage/",
"service_image_url": "https://example.com/serviceimageurl1/",
"seller_message": "seller message"
},
{
"type": "RETAIL",
"headline": "headline2",
"logo_image_url": "https://example.com/logoimageurl2/",
"service_image_url": "https://example.com/serviceimageurl2/",
"seller_message": "seller message"
}
]
}
},
"account_status": "A",
"account_currency": "USD",
"secondary_currency": [
"CAD",
"JPY"
],
"payment_receiving_preferences": {
"block_unconfirmed_us_address_payments": true,
"block_non_us_payments": true,
"block_echeck_payments": true,
"block_cross_currency_payments": true,
"block_send_money_payments": true,
"alternate_payment_url": "www.original.com",
"display_instructions_text_input": true,
"cc_soft_descriptor": "USCCSOFTDES",
"cc_soft_descriptor_extended": "USCCSOFTDESEXT"
},
"account_relations": [
{
"type": "PARTNER"
}
],
"account_permissions": [
{
"permissions": [
"EXPRESS_CHECKOUT",
"RECURRING_PAYMENT",
"EXTENDED_PRO_PROCESSING",
"EXCEPTION_PROCESSING",
"MASS_PAY",
"ENCRYPTED_WEBSITE_PAYMENTS"
]
}
],
"timezone": "America/Los_Angeles",
"partner_merchant_external_id": "abc123",
"loginable": false,
"partner_tax_reporting": true,
"links": [
{
"href": "https://api.paypal.com/v1/customer/partners/merchant-accounts/9KGJMW85LN4KC",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api.paypal.com/v1/customer/partners/merchant-accounts/9KGJMW85LN4KC",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api.paypal.com/v1/customer/partners/merchant-accounts/9KGJMW85LN4KC",
"rel": "self",
"method": "GET"
}
]
}
Partner merchant balance (resource group)
Show managed account balance
Path parameters
-
merchant_payer_id
string
required
The payer ID of the merchant for which to show account balances.
Sample Request
curl -v -X GET https://api.sandbox.paypal.com/v1/customer/partners/merchant-accounts/9KGJMW85LN4KC/balances \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token"
Response
200 OK
status code and a JSON response body that shows the managed account balance.-
payer_id
An immutable account identifier which identifies the PayPal account. -
available_balances
array (contains the money object)
This field contains the total available balances based on currency. -
pending_balances
array (contains the money object)
This field contains the total pending reversal balances based on currency.
Sample Response
{
"payer_id": "9KGJMW85LN4KC",
"available_balances": [
{
"currency_code": "USD",
"value": "3000"
},
{
"currency_code": "CAD",
"value": "-100"
},
{
"currency_code": "EUR",
"value": "0"
}
],
"pending_balances": [
{
"currency_code": "USD",
"value": "0"
},
{
"currency_code": "CAD",
"value": "0"
},
{
"currency_code": "EUR",
"value": "0"
}
]
}
Partner merchant fi (resource group)
Show financial instrument details
Path parameters
-
merchant_payer_id
string
required
The merchant ID.
Sample Request
curl -v -X GET https://api.sandbox.paypal.com/v1/customer/partners/merchant-accounts/9KGJMW85LN4KC/financial-instruments \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token"
Response
200 OK
status code and a JSON response body that shows the financial instrument details for the managed account.-
financial_instruments
array (contains the financial_instrument object)
An array of financial instruments.
Sample Response
{
"financial_instruments": [
{
"type": "BANK",
"id": "BA-HS6DWCX4ETHL4",
"account_type": "CHECKING",
"account_number": "5258",
"account_number_type": "BASIC_BANK_ACCOUNT_NUMBER",
"routing_number": "081500875",
"currency_code": "USD",
"country_code": "US",
"account_holder_details": {
"name": "My company Inc"
},
"bank_name": "Bank of America",
"branch_location": "North 1st street",
"links": {
"href": "https://api.paypal.com/v1/customer/partners/merchant-accounts/7G4EPEEPEF74L",
"rel": "self",
"method": "PATCH"
}
}
]
}
Common object definitions
account_holder_details
-
name
string
The name on the account holder's bank account. -
type
enum
The type of bank account, which is business or individual. The possible values are:BUSINESS
. A business bank account.INDIVIDUAL
. An individual bank account
-
identifier
The details of the account holder's ID.
account_holder_identifier
-
type
enum
The account holder's ID type. The possible values are:NATIONAL_ID
. The ID type is a national ID.TAX_ID
. The ID is a tax ID.
-
value
string
The account holder's ID value.
account_permissions
-
third_party
string
The third-party ID for the account. -
permissions
array (contains the permissions object)
The permission to assign to the account.Note: The
SETTLEMENT_CONSOLIDATION
permissions is not applicable to all partners.Permission Description DIRECT_PAYMENT
Processes direct credit card transactions for the managed account by using PayPal Payments Pro, if the account is enabled for it. Provides access to the DoDirectPayment
API.EXPRESS_CHECKOUT
Processes Express Checkout transactions. Provides access to these APIs: SetExpressCheckout
GetExpressCheckoutDetails
DoExpressCheckoutPayment
GetPalDetails
- Preapproved Payment Agreement Report
- Subscription Agreement Report
- Order Report
RECURRING_PAYMENT
Processes recurring payments for the managed account. Provides access to these APIs: BillAgreementUpdate
BillUser
SetCustomerBillingAgreement
GetBillingAgreementCustomerDetails
CreateBillingAgreement
DoReferenceTransaction
EXTENDED_PRO_PROCESSING
Completes back-end processing functions for the managed account. Provides access to these APIs: DoCapture
DoAuthorization
DoReauthorization
DoVoid
EXCEPTION_PROCESSING
Completes certain customer service functions for the managed account. Provides access to these APIs: RefundTransaction
TransactionSearch
GetTransactionDetails
- Transaction Detail Report
- Case Report
SETTLEMENT_CONSOLIDATION
Consolidates funds from the managed account into your account on a daily basis. With this permission set, PayPal sweeps all funds from the managed account into your account on a daily basis. If the managed account balance is negative, PayPal deducts the negative balance from your account to true-up the account’s balance back to zero.
If you are subscribed to any of the following reports, this permission consolidates the reporting information from the managed account into your reports:- Transaction Detail Report
- Settlement Report
SETTLEMENT_REPORTING
Consolidates reporting information from the managed account into your account.
If you are subscribed to any of the following reports, this permission consolidates the reporting information from the managed account into your reports:- Transaction Detail Report
- Settlement Report
MASS_PAY
Makes payments from the managed account using PayPal’s MassPay
API.ENCRYPTED_WEBSITE_PAYMENTS
Encrypts standard PayPal payments buttons on behalf of the managed account using PayPal’s Encrypted Website Payments feature. DISPUTE_RESOLUTION
Responds to disputes on behalf of the managed account. With this permission set, disputes opened against the campaign appear in the Resolution Center for your account. SHARED_REFUND
Processes refunds against your own account for transactions originally accepted by the managed account. SHARED_AUTHORIZATION
Captures transactions using your own account against authorizations originally obtained by the managed account. VIEW_BALANCE
Retrieves the managed account’s PayPal balance. Provides access to the following GetBalance
API.VIEW_PROFILE
Shows the managed account’s profile. EDIT_PROFILE
Edits the managed account’s profile.
account_relations
-
subject_payer_id
string
The payer ID of the subject. -
type
enum
required
The type of relationship.
account_status
-
account_status
enum
The account status.
address
-
type
enum
required
The address type. -
line1
string
required
The first line of the address. For example, number, street, and so on. Maximum length is 300 characters. -
line2
string
The second line of the address. For example, suite, apt number, and so on. -
line3
string
The third line of the address. For example, the street complement for Brazil, direction text, such asnext to Walmart
, or a landmark in an Indian address. -
suburb
string
The suburb or neighborhood. -
city
string
required
The city. -
state
string
-
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions. -
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.
address_portable_postal_code_validation
-
address_portable_postal_code_validation
bank_account
-
id
string
The PayPal-generated ID for the bank account. -
last_4_digits
string
The last four digits of bank account number. -
account_number
string
required
The account number in either:- The International Bank Account Number (IBAN) format.
- Basic Bank Account Number (BBAN) format. Maximum length is 17 characters.
-
account_number_type
enum
required
The type of bank account number. The possible values are:BASIC_BANK_ACCOUNT_NUMBER
. A Basic Bank Account Number (BBAN).INTERNATIONAL_BANK_ACCOUNT_NUMBER
. An International Bank Account Number (IBAN).WIRE
. A wire bank account number.
-
account_type
enum
The type of bank account. The possible values are:SAVINGS
. A savings account.CHECKING
. A checking account.
-
routing_number
string
The routing transit number, or bank code, of the bank. Typically used for domestic accounts only. For international accounts, the IBAN includes the bank code. -
bic
string
The bank identification code (BIC) for countries that support BIC. -
currency_code
The three-character ISO-4217 currency code that identifies the currency. -
country_code
The two-character ISO 3166-1 code that identifies the country or region.Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions. -
account_holder_details
The details for the account holder who owns the bank account. -
branch_code
string
The branch code of the bank account. -
bank_name
string
The name of the bank. -
branch_location
string
The branch location of the bank.
business_info
-
type
enum
required
The type of business, such as corporation or sole proprietorship. -
sub_type
string
The business sub-type. Value isASSO_TYPE_INCORPORATED
,ASSO_TYPE_NON_INCORPORATED
,GOVT_TYPE_EMANATION
,GOVT_TYPE_ENTITY
,GOVT_TYPE_ESTD_COMM
,GOVT_TYPE_ESTD_FC
,GOVT_TYPE_ESTD_ST_TR
, orUNSELECTED
. -
government_body
The government body. -
place_of_establishment
The place of establishment. -
An array of different names for the business. For example, the legal name and the stock-trading name.
Note: You must set at least one
/names/type
toLEGAL
. -
identifications
array (contains the identification object)
An array of identification documents for the business.US only: This field is only required when
type
is set toCORPORATION
,PARTNERSHIP
, orGOVERNMENT
. -
employer_identification_number
string
Deprecated. EIN ID. US only. Usebusiness_info/identifications
for non-US accounts. -
An array of phones for the business. Includes the type, which is
BUSINESS
orWORK
. Requires at least one phone number. -
category
string
The category of the business. Eithermerchant_category_code
or bothcategory
andsub_category
are required. -
sub_category
string
The sub-category of the business. Eithermerchant_category_code
or bothcategory
andsub_category
are required. -
merchant_category_code
string
A merchant category code. Eithermerchant_category_code
or bothcategory
andsub_category
are required. -
date_business_established
The date when the merchant's business was established, in Internet date and timefull-date
format. -
date_of_registration
The date when the business was registered, in Internet date and timefull-date
format. -
dispute_email
The email address to which to send disputes, in Simple Mail Transfer Protocol as defined in RFC 5321 or in Internet Message Format as defined in RFC 5322. Does not support Unicode email addresses. -
vat_id
string
Deprecated. Usebusiness_info/identifications
. -
vat_country_code
Deprecated. Usebusiness_info/identifications
. -
business_sales_details
The details of business sales. -
customer_service
The customer service information. -
An array of merchant addresses.
-
country_code_of_incorporation
The two-character ISO 3166-1 code that identifies the country or region.Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions. -
stakeholders
array (contains the stakeholder object)
An array of business stakeholder information. -
designation
The business owner title and area.
business_name
-
type
enum
required
The legal category of the business. -
name
string
required
The name of the business.
business_owner_info
-
The account holder's email address, in Simple Mail Transfer Protocol as defined in RFC 5321 or in Internet Message Format as defined in RFC 5322. Does not support Unicode email addresses.
-
The account holder's name.
-
account_owner_relationships
array (contains the account_owner_relationship object)
An array of relationships for the account holder. -
The two-character IS0-3166-1 country code of the account holder's country of residence.
-
An array of addresses for the account holder.
-
date_of_birth
The account holder's date of birth, in Internet date and timefull-date
format. SupportsYYYY-MM-DD
. Not required for all countries. -
ssn
string
Deprecated. Social security number. For US account holders only. For non-US accounts, useowner_info/identifications
. -
language_code
string
The language code for the account holder's preferred language. -
phones
array (contains the phone_with_type object)
An array of phone numbers for the account holder. Includes the type, which isHOME
orMOBILE
. -
identifications
array (contains the identification object)
An array of identification documents for the account holder. This field is only required when/business_info/type
is set toINDIVIDUAL
orPROPRIETORSHIP
. When required, this property must contain an identification whosetype
is set toSOCIAL_SECURITY_NUMBER
. -
occupation
string
The account holder's occupation.
business_sales_details
-
average_price
The average transaction price. -
average_monthly_volume
The average volume of monthly sales. -
sales_venues
array (contains the sales_venue object)
An array of sales venues for the business. -
website
string
The primary URL of the business. -
revenue_from_online_sales
The percentage of revenue attributable to online sales.
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 notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
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 notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
create_account
-
The account holder's information.
-
The business information for the merchant.
-
account_status
enum
The account status. -
The three-character ISO-4217 currency code for the account.
-
secondary_currency
array (contains the currency_code object)
An array of the three-character ISO-4217 currency codes for the secondary currencies. -
payment_receiving_preferences
The account preferences for receipt of payments. -
An array of account relationships.
-
account_permissions
array (contains the account_permissions object)
An array of permissions to assign to the account. -
timezone
enum
The time zone. -
partner_merchant_external_id
string
An ID that the partner creates for the managed account. -
loginable
boolean
Indicates whether the account allows the merchant to log in. -
partner_tax_reporting
boolean
Indicates whether the partner reports taxes for the account. -
signup_options
The options, preferences, and agreements for the account. -
financial_instruments
An array of financial instruments.
create_account_response
-
payer_id
string
The payer ID. If the account was not created, this value is blank. -
partner_merchant_external_id
string
The partner-specified ID for the account, which was passed in thepartner_merchant_external_id
request parameter. -
merchant_authorization_code
string
The merchant authorization code. -
custom_data
array (contains the keyvalue object)
An array of key-and-value pairs that contain custom data. For example,aa_token
. -
errors
array (contains the error object)
An array of errors, if any, that occurred during account creation. -
links
array (contains the link_description object)
An array of request-related HATEOAS links.
currency_code
-
currency_code
string
The three-character ISO-4217 currency code that identifies the currency.
currency_code
-
currency_code
string
The three-character ISO-4217 currency code that identifies the currency.
customer_service
-
The business's customer service email address, in Simple Mail Transfer Protocol as defined in RFC 5321 or in Internet Message Format as defined in RFC 5322. Does not support Unicode email addresses.
-
phone
The customer service phone number for the business. -
message
array (contains the customer_service_message object)
An array of customer service messages.
customer_service_message
-
type
enum
required
The type of customer service message. -
headline
string
The headline. -
logo_image_url
string
The logo image URL. -
service_image_url
string
The service image URL. -
seller_message
string
required
The seller message.
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 standarddate_time
type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
designation
-
title
string
The business owner title. -
business_area
string
The organizational unit that corresponds to the specific business segment or area of responsibility in a company.
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.
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 that is used for correlation purposes. -
information_link
string
The information link, or URI, that shows detailed information about this error for the developer. -
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.
error_details
-
field
string
The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. 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 isbody
,path
, orquery
. -
issue
string
required
The unique and fine-grained application-level error code. -
description
string
The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value.
financial_instrument
-
type
enum
The financial instrument type. Currently supportsBANK
only. The possible values are:. The financial instrument type. Currently supports
BANK
only.
-
id
string
The PayPal-generated financial instrument ID. -
account_type
enum
required
The bank account type. The possible values are:. The bank account type.
. The bank account type.
-
id
string
The PayPal-generated ID for the bank account. -
last_4_digits
string
The last four digits of bank account number. -
account_number
string
required
The account number in either:- The International Bank Account Number (IBAN) format.
- Basic Bank Account Number (BBAN) format. Maximum length is 17 characters.
-
account_number_type
enum
required
The type of bank account number. The possible values are:BASIC_BANK_ACCOUNT_NUMBER
. A Basic Bank Account Number (BBAN).INTERNATIONAL_BANK_ACCOUNT_NUMBER
. An International Bank Account Number (IBAN).WIRE
. A wire bank account number.
-
account_type
enum
The type of bank account. The possible values are:SAVINGS
. A savings account.CHECKING
. A checking account.
-
routing_number
string
The routing transit number, or bank code, of the bank. Typically used for domestic accounts only. For international accounts, the IBAN includes the bank code. -
bic
string
The bank identification code (BIC) for countries that support BIC. -
currency_code
The three-character ISO-4217 currency code that identifies the currency. -
country_code
The two-character ISO 3166-1 code that identifies the country or region.Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions. -
account_holder_details
The details for the account holder who owns the bank account. -
branch_code
string
The branch code of the bank account. -
bank_name
string
The name of the bank. -
branch_location
string
The branch location of the bank.
financial_instruments
-
financial_instruments
array (contains the financial_instrument object)
An array of financial instruments.
get_merchant_account_balance_response
-
payer_id
An immutable account identifier which identifies the PayPal account. -
available_balances
array (contains the money object)
This field contains the total available balances based on currency. -
pending_balances
array (contains the money object)
This field contains the total pending reversal balances based on currency.
get_merchant_account_response
-
owner_info
The account holder's information. -
business_info
The business information for the merchant. -
account_status
The account status. -
account_currency
The currency code for the account. -
secondary_currency
array (contains the currency_code object)
An array of secondary currencies. In addition to the account currency, the managed account can accept transactions in other currencies. -
payment_receiving_preferences
The account preferences for receipt of payments. -
account_relations
array (contains the account_relations object)
An array of account relationships between the parent and this account. -
account_permissions
array (contains the account_permissions object)
An array of permissions to assign to the account. -
timezone
The time zone. -
partner_merchant_external_id
string
An ID that the partner creates for the managed account.Note: You cannot fetch this information.
-
loginable
boolean
Indicates whether the account enables the merchant to log in. You cannot log in to accounts that are only managed by their parent. -
partner_tax_reporting
boolean
Indicates whether the partner reports taxes for the account.Note: You cannot fetch this information.
-
signup_options
The partner options to assign to the managed account. -
errors
array (contains the error object)
An array of errors for adding bundles to a given customer account. -
links
array (contains the link_description object)
An array of request-related HATEOAS links.
government_body
-
name
string
The name of enabling legislation.
identification
-
type
enum
required
The type of document to use for identification. -
value
string
required
The document number. -
masked
boolean
Indicates whether the value is a partial value. Use when the identifier type supports a partial value, such as a four-digit SSN number, instead of the full nine digits. This flag may not always be honored based on the context in which it is used. -
issuer_country_code
string
required
The two-character IS0-3166-1 country code of the country that issued the identity document. -
issuer_state
string
The state or province code for the state or province that issued the identity document. -
issuer_city
string
The city that issued the identity document. Applies only to certain types of documents, such astrade_registration_number
documents. -
place_of_issue
string
The name of the place that issued the identity document. Applies only to some types, such asTAX_ID
for Turkey (TR
). -
issuer_description
string
A description of the entity that issued the identity document. For example,registration authority
.
keyvalue
-
key
string
A key. For exampleaa_token
. -
value
string
The value of the key.
legal_agreement
-
accepted
boolean
required
Indicates whether the merchant accepted the legal agreement. -
type
enum
required
The type of legal agreement between the merchant and partner.
link_description
-
href
string
required
The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the$
,(
, and)
characters. Thehref
is the key HATEOAS component that links a completed call with a subsequent call. -
rel
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. -
method
enum
The HTTP method required to make the related call.
money
-
The three-character ISO-4217 currency code that identifies the currency.
-
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.
- An integer for currencies like
name
-
prefix
string
The prefix, or title, to the party's name. -
given_name
string
When the party is a person, the party's given, or first, name. -
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. -
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. -
suffix
string
The suffix for the party's name. -
alternate_full_name
string
DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business. -
full_name
string
When the party is a person, the party's full name.
name_validation
-
name_validation
notification_options
-
suppress_welcome_email
boolean
Indicates whether to suppress the welcome email. By default, a welcome email is sent. To suppress the welcome email, set toTRUE
. -
ipn_notify_url
string
The URL to post an IPN notification. -
reminder_email_frequency
enum
The frequency with which the reminder email is sent to the PayPal user after he or she creates an account. Value is:DEFAULT
. All reminder emails are sent.NONE
. No reminder emails are sent.
partner_options
-
partner_fields
array (contains the keyvalue object)
An array of key-and-value pairs that contain custom partner information.
patch
-
op
enum
required
The operation to complete. -
path
string
The JSON pointer to the target document location at which to complete the operation. -
value
number,integer,string,boolean,null,array,object
The value to apply. Theremove
operation does not require a value. -
from
string
The JSON pointer to the target document location from which to move the value. Required for themove
operation.
patch_request
-
patch_request
array (contains the patch object)
An array of JSON patch objects to apply partial updates to resources.
payer_id
-
payer_id
string
The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.
payment_receiving_preferences
-
block_unconfirmed_us_address_payments
boolean
Indicates whether to block payments to this account from US buyers who do not provide a confirmed shipping address. To block, set toTRUE
. -
block_non_us_payments
boolean
Indicates whether to block payments to this account from buyers who reside outside of the United States. To block, set toTRUE
. -
block_echeck_payments
boolean
Indicates whether to block eCheck payments. To block, set toTRUE
. -
block_cross_currency_payments
boolean
Indicates whether to block payments made in currencies that are not held by this account. To block, set toTRUE
. -
block_send_money_payments
boolean
Indicates whether to block payments to this account from the PayPal Send Money page. To block, set toTRUE
. -
alternate_payment_url
string
The alternative payments URL to use in place of the PayPal Send Money page. If you enableblock_send_money_payments
, specify an alternative payments URL to redirect a user who clicks Send Money. -
display_instructions_text_input
boolean
Indicates whether to show the Special instructions to merchant field during checkout, unless the field is suppressed through other means. To display special instructions, set toTRUE
. -
cc_soft_descriptor
string
The name of the campaign that appears on the buyer’s bank or credit card statement. Supports only capital letters, numbers, spaces, and the.
,-
, and*
special characters. Include one alphanumeric character with special characters. -
cc_soft_descriptor_extended
string
The name of the business that appears on the buyer’s bank or credit card statement. Supports only capital letters, numbers, spaces, and the.
,-
, and*
special characters. Include one alphanumeric character with special characters.
percent_range
-
minimum_percent
number
required
The minimum inclusive value of the range. -
maximum_percent
number
required
The maximum inclusive value of the range.
permissions
-
permissions
enum
A permission type to assign to the account.
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). -
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). -
extension_number
string
The extension number.
phone_with_type
-
type
enum
required
The type of phone. -
country_code
string
required
The country calling code (CC), as defined by the E.164 numbering plan. The combined length of the country code and the national number cannot exceed 15 digits. -
national_number
string
required
The national number, as defined by the E.164 numbering plan. The combined length of of the country code and the national number cannot exceed 15 digits. The national number consists of national destination code (NDC) and subscriber number (SN). -
extension_number
string
The extension number.
place_of_birth
-
country_code
The two-character IS0-3166-1 country code for the country of residence. -
city
string
The city of birth.
place_of_establishment
-
state
string
The state or territory of the government body with which the business was established. -
country_code
The two-character IS0-3166-1 country code of the country where the business was established.
sales_venue
-
type
enum
The type of sales venue for the business. -
ebay_id
string
The eBay ID. -
description
string
The description of the business sales venue.
signup_options
-
partner_options
The partner-specific options for the account. -
legal_agreements
array (contains the legal_agreement object)
An array of legal agreements. -
web_experience_preference
The web experience preferences for the customer. -
notification_options
The notification options.
stakeholder
-
ownership_percentage
string
The percentage ownership for a stakeholder. Pertains only to theBENEFICIAL_OWNER
type. -
type
enum
The type of stakeholder in the business. -
country_code_of_nationality
The two-character IS0-3166-1 country code of the country of residence. -
date_of_birth
The date of birth, in Internet date and timefull-date
format. Supports theYYYY-MM-DD
format. -
name
The name of the stakeholder. -
addresses
array (contains the address object)
An array of stakeholder addresses. -
phones
array (contains the phone_with_type object)
An array of stakeholder phone numbers. Includes phone type. -
identifications
array (contains the identification object)
An array of stakeholder identification documents. -
place_of_birth
The place of birth.
timezone
-
timezone
enum
The time zone.
web_experience_preference
-
partner_logo_url
string
The partner logo URL to show in the seller onboarding flow. -
return_url
string
The URL to which to redirect the customer upon completion of the onboarding process. -
return_url_description
string
The description of the return URL. -
action_renewal_url
string
Ifrenew_action_url
expires, redirect the customer to this URL. -
show_add_credit_card
boolean
Indicates whether to show an add credit card page. -
show_mobile_confirm
boolean
Indicates whether to ask the customer to initiate confirmation of their mobile phone. This phone is the one that the partner defined asMOBILE
in the customer data. Default isfalse
. -
use_mini_browser
boolean
Indicates whether to provide a single page signup flow in a mini browser. Default isfalse
, which provides a full-size, multi-page flow. -
use_hua_email_confirmation
boolean
Indicates whether to use thehosted_user_agreement_url
to confirm the customer's email address. IfTRUE
, PayPal appends the email confirmation code tohosted_user_agreement_url
. When a customer successfully accesses the hosted user agreement URL, PayPal confirms the customer's email address. Iffalse
, PayPal does not append the confirmation code to the URL and does not confirm the email address.
Additional API information
Error messages
In addition to common HTTP status codes that the REST APIs return, the Managed Accounts API can return the following errors.