{"title":"Integration and go-live checklist","category":"default","creationDate":1557888420,"content":"<div class=\"additional-info-block output-inline\">\n<h5 class=\"article__heading additional-info-block__title\">Adyen APIs Postman collections<\/h5><div class=\"additional-info-block__body\"><p><img style=\"width: 20px;\" alt=\"\" src=\"\/user\/pages\/reuse\/pfs-general\/link-to-postman-collections\/postman-icon.svg?decoding=auto&amp;fetchpriority=auto\" \/> Fork our <a href=\"https:\/\/www.postman.com\/adyendev\/workspace\/adyen-apis\/overview\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Postman collections<\/a> in your private workspace to start testing API calls with your own credentials.<\/p><\/div><\/div>\n\n<p>On this page, you can learn about the steps required to integrate Adyen's payment processing capabilities to your marketplace, and how to take your integration live.<\/p>\n<p>Before you start building your integration, make sure that you have already <a href=\"\/pt\/marketplaces\/get-started#design-implementation\">designed your implementation<\/a> with your Adyen implementation manager.<\/p>\n<p>Not yet in touch with Adyen? <a href=\"https:\/\/www.adyen.com\/contact\/sales\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Contact us<\/a> to register your interest for Adyen for Platforms.<\/p>\n<h2>Review your account structure<\/h2>\n<p>Before you start the integration process, you must be familiar with the Adyen account structure. You\u2019ll need this information when building the different parts of your implementation.<\/p>\n<p>Every Adyen for Platforms integration must have at least the following resource types:<\/p>\n<ul>\n<li><strong>Company account<\/strong>: Represents your core business entity and holds your merchant accounts.<\/li>\n<li><strong>Merchant account<\/strong>: The account where we process payments for your users. You can have multiple merchant accounts.\n<\/li>\n<li><strong>Balance platform<\/strong>: The accounting system in which you manage your users and funds.<\/li>\n<li><strong>Account holder<\/strong>: Specifies what your user can do in your platform, for example, receive fund transfers to their balance account and payouts to their verified transfer instrument (bank account).<\/li>\n<li><strong>Balance account<\/strong>: Holds the funds of your user or your platform. All financial activities in your platform, such as paying out to a bank account, happen through balance accounts.<\/li>\n<li><strong>Legal entity<\/strong>: Contains information about your user, for example, the legal name, address, and tax information of the organization. Adyen uses this information to perform verification checks required by payment industry regulations.<\/li>\n<li><strong>Transfer instrument<\/strong>: Your user's verified bank account where they can receive payouts.<\/li>\n<li><strong>Business line<\/strong>: Contains information about your user's line of business, including their industry and source of funds.<\/li>\n<\/ul>\n<p>For details on the different account structures and example use cases, see <a href=\"\/pt\/marketplaces\/account-structure-resources\/\">Account structures<\/a>.<\/p>\n<h2>Get ready for development<\/h2>\n<p>At the end of this section you should have the API keys and the webhook configuration that you need to start integrating.<\/p>\n<h3>Check out Adyen\u2019s server-side libraries<\/h3>\n<p>Adyen provides <a href=\"\/pt\/development-resources\/libraries\/\">server-side API libraries<\/a> in several languages. Installing a library is not required, but will save you development time, because a library:<\/p>\n<ul>\n<li>Uses the latest API version.<\/li>\n<li>Has generated models and examples to help you construct requests.<\/li>\n<li>Sends the request to Adyen using its built-in HTTP client, so you do not have to create your own.<\/li>\n<\/ul>\n<p>Pick a library in the language of your choice and follow the <a href=\"\/pt\/development-resources\/libraries\">installation instructions<\/a>.<\/p>\n<h3>Generate and test your API keys<\/h3>\n<p>Adyen is an API-first payment service provider, which means that you must integrate with our APIs to build and customize your implementation. You can <a href=\"\/pt\/marketplaces\/manage-access\/api-credentials-web-service\">generate your API credentials<\/a> in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<p>You need credentials for the following APIs:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">API<\/th>\n<th style=\"text-align: left;\">Credential<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Configuration API<\/a><br><br> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfers API<\/a><br><br> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/foreignexchange\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Foreign Exchange API<\/a><br><br> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/sessionauthentication\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Session authentication API<\/a><\/td>\n<td style=\"text-align: left;\"><strong>ws@BalancePlatform.[YourBalancePlatform]<\/strong><\/td>\n<td style=\"text-align: left;\">Use these APIs to create account holders and balance accounts, schedule payouts, transfer funds, make one-off payouts and calculate amounts in different currencies.<br\/><br\/>Use the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/sessionauthentication\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Session authentication API<\/a> with this API credential to create session tokens for integrating <a href=\"\/pt\/marketplaces\/components-overview?tab=after-payment-platform_3\">Platform Experience components<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Legal Entity Management API<\/a><br><br> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/sessionauthentication\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Session authentication API<\/a><\/td>\n<td style=\"text-align: left;\"><strong>ws_[123456]@Scope.Company_[YourCompanyAccount]<\/strong><\/td>\n<td style=\"text-align: left;\">Use the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Legal Entity Management API<\/a> to create and manage legal entities that contain the information required for verification checks.<br\/><br\/>Use the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/sessionauthentication\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Session authentication API<\/a> with this API credential to create session tokens for integrating <a href=\"\/pt\/marketplaces\/components-overview?tab=before-payment-platform_1\">Onboarding components<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Checkout API<\/a><br><br> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Management API<\/a><\/td>\n<td style=\"text-align: left;\"><strong>ws@Company.[YourCompanyAccount]<\/strong><\/td>\n<td style=\"text-align: left;\">Use these APIs to process payments for your users.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>To verify that your test API credentials are working, make your first requests.<\/p>\n\n<div id=\"tabES3WT\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Configuration API&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;Use the API key for your &lt;strong&gt;ws@BalancePlatform.[YourBalancePlatform]&lt;\\\/strong&gt; API credential.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Try it out!&#039;\\&quot; :id=\\&quot;&#039;get-balanceplatform-request&#039;\\&quot; :code-data=\\&quot;[{&amp;quot;language&amp;quot;:&amp;quot;bash&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;curl&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;curl https:\\\\\\\/\\\\\\\/balanceplatform-api-test.adyen.com\\\\\\\/bcl\\\\\\\/v2\\\\\\\/balancePlatforms\\\\\\\/{id} \\\\\\\\\\\\n-H &#039;x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY&#039; \\\\\\\\\\\\n-H &#039;content-type: application\\\\\\\/json&#039; \\\\\\\\\\\\n-X GET&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;java&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Java&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Java API Library v25.0.0\\\\nimport com.adyen.Client;\\\\nimport com.adyen.enums.Environment;\\\\nimport com.adyen.service.balancePlatform.*;\\\\n\\\\nClient client = new Client(\\\\&amp;quot;ADYEN_API_KEY\\\\&amp;quot;, Environment.TEST);\\\\n\\\\\\\/\\\\\\\/ Make the API call\\\\nPlatformApi service = new PlatformApi(client);\\\\nBalancePlatform response = service.getBalancePlatform(\\\\&amp;quot;id\\\\&amp;quot;, null);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;php&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;PHP&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen PHP API Library v17.4.0\\\\nuse Adyen\\\\\\\\Client;\\\\nuse Adyen\\\\\\\\Environment;\\\\nuse Adyen\\\\\\\\Service\\\\\\\\BalancePlatform\\\\\\\\PlatformApi;\\\\n\\\\n$client = new Client();\\\\n$client-&amp;gt;setXApiKey(\\\\&amp;quot;ADYEN_API_KEY\\\\&amp;quot;);\\\\n$client-&amp;gt;setEnvironment(Environment::TEST);\\\\n\\\\n\\\\\\\/\\\\\\\/ Make the API call\\\\n$service = new PlatformApi($client);\\\\n$response = $service-&amp;gt;getBalancePlatform(&#039;id&#039;);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;cs&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;C#&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen .net API Library v14.4.0\\\\nusing Adyen;\\\\nusing Environment = Adyen.Model.Environment;\\\\nusing Adyen.Service.BalancePlatform;\\\\n\\\\nvar config = new Config()\\\\n{\\\\n    XApiKey = \\\\&amp;quot;ADYEN_API_KEY\\\\&amp;quot;,\\\\n    Environment = Environment.Test\\\\n};\\\\nvar client = new Client(config);\\\\n\\\\n\\\\\\\/\\\\\\\/ Make the API call\\\\nvar service = new PlatformService(client);\\\\nvar response = service.GetBalancePlatform(\\\\&amp;quot;id\\\\&amp;quot;);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;js&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (JavaScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v16.2.0\\\\n\\\\\\\/\\\\\\\/ Require the parts of the module you want to use\\\\nconst { Client, BalancePlatformAPI } = require(&#039;@adyen\\\\\\\/api-library&#039;);\\\\n\\\\\\\/\\\\\\\/ Initialize the client object\\\\nconst client = new Client({apiKey: \\\\&amp;quot;ADYEN_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot;});\\\\n\\\\n\\\\\\\/\\\\\\\/ Make the API call\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.PlatformApi.getBalancePlatform(\\\\&amp;quot;id\\\\&amp;quot;);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;go&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Go&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Go API Library v9.3.0\\\\nimport (\\\\n  \\\\&amp;quot;context\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v9\\\\\\\/src\\\\\\\/common\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v9\\\\\\\/src\\\\\\\/adyen\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v9\\\\\\\/src\\\\\\\/balancePlatform\\\\&amp;quot;\\\\n)\\\\nclient := adyen.NewClient(&amp;amp;common.Config{\\\\n  ApiKey:      \\\\&amp;quot;ADYEN_API_KEY\\\\&amp;quot;,\\\\n  Environment: common.TestEnv,\\\\n})\\\\n\\\\n\\\\\\\/\\\\\\\/ Make the API call\\\\nservice := client.BalancePlatform()\\\\nreq := service.PlatformApi.GetBalancePlatformInput(\\\\&amp;quot;id\\\\&amp;quot;)\\\\nres, httpRes, err := service.PlatformApi.GetBalancePlatform(context.Background(), req)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;py&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Python&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Python API Library v12.2.0\\\\nimport Adyen\\\\n\\\\nadyen = Adyen.Adyen()\\\\nadyen.client.xapikey = \\\\&amp;quot;ADYEN_API_KEY\\\\&amp;quot;\\\\nadyen.client.platform = \\\\&amp;quot;test\\\\&amp;quot; # The environment to use library in.\\\\n\\\\n# Make the API call\\\\nresult = adyen.balancePlatform.platform_api.get_balance_platform(id=\\\\&amp;quot;id\\\\&amp;quot;)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;rb&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Ruby&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Ruby API Library v9.3.0\\\\nrequire \\\\&amp;quot;adyen-ruby-api-library\\\\&amp;quot;\\\\n\\\\nadyen = Adyen::Client.new\\\\nadyen.api_key = &#039;ADYEN_API_KEY&#039;\\\\nadyen.env = :test # Set to \\\\&amp;quot;live\\\\&amp;quot; for live environment\\\\n\\\\n# Make the API call\\\\nresult = adyen.balancePlatform.platform_api.get_balance_platform(&#039;id&#039;)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;ts&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (TypeScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v16.2.0\\\\n\\\\\\\/\\\\\\\/ Require the parts of the module you want to use\\\\nimport { Client, BalancePlatformAPI, Types } from \\\\&amp;quot;@adyen\\\\\\\/api-library\\\\&amp;quot;;\\\\n\\\\\\\/\\\\\\\/ Initialize the client object\\\\nconst client = new Client({apiKey: \\\\&amp;quot;ADYEN_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot;});\\\\n\\\\n\\\\\\\/\\\\\\\/ Make the API call\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.PlatformApi.getBalancePlatform(\\\\&amp;quot;id\\\\&amp;quot;);&amp;quot;}]\\&quot; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;p&gt;If the call was successful, you receive an &lt;strong&gt;HTTP 200&lt;\\\/strong&gt; result code along with the &lt;code&gt;id&lt;\\\/code&gt; and &lt;code&gt;status&lt;\\\/code&gt; of your balance platform.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Response&#039;\\&quot; :id=\\&quot;&#039;get-balanceplatform-response&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n    \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;YOUR_BALANCE_PLATFORM_ID\\\\\\&quot;,\\\\n    \\\\\\&quot;status\\\\\\&quot;: \\\\\\&quot;Active\\\\\\&quot;\\\\n}\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;configuration_api_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Legal Entity Management API&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;Use the API key for your &lt;strong&gt;ws_[123456]@Scope.Company_[YourCompanyAccount]&lt;\\\/strong&gt; API credential.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Try it out!&#039;\\&quot; :id=\\&quot;&#039;create-legalEntity-individual-request&#039;\\&quot; :code-data=\\&quot;[{&amp;quot;language&amp;quot;:&amp;quot;bash&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;curl&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;curl https:\\\\\\\/\\\\\\\/kyc-test.adyen.com\\\\\\\/lem\\\\\\\/v3\\\\\\\/legalEntities \\\\\\\\\\\\n-H &#039;x-api-key: ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY&#039; \\\\\\\\\\\\n-H &#039;content-type: application\\\\\\\/json&#039; \\\\\\\\\\\\n-X POST \\\\\\\\\\\\n-d &#039;{\\\\n    \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;individual\\\\&amp;quot;,\\\\n    \\\\&amp;quot;individual\\\\&amp;quot;: {\\\\n      \\\\&amp;quot;residentialAddress\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;city\\\\&amp;quot;: \\\\&amp;quot;San Francisco\\\\&amp;quot;,\\\\n        \\\\&amp;quot;country\\\\&amp;quot;: \\\\&amp;quot;US\\\\&amp;quot;,\\\\n        \\\\&amp;quot;postalCode\\\\&amp;quot;: \\\\&amp;quot;94678\\\\&amp;quot;,\\\\n        \\\\&amp;quot;stateOrProvince\\\\&amp;quot;: \\\\&amp;quot;CA\\\\&amp;quot;,\\\\n        \\\\&amp;quot;street\\\\&amp;quot;: \\\\&amp;quot;Brannan Street\\\\&amp;quot;,\\\\n        \\\\&amp;quot;street2\\\\&amp;quot;: \\\\&amp;quot;274\\\\&amp;quot;\\\\n      },\\\\n      \\\\&amp;quot;phone\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;number\\\\&amp;quot;: \\\\&amp;quot;+14153671502\\\\&amp;quot;,\\\\n        \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;mobile\\\\&amp;quot;\\\\n      },\\\\n      \\\\&amp;quot;name\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;firstName\\\\&amp;quot;: \\\\&amp;quot;Simone\\\\&amp;quot;,\\\\n        \\\\&amp;quot;lastName\\\\&amp;quot;: \\\\&amp;quot;Hopper\\\\&amp;quot;\\\\n      },\\\\n      \\\\&amp;quot;birthData\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;dateOfBirth\\\\&amp;quot;: \\\\&amp;quot;1981-12-01\\\\&amp;quot;\\\\n      },\\\\n      \\\\&amp;quot;email\\\\&amp;quot;: \\\\&amp;quot;s.hopper@example.com\\\\&amp;quot;\\\\n    }\\\\n}&#039;&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;java&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Java&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Java API Library v33.0.0\\\\nimport com.adyen.Client;\\\\nimport com.adyen.enums.Environment;\\\\nimport com.adyen.model.legalentitymanagement.*;\\\\nimport java.time.OffsetDateTime;\\\\nimport java.util.*;\\\\nimport com.adyen.service.legalEntityManagement.*;\\\\n\\\\nClient client = new Client(\\\\&amp;quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\\\&amp;quot;, Environment.TEST);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nPhoneNumber phoneNumber = new PhoneNumber()\\\\n  .number(\\\\&amp;quot;+14153671502\\\\&amp;quot;)\\\\n  .type(\\\\&amp;quot;mobile\\\\&amp;quot;);\\\\n\\\\nAddress address = new Address()\\\\n  .country(\\\\&amp;quot;US\\\\&amp;quot;)\\\\n  .stateOrProvince(\\\\&amp;quot;CA\\\\&amp;quot;)\\\\n  .city(\\\\&amp;quot;San Francisco\\\\&amp;quot;)\\\\n  .street(\\\\&amp;quot;Brannan Street\\\\&amp;quot;)\\\\n  .postalCode(\\\\&amp;quot;94678\\\\&amp;quot;)\\\\n  .street2(\\\\&amp;quot;274\\\\&amp;quot;);\\\\n\\\\nName name = new Name()\\\\n  .firstName(\\\\&amp;quot;Simone\\\\&amp;quot;)\\\\n  .lastName(\\\\&amp;quot;Hopper\\\\&amp;quot;);\\\\n\\\\nBirthData birthData = new BirthData()\\\\n  .dateOfBirth(\\\\&amp;quot;1981-12-01\\\\&amp;quot;);\\\\n\\\\nIndividual individual = new Individual()\\\\n  .phone(phoneNumber)\\\\n  .residentialAddress(address)\\\\n  .name(name)\\\\n  .birthData(birthData)\\\\n  .email(\\\\&amp;quot;s.hopper@example.com\\\\&amp;quot;);\\\\n\\\\nLegalEntityInfoRequiredType legalEntityInfoRequiredType = new LegalEntityInfoRequiredType()\\\\n  .individual(individual)\\\\n  .type(LegalEntityInfoRequiredType.TypeEnum.INDIVIDUAL);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nLegalEntitiesApi service = new LegalEntitiesApi(client);\\\\nLegalEntity response = service.createLegalEntity(legalEntityInfoRequiredType, null);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;php&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;PHP&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;&amp;lt;?php\\\\n\\\\\\\/\\\\\\\/ Adyen PHP API Library v24.0.0\\\\nuse Adyen\\\\\\\\Client;\\\\nuse Adyen\\\\\\\\Environment;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\LegalEntityManagement\\\\\\\\PhoneNumber;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\LegalEntityManagement\\\\\\\\Address;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\LegalEntityManagement\\\\\\\\Name;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\LegalEntityManagement\\\\\\\\BirthData;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\LegalEntityManagement\\\\\\\\Individual;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\LegalEntityManagement\\\\\\\\LegalEntityInfoRequiredType;\\\\nuse Adyen\\\\\\\\Service\\\\\\\\LegalEntityManagement\\\\\\\\LegalEntitiesApi;\\\\n\\\\n$client = new Client();\\\\n$client-&amp;gt;setXApiKey(\\\\&amp;quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\\\&amp;quot;);\\\\n$client-&amp;gt;setEnvironment(Environment::TEST);\\\\n\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\n$phoneNumber = new PhoneNumber();\\\\n$phoneNumber\\\\n  -&amp;gt;setNumber(\\\\&amp;quot;+14153671502\\\\&amp;quot;)\\\\n  -&amp;gt;setType(\\\\&amp;quot;mobile\\\\&amp;quot;);\\\\n\\\\n$address = new Address();\\\\n$address\\\\n  -&amp;gt;setCountry(\\\\&amp;quot;US\\\\&amp;quot;)\\\\n  -&amp;gt;setStateOrProvince(\\\\&amp;quot;CA\\\\&amp;quot;)\\\\n  -&amp;gt;setCity(\\\\&amp;quot;San Francisco\\\\&amp;quot;)\\\\n  -&amp;gt;setStreet(\\\\&amp;quot;Brannan Street\\\\&amp;quot;)\\\\n  -&amp;gt;setPostalCode(\\\\&amp;quot;94678\\\\&amp;quot;)\\\\n  -&amp;gt;setStreet2(\\\\&amp;quot;274\\\\&amp;quot;);\\\\n\\\\n$name = new Name();\\\\n$name\\\\n  -&amp;gt;setFirstName(\\\\&amp;quot;Simone\\\\&amp;quot;)\\\\n  -&amp;gt;setLastName(\\\\&amp;quot;Hopper\\\\&amp;quot;);\\\\n\\\\n$birthData = new BirthData();\\\\n$birthData\\\\n  -&amp;gt;setDateOfBirth(\\\\&amp;quot;1981-12-01\\\\&amp;quot;);\\\\n\\\\n$individual = new Individual();\\\\n$individual\\\\n  -&amp;gt;setPhone($phoneNumber)\\\\n  -&amp;gt;setResidentialAddress($address)\\\\n  -&amp;gt;setName($name)\\\\n  -&amp;gt;setBirthData($birthData)\\\\n  -&amp;gt;setEmail(\\\\&amp;quot;s.hopper@example.com\\\\&amp;quot;);\\\\n\\\\n$legalEntityInfoRequiredType = new LegalEntityInfoRequiredType();\\\\n$legalEntityInfoRequiredType\\\\n  -&amp;gt;setIndividual($individual)\\\\n  -&amp;gt;setType(\\\\&amp;quot;individual\\\\&amp;quot;);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\n$service = new LegalEntitiesApi($client);\\\\n$response = $service-&amp;gt;createLegalEntity($legalEntityInfoRequiredType);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;cs&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;C#&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen .net API Library v28.0.0\\\\nusing Adyen;\\\\nusing Environment = Adyen.Model.Environment;\\\\nusing Adyen.Model;\\\\nusing Adyen.Model.LegalEntityManagement;\\\\nusing Adyen.Service.LegalEntityManagement;\\\\n\\\\nvar config = new Config()\\\\n{\\\\n    XApiKey = \\\\&amp;quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\\\&amp;quot;,\\\\n    Environment = Environment.Test\\\\n};\\\\nvar client = new Client(config);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nPhoneNumber phoneNumber = new PhoneNumber\\\\n{\\\\n  Number = \\\\&amp;quot;+14153671502\\\\&amp;quot;,\\\\n  Type = \\\\&amp;quot;mobile\\\\&amp;quot;\\\\n};\\\\n\\\\nAddress address = new Address\\\\n{\\\\n  Country = \\\\&amp;quot;US\\\\&amp;quot;,\\\\n  StateOrProvince = \\\\&amp;quot;CA\\\\&amp;quot;,\\\\n  City = \\\\&amp;quot;San Francisco\\\\&amp;quot;,\\\\n  Street = \\\\&amp;quot;Brannan Street\\\\&amp;quot;,\\\\n  PostalCode = \\\\&amp;quot;94678\\\\&amp;quot;,\\\\n  Street2 = \\\\&amp;quot;274\\\\&amp;quot;\\\\n};\\\\n\\\\nName name = new Name\\\\n{\\\\n  FirstName = \\\\&amp;quot;Simone\\\\&amp;quot;,\\\\n  LastName = \\\\&amp;quot;Hopper\\\\&amp;quot;\\\\n};\\\\n\\\\nBirthData birthData = new BirthData\\\\n{\\\\n  DateOfBirth = \\\\&amp;quot;1981-12-01\\\\&amp;quot;\\\\n};\\\\n\\\\nIndividual individual = new Individual\\\\n{\\\\n  Phone = phoneNumber,\\\\n  ResidentialAddress = address,\\\\n  Name = name,\\\\n  BirthData = birthData,\\\\n  Email = \\\\&amp;quot;s.hopper@example.com\\\\&amp;quot;\\\\n};\\\\n\\\\nLegalEntityInfoRequiredType legalEntityInfoRequiredType = new LegalEntityInfoRequiredType\\\\n{\\\\n  Individual = individual,\\\\n  Type = LegalEntityInfoRequiredType.TypeEnum.Individual\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nvar service = new LegalEntitiesService(client);\\\\nvar response = service.CreateLegalEntity(legalEntityInfoRequiredType);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;js&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (JavaScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v23.3.0\\\\nconst { Client, LegalEntityManagementAPI } = require(&#039;@adyen\\\\\\\/api-library&#039;);\\\\n\\\\nconst client = new Client({ apiKey: \\\\&amp;quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot; });\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst legalEntityInfoRequiredType = {\\\\n  type: \\\\&amp;quot;individual\\\\&amp;quot;,\\\\n  individual: {\\\\n    residentialAddress: {\\\\n      city: \\\\&amp;quot;San Francisco\\\\&amp;quot;,\\\\n      country: \\\\&amp;quot;US\\\\&amp;quot;,\\\\n      postalCode: \\\\&amp;quot;94678\\\\&amp;quot;,\\\\n      stateOrProvince: \\\\&amp;quot;CA\\\\&amp;quot;,\\\\n      street: \\\\&amp;quot;Brannan Street\\\\&amp;quot;,\\\\n      street2: \\\\&amp;quot;274\\\\&amp;quot;\\\\n    },\\\\n    phone: {\\\\n      number: \\\\&amp;quot;+14153671502\\\\&amp;quot;,\\\\n      type: \\\\&amp;quot;mobile\\\\&amp;quot;\\\\n    },\\\\n    name: {\\\\n      firstName: \\\\&amp;quot;Simone\\\\&amp;quot;,\\\\n      lastName: \\\\&amp;quot;Hopper\\\\&amp;quot;\\\\n    },\\\\n    birthData: {\\\\n      dateOfBirth: new Date(\\\\&amp;quot;1981-12-01\\\\&amp;quot;)\\\\n    },\\\\n    email: \\\\&amp;quot;s.hopper@example.com\\\\&amp;quot;\\\\n  }\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\\\nconst response = legalEntityManagementAPI.LegalEntitiesApi.createLegalEntity(legalEntityInfoRequiredType);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;go&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Go&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Go API Library v17.0.0\\\\nimport (\\\\n  \\\\&amp;quot;context\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/common\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/adyen\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/legalEntityManagement\\\\&amp;quot;\\\\n)\\\\nclient := adyen.NewClient(&amp;amp;common.Config{\\\\n  ApiKey:      \\\\&amp;quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\\\&amp;quot;,\\\\n  Environment: common.TestEnv,\\\\n})\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nphoneNumber := legalEntityManagement.PhoneNumber{\\\\n  Number: \\\\&amp;quot;+14153671502\\\\&amp;quot;,\\\\n  Type: common.PtrString(\\\\&amp;quot;mobile\\\\&amp;quot;),\\\\n}\\\\n\\\\naddress := legalEntityManagement.Address{\\\\n  Country: \\\\&amp;quot;US\\\\&amp;quot;,\\\\n  StateOrProvince: common.PtrString(\\\\&amp;quot;CA\\\\&amp;quot;),\\\\n  City: common.PtrString(\\\\&amp;quot;San Francisco\\\\&amp;quot;),\\\\n  Street: common.PtrString(\\\\&amp;quot;Brannan Street\\\\&amp;quot;),\\\\n  PostalCode: common.PtrString(\\\\&amp;quot;94678\\\\&amp;quot;),\\\\n  Street2: common.PtrString(\\\\&amp;quot;274\\\\&amp;quot;),\\\\n}\\\\n\\\\nname := legalEntityManagement.Name{\\\\n  FirstName: \\\\&amp;quot;Simone\\\\&amp;quot;,\\\\n  LastName: \\\\&amp;quot;Hopper\\\\&amp;quot;,\\\\n}\\\\n\\\\nbirthData := legalEntityManagement.BirthData{\\\\n  DateOfBirth: common.PtrString(\\\\&amp;quot;1981-12-01\\\\&amp;quot;),\\\\n}\\\\n\\\\nindividual := legalEntityManagement.Individual{\\\\n  Phone: &amp;amp;phoneNumber,\\\\n  ResidentialAddress: address,\\\\n  Name: name,\\\\n  BirthData: &amp;amp;birthData,\\\\n  Email: common.PtrString(\\\\&amp;quot;s.hopper@example.com\\\\&amp;quot;),\\\\n}\\\\n\\\\nlegalEntityInfoRequiredType := legalEntityManagement.LegalEntityInfoRequiredType{\\\\n  Individual: &amp;amp;individual,\\\\n  Type: \\\\&amp;quot;individual\\\\&amp;quot;,\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nservice := client.LegalEntityManagement()\\\\nreq := service.LegalEntitiesApi.CreateLegalEntityInput().LegalEntityInfoRequiredType(legalEntityInfoRequiredType)\\\\nres, httpRes, err := service.LegalEntitiesApi.CreateLegalEntity(context.Background(), req)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;py&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Python&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Python API Library v13.3.0\\\\nimport Adyen\\\\n\\\\nadyen = Adyen.Adyen()\\\\nadyen.client.xapikey = \\\\&amp;quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\\\&amp;quot;\\\\nadyen.client.platform = \\\\&amp;quot;test\\\\&amp;quot; # The environment to use library in.\\\\n\\\\n# Create the request object(s)\\\\njson_request = {\\\\n  \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;individual\\\\&amp;quot;,\\\\n  \\\\&amp;quot;individual\\\\&amp;quot;: {\\\\n    \\\\&amp;quot;residentialAddress\\\\&amp;quot;: {\\\\n      \\\\&amp;quot;city\\\\&amp;quot;: \\\\&amp;quot;San Francisco\\\\&amp;quot;,\\\\n      \\\\&amp;quot;country\\\\&amp;quot;: \\\\&amp;quot;US\\\\&amp;quot;,\\\\n      \\\\&amp;quot;postalCode\\\\&amp;quot;: \\\\&amp;quot;94678\\\\&amp;quot;,\\\\n      \\\\&amp;quot;stateOrProvince\\\\&amp;quot;: \\\\&amp;quot;CA\\\\&amp;quot;,\\\\n      \\\\&amp;quot;street\\\\&amp;quot;: \\\\&amp;quot;Brannan Street\\\\&amp;quot;,\\\\n      \\\\&amp;quot;street2\\\\&amp;quot;: \\\\&amp;quot;274\\\\&amp;quot;\\\\n    },\\\\n    \\\\&amp;quot;phone\\\\&amp;quot;: {\\\\n      \\\\&amp;quot;number\\\\&amp;quot;: \\\\&amp;quot;+14153671502\\\\&amp;quot;,\\\\n      \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;mobile\\\\&amp;quot;\\\\n    },\\\\n    \\\\&amp;quot;name\\\\&amp;quot;: {\\\\n      \\\\&amp;quot;firstName\\\\&amp;quot;: \\\\&amp;quot;Simone\\\\&amp;quot;,\\\\n      \\\\&amp;quot;lastName\\\\&amp;quot;: \\\\&amp;quot;Hopper\\\\&amp;quot;\\\\n    },\\\\n    \\\\&amp;quot;birthData\\\\&amp;quot;: {\\\\n      \\\\&amp;quot;dateOfBirth\\\\&amp;quot;: \\\\&amp;quot;1981-12-01\\\\&amp;quot;\\\\n    },\\\\n    \\\\&amp;quot;email\\\\&amp;quot;: \\\\&amp;quot;s.hopper@example.com\\\\&amp;quot;\\\\n  }\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.legalEntityManagement.legal_entities_api.create_legal_entity(request=json_request)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;rb&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Ruby&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Ruby API Library v10.1.1\\\\nrequire \\\\&amp;quot;adyen-ruby-api-library\\\\&amp;quot;\\\\n\\\\nadyen = Adyen::Client.new\\\\nadyen.api_key = &#039;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY&#039;\\\\nadyen.env = :test # Set to \\\\&amp;quot;live\\\\&amp;quot; for live environment\\\\n\\\\n# Create the request object(s)\\\\nrequest_body = {\\\\n  :type =&amp;gt; &#039;individual&#039;,\\\\n  :individual =&amp;gt; {\\\\n    :residentialAddress =&amp;gt; {\\\\n      :city =&amp;gt; &#039;San Francisco&#039;,\\\\n      :country =&amp;gt; &#039;US&#039;,\\\\n      :postalCode =&amp;gt; &#039;94678&#039;,\\\\n      :stateOrProvince =&amp;gt; &#039;CA&#039;,\\\\n      :street =&amp;gt; &#039;Brannan Street&#039;,\\\\n      :street2 =&amp;gt; &#039;274&#039;\\\\n    },\\\\n    :phone =&amp;gt; {\\\\n      :number =&amp;gt; &#039;+14153671502&#039;,\\\\n      :type =&amp;gt; &#039;mobile&#039;\\\\n    },\\\\n    :name =&amp;gt; {\\\\n      :firstName =&amp;gt; &#039;Simone&#039;,\\\\n      :lastName =&amp;gt; &#039;Hopper&#039;\\\\n    },\\\\n    :birthData =&amp;gt; {\\\\n      :dateOfBirth =&amp;gt; &#039;1981-12-01&#039;\\\\n    },\\\\n    :email =&amp;gt; &#039;s.hopper@example.com&#039;\\\\n  }\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.legalEntityManagement.legal_entities_api.create_legal_entity(request_body)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;ts&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (TypeScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v23.3.0\\\\nimport { Client, LegalEntityManagementAPI, Types } from \\\\&amp;quot;@adyen\\\\\\\/api-library\\\\&amp;quot;;\\\\n\\\\nconst client = new Client({ apiKey: \\\\&amp;quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot; });\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst phoneNumber: Types.legalEntityManagement.PhoneNumber = {\\\\n  number: \\\\&amp;quot;+14153671502\\\\&amp;quot;,\\\\n  type: \\\\&amp;quot;mobile\\\\&amp;quot;\\\\n};\\\\n\\\\nconst address: Types.legalEntityManagement.Address = {\\\\n  country: \\\\&amp;quot;US\\\\&amp;quot;,\\\\n  stateOrProvince: \\\\&amp;quot;CA\\\\&amp;quot;,\\\\n  city: \\\\&amp;quot;San Francisco\\\\&amp;quot;,\\\\n  street: \\\\&amp;quot;Brannan Street\\\\&amp;quot;,\\\\n  postalCode: \\\\&amp;quot;94678\\\\&amp;quot;,\\\\n  street2: \\\\&amp;quot;274\\\\&amp;quot;\\\\n};\\\\n\\\\nconst name: Types.legalEntityManagement.Name = {\\\\n  firstName: \\\\&amp;quot;Simone\\\\&amp;quot;,\\\\n  lastName: \\\\&amp;quot;Hopper\\\\&amp;quot;\\\\n};\\\\n\\\\nconst birthData: Types.legalEntityManagement.BirthData = {\\\\n  dateOfBirth: \\\\&amp;quot;1981-12-01\\\\&amp;quot;\\\\n};\\\\n\\\\nconst individual: Types.legalEntityManagement.Individual = {\\\\n  phone: phoneNumber,\\\\n  residentialAddress: address,\\\\n  name: name,\\\\n  birthData: birthData,\\\\n  email: \\\\&amp;quot;s.hopper@example.com\\\\&amp;quot;\\\\n};\\\\n\\\\nconst legalEntityInfoRequiredType: Types.legalEntityManagement.LegalEntityInfoRequiredType = {\\\\n  individual: individual,\\\\n  type: Types.legalEntityManagement.LegalEntityInfoRequiredType.TypeEnum.Individual\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\\\nconst response = legalEntityManagementAPI.LegalEntitiesApi.createLegalEntity(legalEntityInfoRequiredType);&amp;quot;}]\\&quot; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;p&gt;If the call was successful, you receive an &lt;strong&gt;HTTP 200&lt;\\\/strong&gt; result code along with the &lt;code&gt;id&lt;\\\/code&gt; and &lt;code&gt;type&lt;\\\/code&gt; of the legal entity you created.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Response&#039;\\&quot; :id=\\&quot;&#039;post-legalentity-response&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n    \\\\\\&quot;individual\\\\\\&quot;: {\\\\n        \\\\\\&quot;email\\\\\\&quot;: \\\\\\&quot;s.eller@example.com\\\\\\&quot;,\\\\n        \\\\\\&quot;name\\\\\\&quot;: {\\\\n            \\\\\\&quot;firstName\\\\\\&quot;: \\\\\\&quot;Shelly\\\\\\&quot;,\\\\n            \\\\\\&quot;lastName\\\\\\&quot;: \\\\\\&quot;Eller\\\\\\&quot;\\\\n        },\\\\n        \\\\\\&quot;residentialAddress\\\\\\&quot;: {\\\\n            \\\\\\&quot;city\\\\\\&quot;: \\\\\\&quot;San Francisco\\\\\\&quot;,\\\\n            \\\\\\&quot;country\\\\\\&quot;: \\\\\\&quot;US\\\\\\&quot;,\\\\n            \\\\\\&quot;postalCode\\\\\\&quot;: \\\\\\&quot;94678\\\\\\&quot;,\\\\n            \\\\\\&quot;stateOrProvince\\\\\\&quot;: \\\\\\&quot;CA\\\\\\&quot;,\\\\n            \\\\\\&quot;street\\\\\\&quot;: \\\\\\&quot;Brannan Street\\\\\\&quot;,\\\\n            \\\\\\&quot;street2\\\\\\&quot;: \\\\\\&quot;274\\\\\\&quot;\\\\n        }\\\\n    },\\\\n    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;individual\\\\\\&quot;,\\\\n    \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;LE00000000000000000000001\\\\\\&quot;\\\\n}\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;legal_entity_management_api_1_2&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Checkout API&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;Use the API key for your &lt;strong&gt;ws@Company.[YourCompanyAccount]&lt;\\\/strong&gt; API credential. Your Adyen contact also provides you with the name of your merchant account, which you must include in your payments request.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Try it out!&#039;\\&quot; :id=\\&quot;&#039;first-payment-request&#039;\\&quot; :code-data=\\&quot;[{&amp;quot;language&amp;quot;:&amp;quot;bash&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;curl&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;curl https:\\\\\\\/\\\\\\\/checkout-test.adyen.com\\\\\\\/v72\\\\\\\/payments \\\\\\\\\\\\n-H &#039;x-api-key: YOUR_COMPANY_ACCOUNT_API_KEY&#039; \\\\\\\\\\\\n-H &#039;content-type: application\\\\\\\/json&#039; \\\\\\\\\\\\n-X POST \\\\\\\\\\\\n-d &#039;{\\\\n    \\\\&amp;quot;merchantAccount\\\\&amp;quot;: \\\\&amp;quot;YOUR_MERCHANT_ACCOUNT\\\\&amp;quot;,\\\\n    \\\\&amp;quot;reference\\\\&amp;quot;: \\\\&amp;quot;My first Adyen test payment\\\\&amp;quot;,\\\\n    \\\\&amp;quot;amount\\\\&amp;quot;: {\\\\n      \\\\&amp;quot;value\\\\&amp;quot;: {hint:10 euros in minor units}1000{\\\\\\\/hint},\\\\n      \\\\&amp;quot;currency\\\\&amp;quot;: \\\\&amp;quot;EUR\\\\&amp;quot;\\\\n    },\\\\n\\\\t\\\\&amp;quot;paymentMethod\\\\&amp;quot;: {\\\\n\\\\t  \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;scheme\\\\&amp;quot;,\\\\n\\\\t   \\\\&amp;quot;encryptedCardNumber\\\\&amp;quot;: \\\\&amp;quot;test_4111111111111111\\\\&amp;quot;,\\\\n\\\\t   \\\\&amp;quot;encryptedExpiryMonth\\\\&amp;quot;: \\\\&amp;quot;test_03\\\\&amp;quot;,\\\\n\\\\t   \\\\&amp;quot;encryptedExpiryYear\\\\&amp;quot;: \\\\&amp;quot;test_2030\\\\&amp;quot;,\\\\n\\\\t   \\\\&amp;quot;encryptedSecurityCode\\\\&amp;quot;: \\\\&amp;quot;test_737\\\\&amp;quot;\\\\n    }\\\\n}&#039;&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;java&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Java&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Java API Library v33.0.0\\\\nimport com.adyen.Client;\\\\nimport com.adyen.enums.Environment;\\\\nimport com.adyen.model.checkout.*;\\\\nimport java.time.OffsetDateTime;\\\\nimport java.util.*;\\\\nimport com.adyen.model.RequestOptions;\\\\nimport com.adyen.service.checkout.*;\\\\n\\\\n\\\\\\\/\\\\\\\/ For the LIVE environment, also include your liveEndpointUrlPrefix.\\\\nClient client = new Client(\\\\&amp;quot;YOUR_COMPANY_ACCOUNT_API_KEY\\\\&amp;quot;, Environment.TEST);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nAmount amount = new Amount()\\\\n  .currency(\\\\&amp;quot;EUR\\\\&amp;quot;)\\\\n  .value(1000L);\\\\n\\\\nCardDetails cardDetails = new CardDetails()\\\\n  .encryptedCardNumber(\\\\&amp;quot;test_4111111111111111\\\\&amp;quot;)\\\\n  .encryptedSecurityCode(\\\\&amp;quot;test_737\\\\&amp;quot;)\\\\n  .encryptedExpiryYear(\\\\&amp;quot;test_2030\\\\&amp;quot;)\\\\n  .encryptedExpiryMonth(\\\\&amp;quot;test_03\\\\&amp;quot;)\\\\n  .type(CardDetails.TypeEnum.SCHEME);\\\\n\\\\nPaymentRequest paymentRequest = new PaymentRequest()\\\\n  .reference(\\\\&amp;quot;My first Adyen test payment\\\\&amp;quot;)\\\\n  .amount(amount)\\\\n  .merchantAccount(\\\\&amp;quot;YOUR_MERCHANT_ACCOUNT\\\\&amp;quot;)\\\\n  .paymentMethod(new CheckoutPaymentMethod(cardDetails));\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nPaymentsApi service = new PaymentsApi(client);\\\\nPaymentResponse response = service.payments(paymentRequest, new RequestOptions().idempotencyKey(\\\\&amp;quot;UUID\\\\&amp;quot;));&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;php&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;PHP&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;&amp;lt;?php\\\\n\\\\\\\/\\\\\\\/ Adyen PHP API Library v24.0.0\\\\nuse Adyen\\\\\\\\Client;\\\\nuse Adyen\\\\\\\\Environment;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\Checkout\\\\\\\\Amount;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\Checkout\\\\\\\\CheckoutPaymentMethod;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\Checkout\\\\\\\\PaymentRequest;\\\\nuse Adyen\\\\\\\\Service\\\\\\\\Checkout\\\\\\\\PaymentsApi;\\\\n\\\\n$client = new Client();\\\\n$client-&amp;gt;setXApiKey(\\\\&amp;quot;YOUR_COMPANY_ACCOUNT_API_KEY\\\\&amp;quot;);\\\\n\\\\\\\/\\\\\\\/ For the LIVE environment, also include your liveEndpointUrlPrefix.\\\\n$client-&amp;gt;setEnvironment(Environment::TEST);\\\\n\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\n$amount = new Amount();\\\\n$amount\\\\n  -&amp;gt;setCurrency(\\\\&amp;quot;EUR\\\\&amp;quot;)\\\\n  -&amp;gt;setValue(1000);\\\\n\\\\n$checkoutPaymentMethod = new CheckoutPaymentMethod();\\\\n$checkoutPaymentMethod\\\\n  -&amp;gt;setEncryptedCardNumber(\\\\&amp;quot;test_4111111111111111\\\\&amp;quot;)\\\\n  -&amp;gt;setEncryptedSecurityCode(\\\\&amp;quot;test_737\\\\&amp;quot;)\\\\n  -&amp;gt;setEncryptedExpiryYear(\\\\&amp;quot;test_2030\\\\&amp;quot;)\\\\n  -&amp;gt;setEncryptedExpiryMonth(\\\\&amp;quot;test_03\\\\&amp;quot;)\\\\n  -&amp;gt;setType(\\\\&amp;quot;scheme\\\\&amp;quot;);\\\\n\\\\n$paymentRequest = new PaymentRequest();\\\\n$paymentRequest\\\\n  -&amp;gt;setReference(\\\\&amp;quot;My first Adyen test payment\\\\&amp;quot;)\\\\n  -&amp;gt;setAmount($amount)\\\\n  -&amp;gt;setMerchantAccount(\\\\&amp;quot;YOUR_MERCHANT_ACCOUNT\\\\&amp;quot;)\\\\n  -&amp;gt;setPaymentMethod($checkoutPaymentMethod);\\\\n\\\\n$requestOptions[&#039;idempotencyKey&#039;] = &#039;UUID&#039;;\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\n$service = new PaymentsApi($client);\\\\n$response = $service-&amp;gt;payments($paymentRequest, $requestOptions);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;cs&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;C#&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen .net API Library v28.0.0\\\\nusing Adyen;\\\\nusing Environment = Adyen.Model.Environment;\\\\nusing Adyen.Model;\\\\nusing Adyen.Model.Checkout;\\\\nusing Adyen.Service.Checkout;\\\\n\\\\n\\\\\\\/\\\\\\\/ For the LIVE environment, also include your liveEndpointUrlPrefix.\\\\nvar config = new Config()\\\\n{\\\\n    XApiKey = \\\\&amp;quot;YOUR_COMPANY_ACCOUNT_API_KEY\\\\&amp;quot;,\\\\n    Environment = Environment.Test\\\\n};\\\\nvar client = new Client(config);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nAmount amount = new Amount\\\\n{\\\\n  Currency = \\\\&amp;quot;EUR\\\\&amp;quot;,\\\\n  Value = 1000\\\\n};\\\\n\\\\nCardDetails cardDetails = new CardDetails\\\\n{\\\\n  EncryptedCardNumber = \\\\&amp;quot;test_4111111111111111\\\\&amp;quot;,\\\\n  EncryptedSecurityCode = \\\\&amp;quot;test_737\\\\&amp;quot;,\\\\n  EncryptedExpiryYear = \\\\&amp;quot;test_2030\\\\&amp;quot;,\\\\n  EncryptedExpiryMonth = \\\\&amp;quot;test_03\\\\&amp;quot;,\\\\n  Type = CardDetails.TypeEnum.Scheme\\\\n};\\\\n\\\\nPaymentRequest paymentRequest = new PaymentRequest\\\\n{\\\\n  Reference = \\\\&amp;quot;My first Adyen test payment\\\\&amp;quot;,\\\\n  Amount = amount,\\\\n  MerchantAccount = \\\\&amp;quot;YOUR_MERCHANT_ACCOUNT\\\\&amp;quot;,\\\\n  PaymentMethod = new CheckoutPaymentMethod(cardDetails)\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nvar service = new PaymentsService(client);\\\\nvar response = service.Payments(paymentRequest, requestOptions: new RequestOptions { IdempotencyKey = \\\\&amp;quot;UUID\\\\&amp;quot;});&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;js&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (JavaScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v23.3.0\\\\nconst { Client, CheckoutAPI } = require(&#039;@adyen\\\\\\\/api-library&#039;);\\\\n\\\\n\\\\\\\/\\\\\\\/ For the LIVE environment, also include your liveEndpointUrlPrefix.\\\\nconst client = new Client({ apiKey: \\\\&amp;quot;YOUR_COMPANY_ACCOUNT_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot; });\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst paymentRequest = {\\\\n  merchantAccount: \\\\&amp;quot;YOUR_MERCHANT_ACCOUNT\\\\&amp;quot;,\\\\n  reference: \\\\&amp;quot;My first Adyen test payment\\\\&amp;quot;,\\\\n  amount: {\\\\n    value: \\\\&amp;quot;1000\\\\&amp;quot;,\\\\n    currency: \\\\&amp;quot;EUR\\\\&amp;quot;\\\\n  },\\\\n  paymentMethod: {\\\\n    type: \\\\&amp;quot;scheme\\\\&amp;quot;,\\\\n    encryptedCardNumber: \\\\&amp;quot;test_4111111111111111\\\\&amp;quot;,\\\\n    encryptedExpiryMonth: \\\\&amp;quot;test_03\\\\&amp;quot;,\\\\n    encryptedExpiryYear: \\\\&amp;quot;test_2030\\\\&amp;quot;,\\\\n    encryptedSecurityCode: \\\\&amp;quot;test_737\\\\&amp;quot;\\\\n  }\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst checkoutAPI = new CheckoutAPI(client);\\\\nconst response = checkoutAPI.PaymentsApi.payments(paymentRequest, { idempotencyKey: \\\\&amp;quot;UUID\\\\&amp;quot; });&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;go&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Go&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Go API Library v17.0.0\\\\nimport (\\\\n  \\\\&amp;quot;context\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/common\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/adyen\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/checkout\\\\&amp;quot;\\\\n)\\\\n\\\\\\\/\\\\\\\/ For the LIVE environment, also include your liveEndpointUrlPrefix.\\\\nclient := adyen.NewClient(&amp;amp;common.Config{\\\\n  ApiKey:      \\\\&amp;quot;YOUR_COMPANY_ACCOUNT_API_KEY\\\\&amp;quot;,\\\\n  Environment: common.TestEnv,\\\\n})\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\namount := checkout.Amount{\\\\n  Currency: \\\\&amp;quot;EUR\\\\&amp;quot;,\\\\n  Value: 1000,\\\\n}\\\\n\\\\ncardDetails := checkout.CardDetails{\\\\n  EncryptedCardNumber: common.PtrString(\\\\&amp;quot;test_4111111111111111\\\\&amp;quot;),\\\\n  EncryptedSecurityCode: common.PtrString(\\\\&amp;quot;test_737\\\\&amp;quot;),\\\\n  EncryptedExpiryYear: common.PtrString(\\\\&amp;quot;test_2030\\\\&amp;quot;),\\\\n  EncryptedExpiryMonth: common.PtrString(\\\\&amp;quot;test_03\\\\&amp;quot;),\\\\n  Type: common.PtrString(\\\\&amp;quot;scheme\\\\&amp;quot;),\\\\n}\\\\n\\\\npaymentRequest := checkout.PaymentRequest{\\\\n  Reference: \\\\&amp;quot;My first Adyen test payment\\\\&amp;quot;,\\\\n  Amount: amount,\\\\n  MerchantAccount: \\\\&amp;quot;YOUR_MERCHANT_ACCOUNT\\\\&amp;quot;,\\\\n  PaymentMethod: checkout.CardDetailsAsCheckoutPaymentMethod(&amp;amp;cardDetails),\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nservice := client.Checkout()\\\\nreq := service.PaymentsApi.PaymentsInput().IdempotencyKey(\\\\&amp;quot;UUID\\\\&amp;quot;).PaymentRequest(paymentRequest)\\\\nres, httpRes, err := service.PaymentsApi.Payments(context.Background(), req)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;py&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Python&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Python API Library v13.3.0\\\\nimport Adyen\\\\n\\\\nadyen = Adyen.Adyen()\\\\nadyen.client.xapikey = \\\\&amp;quot;YOUR_COMPANY_ACCOUNT_API_KEY\\\\&amp;quot;\\\\n# For the LIVE environment, also include your liveEndpointUrlPrefix.\\\\nadyen.client.platform = \\\\&amp;quot;test\\\\&amp;quot; # The environment to use library in.\\\\n\\\\n# Create the request object(s)\\\\njson_request = {\\\\n  \\\\&amp;quot;merchantAccount\\\\&amp;quot;: \\\\&amp;quot;YOUR_MERCHANT_ACCOUNT\\\\&amp;quot;,\\\\n  \\\\&amp;quot;reference\\\\&amp;quot;: \\\\&amp;quot;My first Adyen test payment\\\\&amp;quot;,\\\\n  \\\\&amp;quot;amount\\\\&amp;quot;: {\\\\n    \\\\&amp;quot;value\\\\&amp;quot;: \\\\&amp;quot;1000\\\\&amp;quot;,\\\\n    \\\\&amp;quot;currency\\\\&amp;quot;: \\\\&amp;quot;EUR\\\\&amp;quot;\\\\n  },\\\\n  \\\\&amp;quot;paymentMethod\\\\&amp;quot;: {\\\\n    \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;scheme\\\\&amp;quot;,\\\\n    \\\\&amp;quot;encryptedCardNumber\\\\&amp;quot;: \\\\&amp;quot;test_4111111111111111\\\\&amp;quot;,\\\\n    \\\\&amp;quot;encryptedExpiryMonth\\\\&amp;quot;: \\\\&amp;quot;test_03\\\\&amp;quot;,\\\\n    \\\\&amp;quot;encryptedExpiryYear\\\\&amp;quot;: \\\\&amp;quot;test_2030\\\\&amp;quot;,\\\\n    \\\\&amp;quot;encryptedSecurityCode\\\\&amp;quot;: \\\\&amp;quot;test_737\\\\&amp;quot;\\\\n  }\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.checkout.payments_api.payments(request=json_request, idempotency_key=\\\\&amp;quot;UUID\\\\&amp;quot;)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;rb&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Ruby&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Ruby API Library v10.1.1\\\\nrequire \\\\&amp;quot;adyen-ruby-api-library\\\\&amp;quot;\\\\n\\\\nadyen = Adyen::Client.new\\\\nadyen.api_key = &#039;YOUR_COMPANY_ACCOUNT_API_KEY&#039;\\\\n# For the LIVE environment, also include your liveEndpointUrlPrefix.\\\\nadyen.env = :test # Set to \\\\&amp;quot;live\\\\&amp;quot; for live environment\\\\n\\\\n# Create the request object(s)\\\\nrequest_body = {\\\\n  :merchantAccount =&amp;gt; &#039;YOUR_MERCHANT_ACCOUNT&#039;,\\\\n  :reference =&amp;gt; &#039;My first Adyen test payment&#039;,\\\\n  :amount =&amp;gt; {\\\\n    :value =&amp;gt; &#039;1000&#039;,\\\\n    :currency =&amp;gt; &#039;EUR&#039;\\\\n  },\\\\n  :paymentMethod =&amp;gt; {\\\\n    :type =&amp;gt; &#039;scheme&#039;,\\\\n    :encryptedCardNumber =&amp;gt; &#039;test_4111111111111111&#039;,\\\\n    :encryptedExpiryMonth =&amp;gt; &#039;test_03&#039;,\\\\n    :encryptedExpiryYear =&amp;gt; &#039;test_2030&#039;,\\\\n    :encryptedSecurityCode =&amp;gt; &#039;test_737&#039;\\\\n  }\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.checkout.payments_api.payments(request_body, headers: { &#039;Idempotency-Key&#039; =&amp;gt; &#039;UUID&#039; })&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;ts&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (TypeScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v23.3.0\\\\nimport { Client, CheckoutAPI, Types } from \\\\&amp;quot;@adyen\\\\\\\/api-library\\\\&amp;quot;;\\\\n\\\\n\\\\\\\/\\\\\\\/ For the LIVE environment, also include your liveEndpointUrlPrefix.\\\\nconst client = new Client({ apiKey: \\\\&amp;quot;YOUR_COMPANY_ACCOUNT_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot; });\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst amount: Types.checkout.Amount = {\\\\n  currency: \\\\&amp;quot;EUR\\\\&amp;quot;,\\\\n  value: 1000\\\\n};\\\\n\\\\nconst cardDetails: Types.checkout.CardDetails = {\\\\n  encryptedCardNumber: \\\\&amp;quot;test_4111111111111111\\\\&amp;quot;,\\\\n  encryptedSecurityCode: \\\\&amp;quot;test_737\\\\&amp;quot;,\\\\n  encryptedExpiryYear: \\\\&amp;quot;test_2030\\\\&amp;quot;,\\\\n  encryptedExpiryMonth: \\\\&amp;quot;test_03\\\\&amp;quot;,\\\\n  type: Types.checkout.CardDetails.TypeEnum.Scheme\\\\n};\\\\n\\\\nconst paymentRequest: Types.checkout.PaymentRequest = {\\\\n  reference: \\\\&amp;quot;My first Adyen test payment\\\\&amp;quot;,\\\\n  amount: amount,\\\\n  merchantAccount: \\\\&amp;quot;YOUR_MERCHANT_ACCOUNT\\\\&amp;quot;,\\\\n  paymentMethod: cardDetails\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst checkoutAPI = new CheckoutAPI(client);\\\\nconst response = checkoutAPI.PaymentsApi.payments(paymentRequest, { idempotencyKey: \\\\&amp;quot;UUID\\\\&amp;quot; });&amp;quot;}]\\&quot; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;p&gt;If your account is set up correctly and the request is successful, you receive a response containing an &lt;strong&gt;HTTP 200&lt;\\\/strong&gt; result code along with &lt;code&gt;resultCode&lt;\\\/code&gt;: &lt;strong&gt;Authorised&lt;\\\/strong&gt;. You have just made a successful test credit card payment of &lt;strong&gt;10&lt;\\\/strong&gt; EUR!&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;checkout_api_2_3&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2 id=\"Set-up-webhooks\">Set up webhooks<\/h2>\n<p>Webhooks are a crucial part of your integration. Adyen sends webhooks to communicate events in your marketplace, such as if your user needs to provide additional information for onboarding, or when their funds have been paid out.<\/p>\n<ol>\n<li><a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage#configure-webhook-endpoint\">Set up webhook endpoints<\/a> on your server and build the logic for acknowledging webhooks.<\/li>\n<li><a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage#configure-customer-area\">Configure webhooks<\/a> in your Customer Area.<\/li>\n<li><a href=\"\/pt\/development-resources\/webhooks\/secure-webhooks#hash-based-message-authentication-code-hmac-signatures\">Secure webhooks<\/a> with HMAC signing.<\/li>\n<\/ol>\n<h2 id=\"integrate-components\">Integrate components<\/h2>\n<p>To reduce implementation time and effort, take advantage of Adyen's prebuilt component libraries that you can seamlessly integrate into your user interface.<\/p>\n<p><a href=\"\/pt\/marketplaces\/components-overview\">Components<\/a> simplify the process of collecting user input for payments or during onboarding, and allows you to showcase interactive dashboards to your users, such as an overview of their transactions and other reporting data.<\/p>\n<ol>\n<li><strong>Create an authentication session from your server<\/strong><br \/>\nCreate a session token to ensure secure communication between the component and the Adyen server.<\/li>\n<li><strong>Install the component library in your front end<\/strong><br \/>\nInstall the npm package, then import the library, component, and style sheet in your front-end application.<\/li>\n<li><strong>Initialize the component<\/strong>\n<ol>\n<li>Gather the required information on the specific library and component you want to integrate.<\/li>\n<li>Create a DOM element on your user interface page where you want the component to be rendered.<\/li>\n<li>Add a function that calls your API to retrieve and refresh an authentication session token.<\/li>\n<li>Initialize the component and mount it to the DOM element you created.<\/li>\n<\/ol><\/li>\n<li><strong>Customize the component(s)<\/strong><br \/>\nCustomize the component to match your marketplace's look and feel.<\/li>\n<\/ol>\n<p>Some components may require additional steps or conditions.<\/p>\n<h2>Onboard and verify users<\/h2>\n<p>Before you can start processing payments for your users and pay out to them, Adyen needs to <a href=\"\/pt\/marketplaces\/verification-overview\">verify their information<\/a>.<\/p>\n<p>You can choose from the following types of <a href=\"\/pt\/marketplaces\/onboard-users\">onboarding<\/a>:<\/p>\n<ul>\n<li><strong>Hosted onboarding<\/strong>: Your users are directed to a page hosted by Adyen, where Adyen manages the onboarding flow and user interface (UI). You need to implement a few API calls to create the resources.<\/li>\n<li><strong>API-only onboarding<\/strong>: Build your own UI and collect required user data by integrating with Adyen APIs.<\/li>\n<\/ul>\n<table class=\"tg\">\n<thead>\n  <tr>\n    <th scope=\"col\">Onboarding type<\/th>\n    <th scope=\"col\">How it works<\/th>\n    <th scope=\"col\">Use this option if you...<\/th>\n  <\/tr>\n<\/thead>\n<tbody>\n  <tr>\n    <td>\n<p>Hosted onboarding<\/p>\n<\/td>\n    <td>\n<p>Create resources and a hosted onboarding link by making API calls to several endpoints, and redirect your user to enter their information.<\/p>\n<\/td>\n    <td>\n<ul><li>\n<p>Have moderate technical resources.<\/p>\n<\/li><li>\n<p>Want to get started quickly with minimal integration efforts.<\/p>\n<\/li><li>\n<p>Prefer to outsource user onboarding management to Adyen to reduce future maintenance.<\/p>\n<\/li><li>\n<p>Want to ensure ongoing compliance with regulatory changes, as Adyen will handle this for you.<\/p>\n<\/li><\/ul>\n<\/td>\n  <\/tr>\n  <tr>\n    <td>\n<p>API-only<\/p>\n<\/td>\n    <td>\n<p>Build your own UI and collect required user data. You make API requests to create resources and submit the user data to Adyen.<\/p>\n<\/td>\n    <td>\n<ul><li>\n<p>Have sufficient technical resources.<\/p>\n<\/li><li>\n<p>Understand it is your responsibility to regularly update your integration to comply with regulatory changes.<\/p>\n<\/li><li>\n<p>Want to maintain complete control over the user experience within your platform's environment.<\/p>\n<\/li><\/ul>\n<\/td>\n  <\/tr>\n  <tr>\n    <td>\n\n<\/td>\n    <td>\n\n<\/td>\n    <td>\n\n<\/td>\n  <\/tr>\n<\/tbody>\n<\/table>\n<p>Choose the option that best suits your use case.<\/p>\n\n<div id=\"tabAK6bc\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Hosted onboarding&quot;,&quot;content&quot;:&quot;\\n&lt;ol&gt;\\n&lt;li&gt;&lt;strong&gt;Identify and collect the required information&lt;\\\/strong&gt;&lt;br \\\/&gt;\\n&lt;a href=\\&quot;\\\/pt\\\/marketplaces\\\/verification-requirements\\\/required-kyc-information\\&quot;&gt;Check the required information&lt;\\\/a&gt; based on the country or region in which your user operates.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create legal entities&lt;\\\/strong&gt;&lt;br \\\/&gt;\\n&lt;a href=\\&quot;\\\/pt\\\/marketplaces\\\/onboard-users\\\/onboarding-steps\\&quot;&gt;Create the required legal entity resources&lt;\\\/a&gt; for your user, including the main and supporting legal entities.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Associate legal entities&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nLink supporting legal entities to the main legal entity of your user.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create the account holder&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nCreate an account holder and link it to main legal entity.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create business lines (conditionally required)&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nCreate business lines to provide Adyen with information about your users&#039; line of business, such as their industry and sales channels.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create the hosted onboarding link&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nGenerate the link for the onboarding page, through which your user can provide the information required for verification checks.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create balance accounts&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nCreate balance accounts to hold the funds of your user.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Get verification updates&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nGet verification status updates via webhooks, and resolve verification errors if necessary.\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;hosted_onboarding_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;API-only onboarding&quot;,&quot;content&quot;:&quot;\\n&lt;ol&gt;\\n&lt;li&gt;&lt;strong&gt;Identify and collect the required information&lt;\\\/strong&gt;&lt;br \\\/&gt;\\n&lt;a href=\\&quot;\\\/pt\\\/marketplaces\\\/verification-requirements\\\/required-kyc-information\\&quot;&gt;Check the required information&lt;\\\/a&gt; based on the country or region in which your user operates.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create legal entities&lt;\\\/strong&gt;&lt;br \\\/&gt;\\n&lt;a href=\\&quot;\\\/pt\\\/marketplaces\\\/onboard-users\\\/onboarding-steps\\&quot;&gt;Create the required legal entity resources&lt;\\\/a&gt; for your user, including the main and supporting legal entities.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Associate legal entities&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nLink supporting legal entities to the main legal entity of your user.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create transfer instruments&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nCreate a transfer instrument, the resource that represents the user&#039;s payout bank account. Adyen must verify ths bank account before you can pay out to it.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create business lines (conditionally required)&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nCreate business lines to provide Adyen with information about your users&#039; line of business, such as their industry and sales channels. Only required if you want to offer business accounts to your users.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create account holders&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nCreate an account holder and link it to main legal entity.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Accept the terms of service&lt;\\\/strong&gt;&lt;br \\\/&gt;\\n&lt;a href=\\&quot;\\\/pt\\\/marketplaces\\\/onboard-users\\\/terms-of-service\\&quot;&gt;Accept Adyen&#039;s Terms of Service&lt;\\\/a&gt;. Depending on your integration, your may need to accept more than one Terms of Service document.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Create balance accounts&lt;\\\/strong&gt;&lt;br \\\/&gt;\\n&lt;a href=\\&quot;\\\/pt\\\/marketplaces\\\/onboard-users\\\/onboarding-steps\\&quot;&gt;Create balance accounts&lt;\\\/a&gt; to hold the funds of your user.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Get updates about account holders&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nGet updates about the verification status and capability changes for your user. Capabilities are actions that an account holder can do in your marketplace, such as paying out to their bank accounts.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;strong&gt;Upload additional documents&lt;\\\/strong&gt;&lt;br \\\/&gt;\\nAdyen may require you to upload additional documents in order to verify user data.\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;api-only_onboarding_1_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2>Process payments<\/h2>\n<h3>Build your payments integration<\/h3>\n<p>To process payments, you must first <a href=\"\/pt\/online-payments\/build-your-integration\/\">build an Adyen online payments integration<\/a> and checkout UI. After you build your integration, you can accept payments with cards, wallets, and local payment methods on your website and mobile app.<\/p>\n<h3>Start processing online payments<\/h3>\n<p>The core of your Adyen integration is being able to process payments and handle their subsequent states. To make sure that the pay-in, settlement, and payout processes run smoothly, you must book the incoming funds and fees to the correct balance accounts. This means that you have to include information on how to split the funds between your users' balance accounts and your platform's liable balance account. <\/p>\n<p>You can split individual transactions using the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Checkout API<\/a>.<\/p>\n<ol>\n<li><strong>Split payments<\/strong><br \/>\nSplit the payment amount <a href=\"\/pt\/marketplaces\/split-transactions\/split-payments-at-authorization\">at authorization<\/a> or <a href=\"\/pt\/marketplaces\/split-transactions\/split-payments-at-capture\">at capture<\/a>.<\/li>\n<li><strong>Split refunds<\/strong><br \/>\n<a href=\"\/pt\/marketplaces\/split-transactions\/split-refunds\">Book the refund amount<\/a> to multiple balance accounts.<\/li>\n<li><strong>Split chargebacks<\/strong><br \/>\n<a href=\"\/pt\/marketplaces\/split-transactions\/split-chargebacks\">Split the chargeback amount<\/a> between multiple balance accounts.<\/li>\n<li><strong>Handle transaction fees<\/strong><br \/>\n<a href=\"\/pt\/marketplaces\/split-transactions\/split-chargebacks\">Define the balance accounts<\/a> from which you want to deduct the fees incurred by transactions.<\/li>\n<\/ol>\n<h2 id=\"pay-out-sub-merchants\">Pay out<\/h2>\n<p>Pay out funds to your user's bank account.<\/p>\n<ol>\n<li><strong>Listen to webhooks<\/strong><br \/>\nLearn which webhooks Adyen sends to inform your server of <a href=\"\/pt\/marketplaces\/payout-to-users\/payout-webhooks\">payout events<\/a>.<\/li>\n<li><strong>Make scheduled payouts<\/strong><br \/>\nSet up <a href=\"\/pt\/marketplaces\/payout-to-users\/scheduled-payouts\">scheduled payouts<\/a>.<\/li>\n<li><strong>Pay out on demand<\/strong><br \/>\nMake <a href=\"\/pt\/marketplaces\/payout-to-users\/on-demand-payouts\">on-demand payouts<\/a>.<\/li>\n<\/ol>\n<h2>Transfer funds<\/h2>\n<p>Move funds between balance accounts in your balance platform, for example, to cover subscription fees or pass through chargeback costs.<\/p>\n<ol>\n<li><strong>Listen to webhooks<\/strong><br \/>\nLearn which webhooks Adyen sends to inform your server of <a href=\"\/pt\/marketplaces\/internal-fund-transfers\/internal-transfer-webhooks\/\">internal transfer events<\/a>.<\/li>\n<li><strong>Make scheduled transfers<\/strong><br \/>\nSet up <a href=\"\/pt\/marketplaces\/internal-fund-transfers\/scheduled-fund-transfers\">scheduled transfers<\/a>.<\/li>\n<li><strong>Transfer funds on demand<\/strong><br \/>\n<a href=\"\/pt\/marketplaces\/internal-fund-transfers\/on-demand-fund-transfers\/\">Send funds or initiate an internal direct debit<\/a> between balance accounts within your balance platform.<\/li>\n<li><strong>Return transferred funds<\/strong><br \/>\n<a href=\"\/pt\/marketplaces\/internal-fund-transfers\/return-transfers\">Return funds<\/a> to the original balance account without creating a new transfer.<\/li>\n<\/ol>\n<h2 id=\"reports\">Accounting and reconciliation<\/h2>\n<p>Use reports to reconcile payments and balances in your system.<\/p>\n<ol>\n<li><strong>Set up your reports credentials<\/strong><br \/>\nYour Adyen contact will provide you with a reports credential, which you'll need if you want to programmatically download reports.<\/li>\n<li><strong>Download reports<\/strong><br \/>\nListen to the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/report-webhooks\/latest\/post\/balancePlatform.report.created\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.report.created<\/a> webhook to know when a report is generated and ready to be downloaded. To download a report, you must authenticate your GET requests with your report credentials.<\/li>\n<li><strong>Reconcile using reports<\/strong><br \/>\nFamiliarize yourself with the <a href=\"\/pt\/marketplaces\/reconciliation-use-cases\/\">common reconciliation processes<\/a> at Adyen.<\/li>\n<\/ol>\n<h2 id=\"go-live\">Go live<\/h2>\n<p>To take your Adyen for Platforms integration live, you need to apply for a <a href=\"\/pt\/marketplaces\/get-started#apply-for-live-account\">live account<\/a>. When you have your live account, follow the steps below to take your integration live.<\/p>\n<ol>\n<li><strong>Replicate your test account setup<\/strong><br \/>\nThe setup from your test Adyen for Platforms account is <em>not<\/em> replicated to your live Adyen for Platforms account automatically.<\/li>\n<li><strong>Update your code base<\/strong><\/li>\n<li><strong>Switch to live API credentials<\/strong><br \/>\nGet your live API credentials from your Adyen contact. Use these credentials in your live account.<\/li>\n<li><strong>Switch from test to live endpoints<\/strong><br \/>\nChange the endpoints from <code>test<\/code> to <code>live<\/code>. For example, <code>https:\/\/balanceplatform-api-test.adyen.com\/<\/code> to<br \/>\n<code>https:\/\/balanceplatform-api-live.adyen.com\/<\/code>.<\/li>\n<li><strong>Run end-to-end tests<\/strong>\n<ul>\n<li>Live API credentials: Make your <a href=\"#verify-your-test-credentials\">first live API request<\/a> to make sure that your live API credentials are working.<\/li>\n<li><a href=\"\/pt\/marketplaces\/onboard-users\">Legal entities<\/a>: Confirm that you can create legal entities.<\/li>\n<li><a href=\"\/pt\/marketplaces\/onboard-users\/onboarding-steps\">Account holders and balance accounts<\/a>: Confirm you can create and retrieve account holders and balance accounts.<\/li>\n<li><a href=\"\/pt\/marketplaces\/process-payments\">Payments<\/a>:\n<ul>\n<li>Test successful payment scenarios.<\/li>\n<li>Test your error handling scenarios, for example, when payments are declined.<\/li>\n<\/ul><\/li>\n<li><a href=\"\/pt\/marketplaces\/payout-to-users\">Payouts<\/a>: Confirm that your scheduled or on-demand payouts are working as expected.<\/li>\n<li><a href=\"\/pt\/marketplaces\/test-verification-errors\">Verification errors<\/a>: Test your error handling scenarios when onboarding users.<\/li>\n<li><a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage\">Webhooks<\/a>: Confirm that you can receive and accept webhooks in the live environment.<\/li>\n<li><a href=\"\/pt\/marketplaces\/prepare-reports\/generate-download-reports\">Reports<\/a>: Confirm that you can download reports in the live environment.<\/li>\n<\/ul><\/li>\n<\/ol>","url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/integration-checklist","articleFields":{"description":"Checklist for building and taking your Adyen for Platforms integration live.","feedback_component":true,"last_edit_on":"06-03-2023 15:13","parameters":{"directoryPath":"\/marketplaces","model":"marketplace"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/integration-checklist","title":"Integration and go-live checklist","content":"\nAdyen APIs Postman collections Fork our Postman collections in your private workspace to start testing API calls with your own credentials.\n\nOn this page, you can learn about the steps required to integrate Adyen's payment processing capabilities to your marketplace, and how to take your integration live.\nBefore you start building your integration, make sure that you have already designed your implementation with your Adyen implementation manager.\nNot yet in touch with Adyen? Contact us to register your interest for Adyen for Platforms.\nReview your account structure\nBefore you start the integration process, you must be familiar with the Adyen account structure. You\u2019ll need this information when building the different parts of your implementation.\nEvery Adyen for Platforms integration must have at least the following resource types:\n\nCompany account: Represents your core business entity and holds your merchant accounts.\nMerchant account: The account where we process payments for your users. You can have multiple merchant accounts.\n\nBalance platform: The accounting system in which you manage your users and funds.\nAccount holder: Specifies what your user can do in your platform, for example, receive fund transfers to their balance account and payouts to their verified transfer instrument (bank account).\nBalance account: Holds the funds of your user or your platform. All financial activities in your platform, such as paying out to a bank account, happen through balance accounts.\nLegal entity: Contains information about your user, for example, the legal name, address, and tax information of the organization. Adyen uses this information to perform verification checks required by payment industry regulations.\nTransfer instrument: Your user's verified bank account where they can receive payouts.\nBusiness line: Contains information about your user's line of business, including their industry and source of funds.\n\nFor details on the different account structures and example use cases, see Account structures.\nGet ready for development\nAt the end of this section you should have the API keys and the webhook configuration that you need to start integrating.\nCheck out Adyen\u2019s server-side libraries\nAdyen provides server-side API libraries in several languages. Installing a library is not required, but will save you development time, because a library:\n\nUses the latest API version.\nHas generated models and examples to help you construct requests.\nSends the request to Adyen using its built-in HTTP client, so you do not have to create your own.\n\nPick a library in the language of your choice and follow the installation instructions.\nGenerate and test your API keys\nAdyen is an API-first payment service provider, which means that you must integrate with our APIs to build and customize your implementation. You can generate your API credentials in your Customer Area.\nYou need credentials for the following APIs:\n\n\n\nAPI\nCredential\nDescription\n\n\n\n\n Configuration API Transfers API Foreign Exchange API Session authentication API\nws@BalancePlatform.[YourBalancePlatform]\nUse these APIs to create account holders and balance accounts, schedule payouts, transfer funds, make one-off payouts and calculate amounts in different currencies.Use the  Session authentication API with this API credential to create session tokens for integrating Platform Experience components.\n\n\n Legal Entity Management API Session authentication API\nws_[123456]@Scope.Company_[YourCompanyAccount]\nUse the  Legal Entity Management API to create and manage legal entities that contain the information required for verification checks.Use the  Session authentication API with this API credential to create session tokens for integrating Onboarding components.\n\n\n Checkout API Management API\nws@Company.[YourCompanyAccount]\nUse these APIs to process payments for your users.\n\n\n\nTo verify that your test API credentials are working, make your first requests.\n\n\n    \n        \n        \n    \n\n\nSet up webhooks\nWebhooks are a crucial part of your integration. Adyen sends webhooks to communicate events in your marketplace, such as if your user needs to provide additional information for onboarding, or when their funds have been paid out.\n\nSet up webhook endpoints on your server and build the logic for acknowledging webhooks.\nConfigure webhooks in your Customer Area.\nSecure webhooks with HMAC signing.\n\nIntegrate components\nTo reduce implementation time and effort, take advantage of Adyen's prebuilt component libraries that you can seamlessly integrate into your user interface.\nComponents simplify the process of collecting user input for payments or during onboarding, and allows you to showcase interactive dashboards to your users, such as an overview of their transactions and other reporting data.\n\nCreate an authentication session from your server\nCreate a session token to ensure secure communication between the component and the Adyen server.\nInstall the component library in your front end\nInstall the npm package, then import the library, component, and style sheet in your front-end application.\nInitialize the component\n\nGather the required information on the specific library and component you want to integrate.\nCreate a DOM element on your user interface page where you want the component to be rendered.\nAdd a function that calls your API to retrieve and refresh an authentication session token.\nInitialize the component and mount it to the DOM element you created.\n\nCustomize the component(s)\nCustomize the component to match your marketplace's look and feel.\n\nSome components may require additional steps or conditions.\nOnboard and verify users\nBefore you can start processing payments for your users and pay out to them, Adyen needs to verify their information.\nYou can choose from the following types of onboarding:\n\nHosted onboarding: Your users are directed to a page hosted by Adyen, where Adyen manages the onboarding flow and user interface (UI). You need to implement a few API calls to create the resources.\nAPI-only onboarding: Build your own UI and collect required user data by integrating with Adyen APIs.\n\n\n\n  \n    Onboarding type\n    How it works\n    Use this option if you...\n  \n\n\n  \n    \nHosted onboarding\n\n    \nCreate resources and a hosted onboarding link by making API calls to several endpoints, and redirect your user to enter their information.\n\n    \n\nHave moderate technical resources.\n\nWant to get started quickly with minimal integration efforts.\n\nPrefer to outsource user onboarding management to Adyen to reduce future maintenance.\n\nWant to ensure ongoing compliance with regulatory changes, as Adyen will handle this for you.\n\n\n  \n  \n    \nAPI-only\n\n    \nBuild your own UI and collect required user data. You make API requests to create resources and submit the user data to Adyen.\n\n    \n\nHave sufficient technical resources.\n\nUnderstand it is your responsibility to regularly update your integration to comply with regulatory changes.\n\nWant to maintain complete control over the user experience within your platform's environment.\n\n\n  \n  \n    \n\n\n    \n\n\n    \n\n\n  \n\n\nChoose the option that best suits your use case.\n\n\n    \n        \n        \n    \n\n\nProcess payments\nBuild your payments integration\nTo process payments, you must first build an Adyen online payments integration and checkout UI. After you build your integration, you can accept payments with cards, wallets, and local payment methods on your website and mobile app.\nStart processing online payments\nThe core of your Adyen integration is being able to process payments and handle their subsequent states. To make sure that the pay-in, settlement, and payout processes run smoothly, you must book the incoming funds and fees to the correct balance accounts. This means that you have to include information on how to split the funds between your users' balance accounts and your platform's liable balance account. \nYou can split individual transactions using the  Checkout API.\n\nSplit payments\nSplit the payment amount at authorization or at capture.\nSplit refunds\nBook the refund amount to multiple balance accounts.\nSplit chargebacks\nSplit the chargeback amount between multiple balance accounts.\nHandle transaction fees\nDefine the balance accounts from which you want to deduct the fees incurred by transactions.\n\nPay out\nPay out funds to your user's bank account.\n\nListen to webhooks\nLearn which webhooks Adyen sends to inform your server of payout events.\nMake scheduled payouts\nSet up scheduled payouts.\nPay out on demand\nMake on-demand payouts.\n\nTransfer funds\nMove funds between balance accounts in your balance platform, for example, to cover subscription fees or pass through chargeback costs.\n\nListen to webhooks\nLearn which webhooks Adyen sends to inform your server of internal transfer events.\nMake scheduled transfers\nSet up scheduled transfers.\nTransfer funds on demand\nSend funds or initiate an internal direct debit between balance accounts within your balance platform.\nReturn transferred funds\nReturn funds to the original balance account without creating a new transfer.\n\nAccounting and reconciliation\nUse reports to reconcile payments and balances in your system.\n\nSet up your reports credentials\nYour Adyen contact will provide you with a reports credential, which you'll need if you want to programmatically download reports.\nDownload reports\nListen to the  balancePlatform.report.created webhook to know when a report is generated and ready to be downloaded. To download a report, you must authenticate your GET requests with your report credentials.\nReconcile using reports\nFamiliarize yourself with the common reconciliation processes at Adyen.\n\nGo live\nTo take your Adyen for Platforms integration live, you need to apply for a live account. When you have your live account, follow the steps below to take your integration live.\n\nReplicate your test account setup\nThe setup from your test Adyen for Platforms account is not replicated to your live Adyen for Platforms account automatically.\nUpdate your code base\nSwitch to live API credentials\nGet your live API credentials from your Adyen contact. Use these credentials in your live account.\nSwitch from test to live endpoints\nChange the endpoints from test to live. For example, https:\/\/balanceplatform-api-test.adyen.com\/ to\nhttps:\/\/balanceplatform-api-live.adyen.com\/.\nRun end-to-end tests\n\nLive API credentials: Make your first live API request to make sure that your live API credentials are working.\nLegal entities: Confirm that you can create legal entities.\nAccount holders and balance accounts: Confirm you can create and retrieve account holders and balance accounts.\nPayments:\n\nTest successful payment scenarios.\nTest your error handling scenarios, for example, when payments are declined.\n\nPayouts: Confirm that your scheduled or on-demand payouts are working as expected.\nVerification errors: Test your error handling scenarios when onboarding users.\nWebhooks: Confirm that you can receive and accept webhooks in the live environment.\nReports: Confirm that you can download reports in the live environment.\n\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Marketplaces","lvl2":"Integration and go-live checklist"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/marketplaces","lvl2":"\/pt\/marketplaces\/integration-checklist"},"levels":3,"category":"Marketplaces","category_color":"green","tags":["Integration","go-live","checklist"]}}
