Create managed account
POST {{base_url}}/v3/customer/managed-accounts
Creates a managed account. Submit the account information in the JSON request body.
The details on what information is required for different business types in different countries can be found on PayPal Developer Portal .
Paypal Sandbox also provides simulators for API samples. Simulator is an alternative of the actual vendor. It will return certain types of responses based on input with special flags, rather than calling vendor to trigger Third Party Verification, such as Know Your Customer (KYC) verification.
For example,
201 - [US/Need More Data/EKYC Failed] Create Account
and
201 - [EU/FR/Need More Data/EKYC Failed] Create Account
are based on simulator. In sample
201 - [US/Need More Data/EKYC Failed] Create Account
, keyword
LMTNREVIEW
in
given_name
field plus keyword
300
in
individual_owners - addresses - address_line_2
field are the special flags to trigger simulators to make EKYC failed. In sample
201 - [EU/FR/Need More Data/EKYC Failed] Create Account
, the special flags are keyword
LMTNREVIEW
in
given_name
field plus keyword
321
in
business_entity - addresses - address_line_2
field.
The fields and parameters are described on PayPal Developer Portal under Managed Accounts .
Request Body
{"external_id"=>"EXT-{{$timestamp}}", "legal_country_code"=>"US", "organization"=>"{{managed_path_organization}}", "user_id"=>"{{$timestamp}}", "primary_currency_code"=>"USD", "individual_owners"=>[{"names"=>[{"given_name"=>"TONY", "surname"=>"STARK", "type"=>"LEGAL"}], "addresses"=>[{"address_line_1"=>"W 294 STR", "admin_area_2"=>"New York", "postal_code"=>"95014", "country_code"=>"US", "type"=>"HOME"}]}], "business_entity"=>{"type"=>"CORPORATION", "names"=>[{"business_name"=>"STARK INDUSTRY.", "type"=>"LEGAL"}], "registered_business_address"=>{"address_line_1"=>"W 294 STR", "admin_area_2"=>"New York", "postal_code"=>"95014", "country_code"=>"US"}, "phone_numbers"=>[{"country_code"=>"1", "national_number"=>"1", "type"=>"BUSINESS"}], "identification_documents"=>[{"identification_number"=>"32-2124444", "issuing_country_code"=>"US", "type"=>"EMPLOYER_IDENTIFICATION_NUMBER"}], "beneficial_owners"=>{"individuals"=>[{"names"=>[{"given_name"=>"Tom", "surname"=>"Norman", "type"=>"LEGAL"}], "citizenship"=>"US", "addresses"=>[{"address_line_1"=>"W 294 STR", "admin_area_2"=>"New York", "postal_code"=>"95148", "country_code"=>"US", "type"=>"HOME"}], "birth_details"=>{"date_of_birth"=>"1960-01-01"}, "identification_documents"=>[{"identification_number"=>"123-44-6789", "issuing_country_code"=>"US", "type"=>"SOCIAL_SECURITY_NUMBER"}], "percentage_of_ownership"=>"26", "controlling_influence"=>false}, {"names"=>[{"given_name"=>"Mary", "surname"=>"Smoth", "type"=>"LEGAL"}], "citizenship"=>"US", "addresses"=>[{"address_line_1"=>"W 294 STR", "admin_area_2"=>"New York", "postal_code"=>"95148", "country_code"=>"US", "type"=>"HOME"}], "birth_details"=>{"date_of_birth"=>"1960-01-01"}, "identification_documents"=>[{"identification_number"=>"123-54-6789", "issuing_country_code"=>"US", "type"=>"SOCIAL_SECURITY_NUMBER"}], "percentage_of_ownership"=>"35", "controlling_influence"=>false}]}, "office_bearers"=>[{"names"=>[{"given_name"=>"Katy", "surname"=>"Collins", "type"=>"LEGAL"}], "citizenship"=>"US", "addresses"=>[{"address_line_1"=>"W 294 STR", "admin_area_2"=>"New York", "postal_code"=>"22903", "country_code"=>"US", "type"=>"HOME"}], "birth_details"=>{"date_of_birth"=>"1990-01-01"}}, {"names"=>[{"given_name"=>"Donald", "surname"=>"TREASWILLIAMSON", "type"=>"LEGAL"}], "citizenship"=>"US", "addresses"=>[{"address_line_1"=>"W 294 STR", "admin_area_2"=>"New York", "postal_code"=>"29212", "country_code"=>"US", "type"=>"HOME"}], "birth_details"=>{"date_of_birth"=>"1991-05-30"}, "identification_documents"=>[{"identification_number"=>"729265100", "issuing_country_code"=>"US", "type"=>"SOCIAL_SECURITY_NUMBER"}]}], "declarations"=>[{"name"=>"TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER", "value"=>"YES"}]}, "agreements"=>[{"type"=>"TERMS_ACCEPTED", "major_version"=>3, "minor_version"=>3, "accepted_time"=>"2022-09-10T00:00:00Z"}, {"type"=>"PERSONAL_INFORMATION_COLLECTION_CONSENT", "major_version"=>1, "minor_version"=>1, "accepted_time"=>"2022-09-10T00:00:00Z"}]}
HEADERS
| Key | Datatype | Required | Description |
| Content-Type | string | | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. |
| Accept | string | | The Accept header field is used to specify the form of response that can be understand and processed |
| Prefer | string | | (Optional)The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the account_id, external_id, and HATEOAS links. |
| Prefer | string | | (Optional) The server returns a complete resource representation without process_view |
| Prefer | string | | (Optional)The server returns complete resource representation along with process_view which includes policies information along with data/documents requirement to fulfill those. |
| Prefer | string | | (Optional)The server returns complete resource representation along with process_view which includes policies information along with data/documents requirement to fulfill those. |
RESPONSES
status: Created
{"account_id":"4MY356SG3FCXE","legal_country_code":"US","individual_owners":[{"id":"4MY356SG3FCXE","names":[{"given_name":"TONY","surname":"STARK","id":"92UF3ZGS3UP5W","type":"LEGAL"}],"primary_residence":{"address_line_1":"W 294 STR","admin_area_2":"New York","postal_code":"95014","country_code":"US"}}],"business_entity":{"type":"CORPORATION","incorporation_details":{},"names":[{"business_name":"STARK INDUSTRY.","id":"J4PX26PJTPFQ4","type":"LEGAL"}],"registered_business_address":{"address_line_1":"W 294 STR","admin_area_2":"New York","postal_code":"95014","country_code":"US"},"phone_numbers":[{"country_code":"1","national_number":"1","id":"KRHMBYNKS7UN4","type":"BUSINESS"}],"identification_documents":[{"id":"DMMSRVTHX3VCG","identification_number":"****","issuing_country_code":"US","type":"EMPLOYER_IDENTIFICATION_NUMBER"}],"beneficial_owners":{"individuals":[{"id":"2S3NQFCNWFPT6","names":[{"given_name":"Tom","surname":"Norman","id":"TDDMKSF6U3KQ6","type":"LEGAL"}],"citizenship":"US","addresses":[{"address_line_1":"W 294 STR","admin_area_2":"New York","postal_code":"95148","country_code":"US","id":"LUTHHDM33E8SL","type":"HOME"}],"birth_details":{"date_of_birth":"1960-01-01"},"identification_documents":[{"id":"U4MFWBGSVAR62","identification_number":"****","issuing_country_code":"US","type":"SOCIAL_SECURITY_NUMBER"}],"percentage_of_ownership":"26","controlling_influence":false},{"id":"LSDEN2VBCMBKW","names":[{"given_name":"Mary","surname":"Smoth","id":"NTBJ7PUGHVWUW","type":"LEGAL"}],"citizenship":"US","addresses":[{"address_line_1":"W 294 STR","admin_area_2":"New York","postal_code":"95148","country_code":"US","id":"5TXSF6DDAT3TY","type":"HOME"}],"birth_details":{"date_of_birth":"1960-01-01"},"identification_documents":[{"id":"2CTQF3KDR6CKJ","identification_number":"****","issuing_country_code":"US","type":"SOCIAL_SECURITY_NUMBER"}],"percentage_of_ownership":"35","controlling_influence":false}]},"office_bearers":[{"id":"M6WVDN77P3MSL","names":[{"given_name":"Katy","surname":"Collins","id":"2WMEBE3HM2V52","type":"LEGAL"}],"citizenship":"US","addresses":[{"address_line_1":"W 294 STR","admin_area_2":"New York","postal_code":"22903","country_code":"US","id":"QFMUFB6SE7YTU","type":"HOME"}],"birth_details":{"date_of_birth":"1990-01-01"},"role":"CHAIRMAN"},{"id":"JU5PYC7BV27UC","names":[{"given_name":"Donald","surname":"TREASWILLIAMSON","id":"N3JSGCNR2BKB8","type":"LEGAL"}],"citizenship":"US","addresses":[{"address_line_1":"W 294 STR","admin_area_2":"New York","postal_code":"29212","country_code":"US","id":"JEWAZLN6K9U72","type":"HOME"}],"birth_details":{"date_of_birth":"1991-05-30"},"identification_documents":[{"id":"XA2MJA6HQYH2W","identification_number":"****","issuing_country_code":"US","type":"SOCIAL_SECURITY_NUMBER"}]}],"declarations":[{"name":"TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER","value":"YES"}]},"agreements":[{"type":"TERMS_ACCEPTED","accepted_time":"2022-09-10T00:00:00Z"},{"type":"PERSONAL_INFORMATION_COLLECTION_CONSENT","accepted_time":"2022-09-10T00:00:00Z"}],"external_id":"EXT-1682223945","organization":"us","user_id":"1682223945","financial_instruments":{"banks":[{"id":"BA-26M5ZGG62CFK2","last_4_digits":"0882","account_number_type":"BASIC_BANK_ACCOUNT_NUMBER","account_type":"CHECKING","routing_number":"074001048","currency_code":"USD","country_code":"US","account_holder_details":{"name":"STARK INDUSTRY."},"branch_code":"08501","bank_name":"KEY BANK NATIONAL ASSOCIATION"}]},"primary_currency_code":"USD","soft_descriptor":"STARKINDUST","capabilities":[{"name":"RECEIVE_MONEY","status":"ACTIVE"},{"name":"WITHDRAW_MONEY","limits":[{"type":"AMOUNT","unit":"USD","value":"500.00","remaining_value":"500.00"}],"status":"ACTIVE"}],"process_view":{"processes":[{"name":"MANAGED_PATH_BO_VERIFICATION","status":"NEED_MORE_DATA","capabilities":[{"name":"WITHDRAW_MONEY","limits":[{"type":"AMOUNT","unit":"USD","value":"500.00","remaining_value":"500.00"}]}]},{"name":"MANAGED_PATH_KYC","status":"NEED_MORE_DATA","capabilities":[{"name":"WITHDRAW_MONEY","limits":[{"type":"AMOUNT","unit":"USD","value":"500.00","remaining_value":"500.00"}]}]}]},"links":[{"href":"https://api-m.sandbox.paypal.com/v3/customer/managed-accounts/4MY356SG3FCXE","rel":"self","method":"GET"},{"href":"https://api-m.sandbox.paypal.com/v3/customer/managed-accounts/4MY356SG3FCXE","rel":"edit","method":"PATCH"}]}