Adaptive Accounts Developer Guide Last updated: May 2012
PayPal Adaptive Accounts Developer Guide Document Number: 10109.en_US-201205 © 2012 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other trademarks and brands are the property of their respective owners. The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc. Copyright © PayPal. All rights reserved. PayPal S.à r.l. et Cie, S.C.A.
Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 What’s New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Adaptive Account Changes Corresponding for PayPal Version 89.0 . . . . . . . . . . . . . 9 Chapter 1 Introducing Adaptive Accounts . . . . . . . . . . . . . . . 11 Adaptive Accounts Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents CreateWebOptionsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 NameType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 CreateAccount Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 CreateAccount Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 ResponseEnvelope Fields . . . . . . . . . . . .
Contents Chapter 7 GetVerifiedStatus API Operation . . . . . . . . . . . . . . 63 GetVerifiedStatus Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 GetVerifiedStatus Request Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 GetVerifiedStatus Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 GetVerifiedStatus Response Fields . . . . . . . .
Contents 6 May 2012 Adaptive Accounts Developer Guide
Preface PayPal’s Adaptive Accounts API enables your customers to create various kinds of PayPal accounts. Documentation Feedback Help us improve this guide by sending feedback to: documentationfeedback@paypal.
Documentation Feedback 8 May 2012 Adaptive Accounts Developer Guide
What’s New Check out what’s new in the current release. Adaptive Account Changes Corresponding for PayPal Version 89.0 Maintenance release.
Adaptive Account Changes Corresponding for PayPal Version 89.
1 Introducing Adaptive Accounts The Adaptive Accounts API lets you build applications that create PayPal accounts and handle account management. Adaptive Accounts Scenarios The Adaptive Accounts API enables your application to create and verify PayPal accounts. You can also add bank accounts to link to PayPal accounts as funding sources. Consider the following examples. You might create a PayPal account using the Adaptive Accounts APIs as part of the set up for a: marketplace.
1 Introducing Adaptive Accounts Adding Bank Accounts as Funding Sources holder to your website. This greatly reduces the chances of losing customers during the account creation flow. That brings us to the key benefit of Adaptive Accounts: A streamlined account creation and completion process. Research shows that removing barriers from account creation and payment experience increases conversion and improves customer satisfaction.
Introducing Adaptive Accounts Set Funding Sources to Confirmed Status Solo Carte Aurore Carte Bleue Cofinoga 4 étoiles Carte Aura Tarjeta Aurora JCB 1 Set Funding Sources to Confirmed Status If you call the AddBankAccount or AddPaymentCard methods, you can use the SetFundingSourceConfirmed method to set the created funding source to “confirmed”. In certain instances, this will cause the PayPal account status to be set to Verified.
1 Introducing Adaptive Accounts Account Creation Flow The following items correspond to the circled numbers in the diagram: 1. Your site or device sends a CreateAccount request to PayPal on behalf of a potential account holder. 2. PayPal responds with a key and a URL, named the redirectURL, that you use when you direct the person to PayPal. 3. You include the key and redirect your person’s browser to PayPal using the redirectURL.
Introducing Adaptive Accounts Account Creation Flow 1 Your customer enters the password twice and clicks Agree and Continue to create the account. NOT E : By default, redirecting the browser to the returned URL opens the page in a default browser window. You must provide JavaScripts to pop-up the window in a minibrowser or to display it in a lightbox within your browser window.
1 Introducing Adaptive Accounts Account Creation Flow Your customer enters debit or credit card information and clicks Add Card and Continue.
Introducing Adaptive Accounts Account Creation Flow 1 Confirming Account Creation Using a Mobile Phone PayPal can enable your customer to confirm a mobile phone when creating an account for the following countries using the minibrowser flow: Australia, Canada, Spain, France, United Kingdom, Italy, Malaysia, Singapore, and United States. Set CreateAccountRequest.CreateAccountWebOptionsType.
1 Introducing Adaptive Accounts Account Creation Flow Your customer requests a confirmation code by clicking Send SMS, and then clicks Confirm Phone after entering the code in the SMS message. NOT E : The phone number to confirm is the number associated with a debit or credit card for the account, which you set on the Link a debit or credit card page. You cannot change the phone number.
Introducing Adaptive Accounts Account Creation Flow 1 By default, when you redirect your customer’s browser to the URL in the CreateAccount response message, PayPal responds with the following sequence of pages: 1. The Welcome page identifies the information that will be needed to create an account: 2.
1 Introducing Adaptive Accounts Account Creation Flow 3.
Introducing Adaptive Accounts Account Creation Flow NOT E : 1 The account holder can add a credit or debit card now or click Cancel to continue without adding a card. 4. After the person logs on to PayPal and completes the account setup, the person is prompted to return to the URL.
1 22 Introducing Adaptive Accounts Account Creation Flow May 2012 Adaptive Accounts Developer Guide
2 Supported Formats, URLs and HTTP Request Headers Adaptive Accounts Methods Adaptive Accounts provides the following methods: API Operation Description CreateAccount Creates PayPal accounts. AddBankAccount Link bank accounts to PayPal accounts as funding sources. AddPaymentCard Link payment cards to PayPal accounts as funding sources SetFundingSourceConfirmed Set the funding source to confirmed; they may set the account to PayPal Verified status.
2 Supported Formats, URLs and HTTP Request Headers Supported Formats Supported Formats Adaptive Accounts supports both RESTful and SOAP-based web services. When making RESTful calls, you can use the following data formats: XML Name-value pair (NV) JSON HTTP Request Headers Required HTTP Request Headers Header Description X-PAYPAL-SECURITY-USERID Your API username as assigned to you on x.com. X-PAYPAL-SECURITY-PASSWORD Your API password as assigned to you on x.com.
Supported Formats, URLs and HTTP Request Headers HTTP Request Headers Header Description X-PAYPAL-DEVICE-ID Client’s device ID, such as a mobile device’s IMEI number. This field is required for mobile application and is not used for web application. X-PAYPAL-MERCHANT-REFERRAL-BONUS-ID When creating a Business or Premier account, this header enables the Merchant Referral Bonus invitation. X-PAYPAL-SERVICE-VERSION The version of an API operation to use.
2 26 Supported Formats, URLs and HTTP Request Headers HTTP Request Headers May 2012 Adaptive Accounts Developer Guide
3 CreateAccount API Operation The CreateAccount API operation enables you to create a PayPal account on behalf of a third party. CreateAccount Request The CreateAccountRequest contains the information required to create a PayPal account for a business customer.
3 28 CreateAccount API Operation CreateAccount Request May 2012 Adaptive Accounts Developer Guide
CreateAccount API Operation CreateAccount Request Adaptive Accounts Developer Guide May 2012 3 29
3 CreateAccount API Operation CreateAccount Request CreateAccount Request Fields 30 Field Description accountType xs:string (Required) The type of account to be created. Allowable values are: Personal – Personal account Premier – Premier account Business – Business account address aa:AddressType (Required) The address to be associated with the PayPal account. businessInfo aa:BusinessInfoType This field is required for business account creation.
CreateAccount API Operation CreateAccount Request Field Description mobilePhoneNumber xs:string (Optional) Mobile phone number to be associated with the account. You must specify a value to invoke the mobile confirmation option. createAccountWebOptions aa:CreateAccountWebOptionsType (Required) The URL to which the business redirects the PayPal user for PayPal account setup completion; also used for various other. configuration settings for the web flow.
3 32 CreateAccount API Operation CreateAccount Request Field Description preferredLanguageCode xs:string (Required) The code indicating the language to be associated with the account. What value is allowed depends on the country code passed in the countryCode parameter for the address.
CreateAccount API Operation CreateAccount Request 3 AddressType Fields Field Description line1 xs:string (Required) The street address. line2 xs:string (Optional) The second line of the address. N O TE : This field is required for Brazilian addresses. city xs:string (Required) The city. state xs:string (Optional) The state code. postalCode xs:string (Optional) The zip or postal code. countryCode xs:string (Required) The country code. For allowable values, refer to “Country Codes” on page 69.
3 CreateAccount API Operation CreateAccount Request Field Description businessSubtype aa:businessSubtypeType (Optional) The sub type of the business for which the PayPal account is created. Allowable values are: ENTITY EMANATION ESTD_COMMONWEALTH ESTD_UNDER_STATE_TERRITORY ESTD_UNDER_FOREIGH_COUNTY INCORPORATED NON_INCORPORATED businessType aa:businessType (Required) The type of the business for which the PayPal account is created.
CreateAccount API Operation CreateAccount Request Field Description customerServicePhone xs:string The phone number for the customer service department of the business. Required for United States business accounts; otherwise, optional. dateOfEstablishment xs:date The date of establishment for the business.
3 CreateAccount API Operation CreateAccount Request Field Description salesVenue aa:salesVenueType The venue type for sales. Required for business accounts in all countries except Czech Republic and Australia. Allowable values are: WEB EBAY OTHER_MARKETPLACE OTHER I MP O R TAN T : salesVenueDesc xs:string A description of the sales venue. Required if salesVenue is OTHER for all countries except Czech Republic and Australia.
CreateAccount API Operation CreateAccount Request 3 BusinessStakeholderType Fields Field Description address aa:addressType (Optional) The address of the stakeholder in the business for which the PayPal account is created. dateOfBirth xs:date (Optional) The date of birth of the stakeholder in the business. Use YYYYMM-DDZ format; for example 1970-01-01Z. fullLegalName xs:string (Optional) The legal name of the stakeholder in the business for which the PayPal account is created.
3 CreateAccount API Operation CreateAccount Request Field Description showAddCreditCard xs:boolean (Optional) Whether or not to show the Add Credit Card option. true - show the option false - do not show the option (default) showMobileConfirm xs:boolean (Optional) Whether or not to show the mobile confirmation option. true - show the option false - do not show the option (default) This option displays only if you specify a value for mobilePhoneNumber in the CreateAccount request.
CreateAccount API Operation CreateAccount Response 3 RequestEnvelope Fields Field Description detailLevel common:DetailLevelCode (Optional) The level of detail required by the client application for component such as Item, Transaction.
3 CreateAccount API Operation CreateAccount Request Sample Field Description execStatus xs:string The status of the payment. Allowable values: CREATED – The account creation is complete, no redirection for approval necessary. COMPLETED – The account creation request was successful (user redirection for approval required). CREATED PENDING VERIFICATION – The account creation is complete but verification/approval process has not been completed.
CreateAccount API Operation CreateAccount Request Sample 3 en_US PERSONAL testing-2039039@paypal.
3 CreateAccount API Operation CreateAccount Errors 2009-09-03T15:19:12.
CreateAccount API Operation CreateAccount Errors Code Message 580022 Invalid request parameter: accountType address averageMonthlyVolume averagePrice city countryCode line1 line2 state postalCode state businessStakeholder businessSubtype businessType category citizenshipCountryCode city commercialRegistrationLocation companyId contactPhoneNumber currencyCode customerServiceEmail customerServicePhone dateOfBirth dateOfEstablishment Account already exist
3 44 CreateAccount API Operation CreateAccount Errors Code Message Additional Information 580023 The argument is inconsistent with the rest of the request 580027 The parameter is not supported 580029 A required parameter is missing from the request: postalCode state businessStakeholder city countryCode firstName incorporationId lastName line1 postalCode salesVenueDesc state mobilePhoneNumber May 2012 Adaptive Accounts Developer Guide
4 AddBankAccount API Operation The AddBankAccount API operation lets your application set up bank accounts as funding sources for PayPal accounts.
4 AddBankAccount API Operation AddBankAccount Request AddBankAccount Request Fields 46 Field Description accountHolderDateofBirt h xs:date (Optional) The date of birth of the account holder in YYYY-MM-DDZ format, for example 1970-01-01Z. accountId xs:string (Optional) The identification number of the PayPal account for which a bank account is added. You must specify either the accountId or emailAddress for this request. agencyNumber xs:string (Optional) For the Brazil Agency Number.
AddBankAccount API Operation AddBankAccount Request Field Description confirmationType aa:ConfirmationType (Required) Whether PayPal account holders are redirected to PayPal.com to confirm the payment card addition. When you pass NONE for this element, the addition is made without the account holder’s explicit confirmation. If you pass WEB, a URL is returned. Allowable string values are: WEB NONE NOTE: ConfirmationType NONE requires advanced permission levels. You must pass the createAccount key.
4 AddBankAccount API Operation AddBankAccount Response WebOptionsType Fields Field Description cancelUrl xs:string (Optional) The URL to which bank account/payment card holders return when they cancel the bank account addition flow. cancelUrlDescription xs:string (Optional) A description of the cancellation URL. returnUrl xs:string (Optional) The URL to which bank account/payment card holders return after they add the account or payment card.
AddBankAccount API Operation AddBankAccount Response 4 AddBankAccount Response Fields Field Definition execStatus xs:string Execution status for the request. Possible values are: COMPLETED CREATED CREATED PENDING VERIFICATION fundingSourceKey xs:string The key for the funding source to use in subsequent Adaptive Accounts API request messages. redirectURL xs:string The URL to direct the PayPal account holder to redirection after the Add Bank Account web flow is completed.
4 AddBankAccount API Operation AddBankAccount Errors AddBankAccount Errors 50 Variable Description 500000 Framework failure. Retry. 520002 Internal error 520003 Invalid credentials. 550001 User is not allowed to perform this action 560022 Invalid header.
5 AddPaymentCard API Operation The AddPaymentCard API operation lets your application set up credit cards as funding sources for PayPal accounts.
5 AddPaymentCard API Operation AddPaymentCard Request AddPaymentCard Request Fields Field Description accountId xs:string (Optional) The identification number of the PayPal account for which a payment card is added. You must specify either the accountId or emailAddress for this request. billingAddress aa:AddressType (Optional) The element AddressType. See “AddressType Fields” on page 33. cardNumber xs:string (Required) The credit card number.
AddPaymentCard API Operation AddPaymentCard Request Field Description createAccountKey xs:string The createaccount key returned in the CreateAccount response. This parameter is required for calls where the confirmationType is set to NONE. emailAddress xs:string (Optional) The email address for the PayPal account. You must specify either the accountId or emailAddress for this request. expirationDate aa:CardDateType (Optional) The element containing the expiration date for the payment card.
5 AddPaymentCard API Operation AddPaymentCard Request Field Description countryCode xs:string (Required) The country code. For allowable values, refer to “Country Codes” on page 69. NameType Fields Field Description salutation xs:string (Optional) A salutation for the account or payment card holder. firstName xs:string (Required) First name of the account or payment card holder. middleName xs:string (Optional) Middle name of the account or payment card holder.
AddPaymentCard API Operation AddPaymentCard Response Field Description errorLanguage xs:string (Required) The RFC 3066 language in which error messages are returned; by default it is en_US, which is the only language currently supported 5 AddPaymentCard Response AddPaymentCard Response Fields Field Definition execStatus xs:string Execution status for the request.
5 AddPaymentCard API Operation AddPaymentCard Errors ResponseEnvelope Fields Field Description ack common:AckCode Acknowledgment code. Possible values are: Success – Operation completed successfully Failure – Operation failed Warning – warning SuccessWithWarning – Operation completed successfully; however, there is a warning message FailureWithWarning – Operation failed with a warning message build Build number; used only by Developer Technical Support.
AddPaymentCard API Operation AddPaymentCard Errors Variable Description 580022 Request parameter is invalid: Invalid request parameter: billingAddress Invalid request parameter: line1 Invalid request parameter: line2 Invalid request parameter: city Invalid request parameter: state Invalid request parameter: postalCode Invalid request parameters: city, state, postalCode Invalid request parameter: startDate Invalid request parameter: cardType Address for UPS cannot be a PO Box Invali
5 58 AddPaymentCard API Operation AddPaymentCard Errors May 2012 Adaptive Accounts Developer Guide
6 SetFundingSourceConfirmed API Operation The SetFundingSourceConfirmed API operation allows your application to mark a funding source as confirmed, after it is added successfully with AddPaymentCard or AddBankAccount. SetFundingSourceConfirmed Request SetFundingSourceConfirmed Request Fields Field Description accountId xs:string (Optional) The merchant account Id of the PayPal account to which the funding source was added in the AddPaymentCard or AddBankAccount request.
6 SetFundingSourceConfirmed API Operation SetFundingSourceConfirmed Response RequestEnvelope Fields Field Description detailLevel common:DetailLevelCode (Optional) The level of detail required by the client application for component such as Item, Transaction.
SetFundingSourceConfirmed API Operation SetFundingSourceConfirmed Errors 6 SetFundingSourceConfirmed Errors Variable Description 500000 Framework failure. Retry. 520002 Internal error 520003 Invalid credentials. 550001 User is not allowed to perform this action 560022 Invalid header. 560029 The required header is missing from the HTTP request.
6 62 SetFundingSourceConfirmed API Operation SetFundingSourceConfirmed Errors May 2012 Adaptive Accounts Developer Guide
7 GetVerifiedStatus API Operation The GetVerifiedStatus API operation lets you check if a PayPal account status is verified. A PayPal account gains verified status under a variety of circumstances, such as when an account is linked to a verified funding source. Verified status serves to indicate a trust relationship. For more information about account verified status, refer to PayPal.com.
7 GetVerifiedStatus API Operation GetVerifiedStatus Request Field Description matchCriteria xs:string (Required) The criteria that must be matched in addition to emailAddress. Currently, only NAME is supported. Allowable string values are: NAME NONE NOTE: requestEnvelope To use ConfirmationType NONE you must request and be granted advanced permission levels. common:RequestEnvelope (Required) Information common to each API operation, such as the language in which an error message is returned.
GetVerifiedStatus API Operation GetVerifiedStatus Response 7 GetVerifiedStatus Response GetVerifiedStatus Response Fields Field Definition accountStatus xs:string This field returns VERIFIED or UNVERIFIED to indicate the account status. responseEnvelope common:ResponseEnvelope Common response information, including a timestamp and the response acknowledgement status. countryCode xs:string (Required) The country code. For allowable values, refer to “Country Codes” on page 69.
7 GetVerifiedStatus API Operation GetVerifiedStatus Response ResponseEnvelope Fields Field Description ack common:AckCode Acknowledgment code. Possible values are: Success – Operation completed successfully Failure – Operation failed Warning – warning SuccessWithWarning – Operation completed successfully; however, there is a warning message FailureWithWarning – Operation failed with a warning message build Build number; used only by Developer Technical Support.
GetVerifiedStatus API Operation GetVerifiedStatus Errors 7 GetVerifiedStatus Errors Variable Description 500000 There is a system error. 520002 Internal error 520003 Username/password is incorrect. 550001 User is not allowed to perform this action. 560027 The argument value is unsupported. 560029 The required header is missing from the HTTP request. 580001 Invalid Request: User has exceeded call limit set for the API. Personal account is not allowed for the country.
7 68 GetVerifiedStatus API Operation GetVerifiedStatus Errors May 2012 Adaptive Accounts Developer Guide
A Country Codes Below are the country codes for Adaptive Accounts. Countries marked with an asterisk ( * ) are not supported for PayPal Payments Pro and Virtual Terminal.
A 70 Country Codes Country or Region Country or Region Code BRAZIL BR BRITISH INDIAN OCEAN TERRITORY * IO * BRUNEI DARUSSALAM BN BULGARIA BG BURKINA FASO BF CANADA CA CAPE VERDE CV CAYMAN ISLANDS KY CENTRAL AFRICAN REPUBLIC * CF * CHILE CL CHINA CN CHRISTMAS ISLAND * CX * COCOS (KEELING) ISLANDS CC COLOMBIA CO COOK ISLANDS CK COSTA RICA CR CYPRUS CY CZECH REPUBLIC CZ DENMARK DK DJIBOUTI DJ DOMINICA DM DOMINICAN REPUBLIC DO ECUADOR EC EGYPT EG EL SALVADOR
Country Codes Country or Region Country or Region Code FRENCH GUIANA GF FRENCH POLYNESIA PF FRENCH SOUTHERN TERRITORIES TF GABON GA GAMBIA GM GEORGIA GE GERMANY DE GHANA GH GIBRALTAR GI GREECE GR GREENLAND GL GRENADA GD GUADELOUPE GP GUAM GU GUERNSEY GG GUYANA GY HEARD ISLAND AND MCDONALD ISLANDS * HM * HOLY SEE (VATICAN CITY STATE) VA HONDURAS HN HONG KONG HK HUNGARY HU ICELAND IS INDIA IN INDONESIA ID IRELAND IE ISLE OF MAN IM ISRAEL IL ITALY IT J
A 72 Country Codes Country or Region Country or Region Code JORDAN JO KAZAKHSTAN KZ KIRIBATI KI KOREA, REPUBLIC OF KR KUWAIT KW KYRGYZSTAN KG LATVIA LV LESOTHO LS LIECHTENSTEIN LI LITHUANIA LT LUXEMBOURG LU MACAO MO MACEDONIA MK MADAGASCAR MG MALAWI MW MALAYSIA MY MALTA MT MARSHALL ISLANDS MH MARTINIQUE MQ MAURITANIA MR MAURITIUS MU MAYOTTE YT MEXICO MX MICRONESIA, FEDERATED STATES OF FM MOLDOVA, REPUBLIC OF MD MONACO MC MONGOLIA MN MONTENEGRO ME
Country Codes Country or Region Country or Region Code NAMIBIA NA NAURU NR NEPAL * NP * NETHERLANDS NL NETHERLANDS ANTILLES AN NEW CALEDONIA NC NEW ZEALAND NZ NICARAGUA NI NIGER NE NIUE NU NORFOLK ISLAND NF NORTHERN MARIANA ISLANDS MP NORWAY NO OMAN OM PALAU PW PALESTINE PS PANAMA PA PARAGUAY PY PERU PE PHILIPPINES PH PITCAIRN PN POLAND PL PORTUGAL PT PUERTO RICO PR QATAR QA REUNION RE ROMANIA RO RUSSIAN FEDERATION RU RWANDA RW SAINT HELENA SH S
A 74 Country Codes Country or Region Country or Region Code SAINT LUCIA LC SAINT PIERRE AND MIQUELON PM SAINT VINCENT AND THE GRENADINES VC SAMOA WS SAN MARINO SM SAO TOME AND PRINCIPE * ST * SAUDI ARABIA SA SENEGAL SN SERBIA RS SEYCHELLES SC SINGAPORE SG SLOVAKIA SK SLOVENIA SI SOLOMON ISLANDS SB SOUTH AFRICA ZA SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS GS SPAIN ES SURINAME SR SVALBARD AND JAN MAYEN SJ SWAZILAND SZ SWEDEN SE SWITZERLAND CH TAIWAN, PROVINC
Country Codes Country or Region Country or Region Code TURKEY TR TURKMENISTAN TM TURKS AND CAICOS ISLANDS TC TUVALU TV UGANDA UG UKRAINE UA UNITED ARAB EMIRATES AE UNITED KINGDOM GB UNITED STATES US UNITED STATES MINOR OUTLYING ISLANDS UM URUGUAY UY UZBEKISTAN UZ VANUATU VU VENEZUELA VE VIET NAM VN VIRGIN ISLANDS, BRITISH VG VIRGIN ISLANDS, U.S.
A 76 Country Codes May 2012 Adaptive Accounts Developer Guide
B Business Categories and Subcategories Below are the codes for the business categories and subcategories that are passed for the category and subcategory fields in CreateAccount requests for PayPal Business accounts.
B Business Categories and Subcategories Category Description 1024 Vehicle sales 1025 Vehicle service and accessories Subcategories 78 Subcategory Description Category Merchant Category 2000 Antiques 1000 5932 2001 Art and craft supplies 1000 5970 2002 Art dealers and galleries 1000 5971 2003 Camera and photographic supplies 1000 5946 2004 Digital art 1000 5971 2005 Memorabilia 100 5999 2006 Music store (instruments and sheet music) 1000 5733 2007 Sewing, needlework
Business Categories and Subcategories Subcategory Description Category Merchant Category 2026 Advertising 1004 7311 2027 Agricultural 1004 780 2028 Architectural, engineering, and surveying services 1004 8911 2029 Chemicals and allied products 1004 5169 2030 Commercial photography, art, and graphics 1004 7333 2031 Construction 1004 5039 2032 Consulting services 1004 7392 2033 Educational services 1004 8299 2034 Equipment rentals and leasing services 1004 7394 2035 E
B 80 Business Categories and Subcategories Subcategory Description Category Merchant Category 2056 Fashion jewelry 1005 5944 2057 Computer and data processing services 1006 7372 2058 Desktops, laptops, and notebooks 1006 5045 2059 Digital content 1006 5999 2060 eCommerce services 1006 4816 2061 Maintenance and repair services 1006 7379 2062 Monitors and projectors 1006 7379 2063 Networking 1006 4816 2064 Online gaming 1006 7999 2065 Parts and accessories 1006 50
Business Categories and Subcategories Subcategory Description Category Merchant Category 2088 Movies (DVDs, videotapes) 1009 5999 2089 Music (CDs, cassettes and albums) 1009 5735 2090 Cable, satellite, and other pay TV and radio 1009 4899 2091 Adult digital content 1009 5999 2092 Concert tickets 1009 7929 2093 Theater tickets 1009 7922 2094 Toys and games 1009 5945 2095 Slot machines 1009 5999 2096 Digital content 1009 5999 2097 Entertainers 1009 7929 2098 Gambl
B 82 Business Categories and Subcategories Subcategory Description Category Merchant Category 2119 Real estate agent 1010 6513 2120 Remittance 1010 4829 2121 Rental property management 1010 6513 2122 Security brokers and dealers 1010 6211 2123 Wire transfer and money order 1010 4829 2124 Alcoholic beverages 1011 5921 2125 Catering services 1011 5811 2126 Coffee and tea 1011 5499 2127 Gourmet foods 1011 5499 2128 Specialty and miscellaneous food stores 1011 5499
Business Categories and Subcategories Subcategory Description Category Merchant Category 2150 Drapery, window covering, and upholstery 1015 5714 2151 Exterminating and disinfecting services 1015 7342 2152 Fireplace, and fireplace screens 1015 5718 2153 Furniture 1015 5712 2154 Garden supplies 1015 5261 2155 Glass, paint, and wallpaper 1015 5231 2156 Hardware and tools 1015 5251 2157 Home decor 1015 5719 2158 Housewares 1015 5719 2159 Kitchenware 1015 5719 2160 L
B 84 Business Categories and Subcategories Subcategory Description Category Merchant Category 2182 Non-durable goods 1019 5199 2183 Used and secondhand store 1019 5931 2184 Variety store 1019 5331 2185 Advertising 1020 7311 2186 Shopping services and buying clubs 1020 7278 2187 Career services 1020 7361 2188 Carpentry 1020 1750 2189 Child care services 1020 8351 2190 Cleaning and maintenance 1020 2842 2191 Commercial photography 1020 7333 2192 Computer and dat
Business Categories and Subcategories Subcategory Description Category Merchant Category 2213 Legal services and attorneys 1020 8111 2214 Local delivery service 1020 4215 2215 Lottery and contests 1020 8999 2216 Medical care 1020 8011 2217 Membership clubs and organizations 1020 7991 2218 Misc.
B 86 Business Categories and Subcategories Subcategory Description Category Merchant Category 2244 Firearm accessories 1021 5999 2245 Firearms 1021 5999 2246 Hunting 1021 5941 2247 Knives 1021 5941 2248 Martial arts weapons 1021 5941 2249 Sport games and toys 1021 5941 2250 Sporting equipment 1021 5941 2251 Swimming pools and spas 1021 5996 2252 Arts and crafts 1022 5970 2253 Camera and photographic supplies 1022 5946 2254 Hobby, toy, and game shops 1022 594
Business Categories and Subcategories Subcategory Description Category Merchant Category 2275 Auto dealer - new and used 1024 5511 2276 Auto dealer - used only 1024 5521 2277 Aviation 1024 5599 2278 Boat dealer 1024 5551 2279 Mobile home dealer 1024 5271 2280 Motorcycle dealer 1024 5571 2281 Recreational and utility trailer dealer 1024 5561 2282 Recreational vehicle dealer 1024 5561 2283 Vintage and collectibles 1024 5521 2284 New parts and supplies - motor vehicle
B 88 Business Categories and Subcategories May 2012 Adaptive Accounts Developer Guide
C Adaptive Accounts IPN Messages PayPal sends an IPN message whenever a PayPal account is created using the CreateAccount API operation.
C Adaptive Accounts IPN Messages NOT E : This message indicates that the account setup is complete. Example IPN message in response to account login first_name=Someone&account_key=AA6N5043354R131103K¬ify_version=UNVERSIONED&charset=windows1252&email_address=abawany-2011020801%40paypal.com&event_type=%5BLOGIN_CONFIRMED%5D&last_name=Something&verify _sign=ANqF6tuR41eB.S.
Older Versions of the Adaptive Accounts API Unless you specify the version, PayPal defaults to the latest version of an API operation. APIs are backwards compatible with previous versions; however, PayPal recommends that you use the most recent version. Adaptive Account Changes Corresponding to PayPal Version 85.0 This document includes corrections to the explanations of the account creation flow and updates to Adaptive Accounts methods. The 85.
Adaptive Account Changes Corresponding to PayPal Version 69.0 Adaptive Account Changes Corresponding to PayPal Version 69.0 Version 1.0.3 of Adaptive Accounts corresponds to Release 69.0 of the PayPal API. It includes the following changes to the minibrowser account creation feature and adds a supporting field in the CreateWebOptionsType structure: Enhanced the minibrowser account creation flow to optionally include adding a bank card with a shipping address and confirmed phone number.
Adaptive Account Changes Corresponding to PayPal Version 62.2 Ability to have PayPal perform extra vetting before activating an account (new performExtraVettingOnThisAccount parameter in CreateAccount). Support for Merchant Referral Bonus functionality for CreateAccount (Business/Premier accounts only) via the new HTTP request header X-PAYPALMERCHANT-REFERRAL-BONUS-ID.
Adaptive Account Changes Corresponding to PayPal Version 62.
Revision History Revision history for Adaptive Accounts Service documentation. Date Description 5/2/12 Maintenance release. 12/09/11 Corrections and updates corresponding to modifications and changes through release 85, including new fields in the GetVerifiedStatus API. 02/23/11 Updated information about the account creation minibrowser flow for version 1.0.3, corresponding to release 69. 08/12/10 Added information about merchant referral bonus invitations.
May 2012 Adaptive Accounts Developer Guide
Index A Account creation, adding credit card 15 Account creation, default 19 Account creation, using minibrowser 14 accountHolderDateofBirth request field 46 accountId request field 46, 52, 59 accountId response field 39 accountStatus response field 65 accountType request field 30, 66 ack response field 40, 49, 56, 60, 66 AddBankAccount API operation 45 AddBankAccount request fields 46 AddBankAccount request message 45 AddBankAccount response fields 49 AddBankAccount response message 48 AddPaymentCard requ
Index D dateOfBirth request field 31, 37 dateOfEstablishment request field 35 detailLevel request field 39, 48, 54, 60, 64 disputeEmail request field 35 doingBusinessAs request field 35 E emailAddress request field 31, 47, 53, 59, 63, 66 errorLanguage request field 39, 48, 55, 60, 64 establishmen tCountryCode request field 35 establishmentState request field 35 execStatus response field 40 execstatus response field 49, 55 expirationDate request field 53 line1 request field 33, 53 line2 request field 33,
Index salesVenueDesc request field 36 SetFundingSourceConfirmed API operation 59 SetFundingSourceConfirmed request fields 59 SetFundingSourceConfirmed request message 59 SetFundingSourceConfirmed response message 60 showAddCreditCard request field 38 showMobileConfirm request field 38, 92 sortCode request field 47 startDate request field 53 state request field 33, 53 subcategory request field 36 suffix request field 38, 54 T taxId field 31 taxIdNumber 47 taxIdType 47 timestamp response field 40, 49, 56, 6
Index 100 May 2012 Adaptive Accounts Developer Guide
