{"title":"Application information","category":"default","creationDate":1680886380,"content":"<p>Adyen requires technology partners to include application information in API requests. When you send application information, we can help you do the following:<\/p>\n<ul>\n<li>Track payouts efficiently.<\/li>\n<li>Provide valuable performance insights.<\/li>\n<li>Offer improved operational support.<\/li>\n<li>Understand your partnership type.<\/li>\n<\/ul>\n<h2>Partnership type<\/h2>\n<p>The application fields that you send depends on your partnership type.<\/p>\n<ul>\n<li>Technology partner (also known as solution or product provider): you own the global product brand for solutions like point-of-sale (POS), enterprise resource planning (ERP), kiosk, mobile, or ecommerce. Your products are used by other partners and merchants.<\/li>\n<li>Service partner or system integrator (SI): you are a service partner or system integrator if you integrate or implement third-party product solutions for merchants. This includes strategic consulting, custom integration, implementation, or field services.<\/li>\n<\/ul>\n<h2>Send application information<\/h2>\n<p>To send application information, include the <code>applicationInfo<\/code> object in your API requests to Adyen. For example, the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> request, the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/sessions\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/sessions<\/a> request, or <a href=\"\/pt\/point-of-sale\/basic-tapi-integration\/pass-application-information\/\">requests from your in-person payments IPP integration<\/a>.<\/p>\n<p>You can use the following example to help you identify which application info fields to send in. This example includes the descriptions of the partner types and cases that show what application information to send.<\/p>\n<div class=\"notices yellow\">\n<p>You are required to send application information. If you do not, we are limited on how we can help you troubleshoot issues with your integration.<\/p>\n<\/div>\n<h3>Technology partner<\/h3>\n<p>In this example, the technology partner is a company called <strong>Vend Vantage Solutions<\/strong> that provides a suite of products called <strong>adVantage Commerce Suite<\/strong> that includes products called <strong>adVantage POS<\/strong> (point-of-sale software) and <strong>adVantage Digital<\/strong> (ecommerce software).<\/p>\n<div id=\"mermaid-69ea606f3111f-wrapper\"><div id=\"mermaid-69ea606f3111f\" class=\"mermaid-shortcode loading\">CmdyYXBoIFRECiAgICBBWyJUZWNobm9sb2d5IHBhcnRuZXI8YnIvPihmb3IgZXhhbXBsZSwgVmVuZCBWYW50YWdlIFNvbHV0aW9ucykiXSAtLSBZb3UgYnVpbGQgLS0+IEJbIllvdXIgcHJvZHVjdC9wbGF0Zm9ybTxici8+KGZvciBleGFtcGxlLCBhZFZhbnRhZ2UgQ29tbWVyY2UgU3VpdGUgPGJyLz53aXRoIHRoZSBwcm9kdWN0cyBhZFZhbnRhZ2UgUE9TIGFuZCBhZFZhbnRhZ2UgRGlnaXRhbCkiXTsKICAgIENbIk1lcmNoYW50Il0gLS0gVXNlcyB5b3VyIHByb2R1Y3RzIC0tPiBCOwogICAgQiAtLSAiU2VuZHMgQVBJIHJlcXVlc3RzPGJyLz4oaW5jbHVkZXMgJ2FwcGxpY2F0aW9uSW5mbycpIiAtLT4gRFsoIkFkeWVuIildOwogICAgc3R5bGUgRCBmaWxsOiMwYWJmNTMsc3Ryb2tlOiMwNzhmM2UsY29sb3I6I2ZmZgo=<\/div><\/div>\n<p>If you are a technology partner, include the following fields.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<th>Example<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>applicationInfo.externalPlatform.name<\/code><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The name of your product platform. If the product does not have a platform name, use your company name.<\/td>\n<td><strong>adVantage_Commerce_Suite<\/strong><\/td>\n<\/tr>\n<tr>\n<td><code>applicationInfo.merchantApplication.name<\/code><\/td>\n<td><\/td>\n<td>The name of the specific product that uses Adyen services.<\/td>\n<td><strong>adVantage_POS<\/strong> or <strong>adVantage_Digital<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>The following example shows a payment request with the <code>applicationInfo<\/code> fields.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Example of a payments request with application info for a technology partner'\" :id=\"'application-info-solution'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/checkout-test.adyen.com\\\/checkout\\\/v72\\\/payments \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X POST\\n-d '{\\n   \\&quot;applicationInfo\\&quot;: {\\n      \\&quot;externalPlatform\\&quot;: {\\n         \\&quot;name\\&quot;: \\&quot;adVantage_Commerce_Suite\\&quot;\\n      },\\n      \\&quot;merchantApplication\\&quot;: {\\n         \\&quot;name\\&quot;: \\&quot;adVantage_Digital\\&quot;\\n      }\\n   },\\n   \\&quot;amount\\&quot;:{\\n      \\&quot;currency\\&quot;:\\&quot;USD\\&quot;,\\n      \\&quot;value\\&quot;:1000\\n   },\\n   \\&quot;reference\\&quot;:\\&quot;YOUR_ORDER_NUMBER\\&quot;,\\n   \\&quot;paymentMethod\\&quot;:{\\n      \\&quot;type\\&quot;: \\&quot;scheme\\&quot;,\\n      \\&quot;encryptedCardNumber\\&quot;: \\&quot;test_4111111111111111\\&quot;,\\n      \\&quot;encryptedExpiryMonth\\&quot;: \\&quot;test_03\\&quot;,\\n      \\&quot;encryptedExpiryYear\\&quot;: \\&quot;test_2030\\&quot;,\\n      \\&quot;encryptedSecurityCode\\&quot;: \\&quot;test_737\\&quot;,\\n      \\&quot;holderName\\&quot;: \\&quot;S. Hopper\\&quot;\\n   },\\n   \\&quot;returnUrl\\&quot;: \\&quot;https:\\\/\\\/your-company.example.com\\\/...\\&quot;,\\n   \\&quot;merchantAccount\\&quot;:\\&quot;ADYEN_MERCHANT_ACCOUNT\\&quot;\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h3>Service partner or system integrator (SI)<\/h3>\n<p>In this example, there are two service partners or system integrators:<\/p>\n<ul>\n<li><strong>Vend Consulting<\/strong><\/li>\n<li><strong>Vend Global Services<\/strong><\/li>\n<\/ul>\n<div id=\"mermaid-69ea606f3112b-wrapper\"><div id=\"mermaid-69ea606f3112b\" class=\"mermaid-shortcode loading\">CmdyYXBoIFRECiAgICBBWyJNZXJjaGFudCJdIC0tIEhpcmVzIHlvdSAtLT4gQlsiU2VydmljZSBwYXJ0bmVyL2ludGVncmF0b3I8YnIvPihmb3IgZXhhbXBsZSwgVmVuZCBDb25zdWx0aW5nIG9yIFZlbmQgR2xvYmFsIFNlcnZpY2VzKSJdOwogICAgQSAtLSBVc2VzIC0tPiBDWyJUaGlyZC1wYXJ0eSBwcm9kdWN0PGJyLz4oZm9yIGV4YW1wbGUsIGFuIGVjb21tZXJjZSBwbHVnaW4pIl07CiAgICBCIC0tICJZb3UgaW50ZWdyYXRlIHdpdGggb3IgcHJvdmlkZSBzZXJ2aWNlcyBvbiIgLS0+IEM7CiAgICBDIC0tICJTZW5kcyBBUEkgcmVxdWVzdHM8YnIvPihpbmNsdWRlcyAnYXBwbGljYXRpb25JbmZvJykiIC0tPiBEWygiQWR5ZW4iKV07CiAgICBzdHlsZSBEIGZpbGw6IzBhYmY1MyxzdHJva2U6IzA3OGYzZSxjb2xvcjojZmZmCg==<\/div><\/div>\n<p>If you are a service provider or system integrator, include the following fields.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<th>Example<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>applicationInfo.externalPlatform.integrator<\/code><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The name of your company or department providing the integration or consulting services.<\/td>\n<td><strong>Vend_Consulting<\/strong> or <strong>Vend_Global_Services<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>The following example shows a payment request with the <code>applicationInfo<\/code> fields.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Example of a payments request with application info for a service partner or SI'\" :id=\"'application-info-service-partner'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/checkout-test.adyen.com\\\/checkout\\\/v72\\\/payments \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X POST\\n-d '{\\n   \\&quot;applicationInfo\\&quot;: {\\n      \\&quot;externalPlatform\\&quot;: {\\n         \\&quot;integrator\\&quot;: \\&quot;Vend_Consulting\\&quot;\\n      }\\n   },\\n   \\&quot;amount\\&quot;: {\\n      \\&quot;currency\\&quot;: \\&quot;USD\\&quot;,\\n      \\&quot;value\\&quot;: 1000\\n   },\\n   \\&quot;reference\\&quot;: \\&quot;YOUR_ORDER_NUMBER\\&quot;,\\n   \\&quot;paymentMethod\\&quot;: {\\n      \\&quot;type\\&quot;: \\&quot;scheme\\&quot;,\\n      \\&quot;encryptedCardNumber\\&quot;: \\&quot;test_4111111111111111\\&quot;,\\n      \\&quot;encryptedExpiryMonth\\&quot;: \\&quot;test_03\\&quot;,\\n      \\&quot;encryptedExpiryYear\\&quot;: \\&quot;test_2030\\&quot;,\\n      \\&quot;encryptedSecurityCode\\&quot;: \\&quot;test_737\\&quot;,\\n      \\&quot;holderName\\&quot;: \\&quot;S. Hopper\\&quot;\\n   },\\n   \\&quot;returnUrl\\&quot;: \\&quot;https:\\\/\\\/your-company.example.com\\\/checkout?shopperOrder=12xy...\\&quot;,\\n   \\&quot;merchantAccount\\&quot;: \\&quot;ADYEN_MERCHANT_ACCOUNT\\&quot;\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h3>Field value requirements<\/h3>\n<p>The values you send in the application info fields can:<\/p>\n<ul>\n<li>Be between up to 40 characters in length.<\/li>\n<li>Start with a number or letter.<\/li>\n<li>Contain letters, digits, dashes, underscores, and spaces.<\/li>\n<\/ul>\n<div class=\"sc-notice note\"><div>\n<p>The formatting of the values must be the same in every request. <br> For example, if the <code>externalPlatform.name<\/code> value is <strong>adVantage_Commerce_Suite<\/strong>, you cannot sometimes use a different value like <strong>adVantage_CommerceSuite<\/strong> or <strong>ADVANTAGECOMMERCESUITE<\/strong>. You must choose one format and use it for every request.<\/p>\n<\/div><\/div>\n<h2>Optional application information fields<\/h2>\n<p>In addition to the required fields for your partnership type, we recommend that you also include additional fields.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<th>Example<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>externalPlatform.version<\/td>\n<td><\/td>\n<td>The version of the platform.<\/td>\n<td>1.0.0<\/td>\n<\/tr>\n<tr>\n<td>merchantApplication.name<\/td>\n<td><\/td>\n<td>The name of the application that the merchant uses.<\/td>\n<td><strong>adVantage_Digital<\/strong><\/td>\n<\/tr>\n<tr>\n<td>merchantApplication.version<\/td>\n<td><\/td>\n<td>The version of the application that the merchant uses.<\/td>\n<td>2.1.0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/development-resources\/libraries\"\n                        target=\"_self\"\n                        >\n                    Libraries\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/partners\/application-information","articleFields":{"description":"Technology partners working with Adyen are required to add application info fields to API requests.","feedback_component":true,"last_edit_on":"17-08-2023 20:34","filters_component":false},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/partners\/application-information","title":"Application information","content":"Adyen requires technology partners to include application information in API requests. When you send application information, we can help you do the following:\n\nTrack payouts efficiently.\nProvide valuable performance insights.\nOffer improved operational support.\nUnderstand your partnership type.\n\nPartnership type\nThe application fields that you send depends on your partnership type.\n\nTechnology partner (also known as solution or product provider): you own the global product brand for solutions like point-of-sale (POS), enterprise resource planning (ERP), kiosk, mobile, or ecommerce. Your products are used by other partners and merchants.\nService partner or system integrator (SI): you are a service partner or system integrator if you integrate or implement third-party product solutions for merchants. This includes strategic consulting, custom integration, implementation, or field services.\n\nSend application information\nTo send application information, include the applicationInfo object in your API requests to Adyen. For example, the  \/payments request, the  \/sessions request, or requests from your in-person payments IPP integration.\nYou can use the following example to help you identify which application info fields to send in. This example includes the descriptions of the partner types and cases that show what application information to send.\n\nYou are required to send application information. If you do not, we are limited on how we can help you troubleshoot issues with your integration.\n\nTechnology partner\nIn this example, the technology partner is a company called Vend Vantage Solutions that provides a suite of products called adVantage Commerce Suite that includes products called adVantage POS (point-of-sale software) and adVantage Digital (ecommerce software).\nCmdyYXBoIFRECiAgICBBWyJUZWNobm9sb2d5IHBhcnRuZXI8YnIvPihmb3IgZXhhbXBsZSwgVmVuZCBWYW50YWdlIFNvbHV0aW9ucykiXSAtLSBZb3UgYnVpbGQgLS0+IEJbIllvdXIgcHJvZHVjdC9wbGF0Zm9ybTxici8+KGZvciBleGFtcGxlLCBhZFZhbnRhZ2UgQ29tbWVyY2UgU3VpdGUgPGJyLz53aXRoIHRoZSBwcm9kdWN0cyBhZFZhbnRhZ2UgUE9TIGFuZCBhZFZhbnRhZ2UgRGlnaXRhbCkiXTsKICAgIENbIk1lcmNoYW50Il0gLS0gVXNlcyB5b3VyIHByb2R1Y3RzIC0tPiBCOwogICAgQiAtLSAiU2VuZHMgQVBJIHJlcXVlc3RzPGJyLz4oaW5jbHVkZXMgJ2FwcGxpY2F0aW9uSW5mbycpIiAtLT4gRFsoIkFkeWVuIildOwogICAgc3R5bGUgRCBmaWxsOiMwYWJmNTMsc3Ryb2tlOiMwNzhmM2UsY29sb3I6I2ZmZgo=\nIf you are a technology partner, include the following fields.\n\n\n\nField\nRequired\nDescription\nExample\n\n\n\n\napplicationInfo.externalPlatform.name\n\nThe name of your product platform. If the product does not have a platform name, use your company name.\nadVantage_Commerce_Suite\n\n\napplicationInfo.merchantApplication.name\n\nThe name of the specific product that uses Adyen services.\nadVantage_POS or adVantage_Digital\n\n\n\nThe following example shows a payment request with the applicationInfo fields.\n\n    \n\nService partner or system integrator (SI)\nIn this example, there are two service partners or system integrators:\n\nVend Consulting\nVend Global Services\n\nCmdyYXBoIFRECiAgICBBWyJNZXJjaGFudCJdIC0tIEhpcmVzIHlvdSAtLT4gQlsiU2VydmljZSBwYXJ0bmVyL2ludGVncmF0b3I8YnIvPihmb3IgZXhhbXBsZSwgVmVuZCBDb25zdWx0aW5nIG9yIFZlbmQgR2xvYmFsIFNlcnZpY2VzKSJdOwogICAgQSAtLSBVc2VzIC0tPiBDWyJUaGlyZC1wYXJ0eSBwcm9kdWN0PGJyLz4oZm9yIGV4YW1wbGUsIGFuIGVjb21tZXJjZSBwbHVnaW4pIl07CiAgICBCIC0tICJZb3UgaW50ZWdyYXRlIHdpdGggb3IgcHJvdmlkZSBzZXJ2aWNlcyBvbiIgLS0+IEM7CiAgICBDIC0tICJTZW5kcyBBUEkgcmVxdWVzdHM8YnIvPihpbmNsdWRlcyAnYXBwbGljYXRpb25JbmZvJykiIC0tPiBEWygiQWR5ZW4iKV07CiAgICBzdHlsZSBEIGZpbGw6IzBhYmY1MyxzdHJva2U6IzA3OGYzZSxjb2xvcjojZmZmCg==\nIf you are a service provider or system integrator, include the following fields.\n\n\n\nField\nRequired\nDescription\nExample\n\n\n\n\napplicationInfo.externalPlatform.integrator\n\nThe name of your company or department providing the integration or consulting services.\nVend_Consulting or Vend_Global_Services\n\n\n\nThe following example shows a payment request with the applicationInfo fields.\n\n    \n\nField value requirements\nThe values you send in the application info fields can:\n\nBe between up to 40 characters in length.\nStart with a number or letter.\nContain letters, digits, dashes, underscores, and spaces.\n\n\nThe formatting of the values must be the same in every request.  For example, if the externalPlatform.name value is adVantage_Commerce_Suite, you cannot sometimes use a different value like adVantage_CommerceSuite or ADVANTAGECOMMERCESUITE. You must choose one format and use it for every request.\n\nOptional application information fields\nIn addition to the required fields for your partnership type, we recommend that you also include additional fields.\n\n\n\nField\nRequired\nDescription\nExample\n\n\n\n\nexternalPlatform.version\n\nThe version of the platform.\n1.0.0\n\n\nmerchantApplication.name\n\nThe name of the application that the merchant uses.\nadVantage_Digital\n\n\nmerchantApplication.version\n\nThe version of the application that the merchant uses.\n2.1.0\n\n\n\nSee also\n\n\n                    Libraries\n                \n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Partners","lvl2":"Application information"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/partners","lvl2":"\/pt\/partners\/application-information"},"levels":3,"category":"","category_color":"","tags":["Application","information"]}}
