Qodex.ai

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.

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", "incorporation_details"=>{}, "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"}, "role"=>"CHAIRMAN"}, {"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

KeyDatatypeRequiredDescription
Content-TypestringThe 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.
AcceptstringThe Accept header field is used to specify the form of response that can be understand and processed
Preferstring(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.
Preferstring(Optional) The server returns a complete resource representation without process_view
Preferstring(Optional)The server returns complete resource representation along with process_view which includes policies information along with data/documents requirement to fulfill those.
Preferstring(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":"Z8NDBF9HHU3GG","legal_country_code":"FR","individual_owners":[{"id":"Z8NDBF9HHU3GG","names":[{"given_name":"TONY","surname":"MALLUWA","id":"RLKLC36X8NTRS","type":"LEGAL"}],"citizenship":"FR","primary_residence":{"address_line_1":"100 W STREET","admin_area_2":"Paris ","postal_code":"75012","country_code":"FR"},"birth_details":{"date_of_birth":"1990-01-01"}}],"business_entity":{"type":"CORPORATION","merchant_category_code":"7929","incorporation_details":{"incorporation_country_code":"FR"},"names":[{"business_name":"MONSIEUR PHILIPPE INDUSTRY.","id":"R4SURMLBMV3GU","type":"LEGAL"}],"registered_business_address":{"address_line_1":" W 100 STR","admin_area_2":"Anglet","postal_code":"64600","country_code":"FR"},"phone_numbers":[{"country_code":"33","national_number":"0603494746","id":"MDCTUDY57S3G6","type":"CUSTOMER_SERVICE"}],"identification_documents":[{"id":"4M7ADUYDGJFY8","identification_number":"****","issuing_country_code":"FR","type":"BUSINESS_REGISTRATION_NUMBER"}],"beneficial_owners":{"individuals":[{"id":"TKDAFNEJWZ6NJ","names":[{"given_name":"Katy","surname":"Norman","id":"4XAD2D78QUVPL","type":"LEGAL"}],"citizenship":"US","addresses":[{"address_line_1":"N 100 STR","admin_area_2":"New York ","postal_code":"95148","country_code":"US","id":"8UAW5SWWV4URU","type":"HOME"}],"birth_details":{"date_of_birth":"1960-01-01"},"percentage_of_ownership":"26","controlling_influence":false},{"id":"KC73SAUTHTN4C","names":[{"given_name":"LISA","surname":"Smoth","id":"28374PHKSE7VS","type":"LEGAL"}],"citizenship":"FR","addresses":[{"address_line_1":"W 100 STR","admin_area_2":"Anglet","postal_code":"64600","country_code":"FR","id":"8CAFJQK6D72LG","type":"HOME"}],"birth_details":{"date_of_birth":"1970-01-01"},"percentage_of_ownership":"35","controlling_influence":false}]},"office_bearers":[{"id":"62UZQUJGEENG2","names":[{"given_name":"Malin","surname":"Collins","id":"CMNZ4HR5AD77U","type":"LEGAL"}],"citizenship":"FR","addresses":[{"address_line_1":"X 100 STR","admin_area_2":"Paris","postal_code":"64600","country_code":"FR","id":"5UUJ4WESYRKWY","type":"HOME"}],"birth_details":{"date_of_birth":"1990-01-01"},"role":"CHAIRMAN"},{"id":"K49AVSFLANAF8","names":[{"given_name":"Shamula","surname":"TREASWILLIAMSON","id":"XTNFA3F7DT7HA","type":"LEGAL"}],"citizenship":"US","addresses":[{"address_line_1":"N 100 STR","admin_area_2":"New York","postal_code":"29212","country_code":"US","id":"S2LFMYY2H72HS","type":"HOME"}],"birth_details":{"date_of_birth":"1991-05-30"}}],"declarations":[{"name":"TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER","value":"YES"}]},"agreements":[{"type":"TERMS_ACCEPTED","accepted_time":"2022-09-10T00:00:00Z"}],"external_id":"EXT-1682045820","organization":"us","user_id":"1682045820","financial_instruments":{"banks":[{"id":"BA-LSW2HBYXX4F5A","last_4_digits":"6690","account_number_type":"INTERNATIONAL_BANK_ACCOUNT_NUMBER","account_type":"CHECKING","routing_number":"61262345","currency_code":"EUR","country_code":"DE","account_holder_details":{"name":"Abishak MALLUWA"},"bank_name":"Bernhauser Bank eG","branch_location":"70794 Filderstadt DE"}]},"primary_currency_code":"EUR","soft_descriptor":"MONSIEURPHI","capabilities":[{"name":"RECEIVE_MONEY","status":"ACTIVE"},{"name":"WITHDRAW_MONEY","limits":[{"type":"AMOUNT","unit":"EUR","value":"1000.00","remaining_value":"1000.00"}],"status":"ACTIVE"}],"process_view":{"processes":[{"name":"MANAGED_PATH_CIP_COLLECTION","status":"COMPLETED","capabilities":[{"name":"WITHDRAW_MONEY"},{"name":"RECEIVE_MONEY"}]},{"name":"MANAGED_PATH_KYC","status":"NEED_MORE_DATA","capabilities":[{"name":"WITHDRAW_MONEY","limits":[{"type":"AMOUNT","unit":"EUR","value":"1000.00","remaining_value":"1000.00"}]}],"required":{"op":"ALL_OF","attributes":["$.business_entity.office_bearers[?(@['role']=='DIRECTOR')].citizenship","$.business_entity.office_bearers[?(@['role']=='DIRECTOR')].names[?(@['type']=='LEGAL')]","$.business_entity.office_bearers[?(@['role']=='DIRECTOR')].birth_details.date_of_birth"]}}]},"links":[{"href":"https://api-m.sandbox.paypal.com/v3/customer/managed-accounts/Z8NDBF9HHU3GG","rel":"self","method":"GET"},{"href":"https://api-m.sandbox.paypal.com/v3/customer/managed-accounts/Z8NDBF9HHU3GG","rel":"edit","method":"PATCH"}]}