{"title":"Multibanco for API only","category":"default","creationDate":1776961628,"content":"<p>You can add Multibanco to your existing integration. The following instructions show only what you must add to your integration specifically for Multibanco.<\/p>\n<p>If an instruction on this page corresponds with a step in the main integration guide, it includes a link to that corresponding step of the main integration guide.<\/p>\n<h2>Requirements<\/h2>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that you have an existing <a href=\"\/pt\/online-payments\/build-your-integration\/advanced-flow\/?platform=Web&amp;integration=API%20only\">API-only integration<\/a>.<\/td>\n<td> <\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Action handling<\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that your existing integration is set up to <a href=\"\/pt\/online-payments\/build-your-integration\/advanced-flow\/?platform=Web&amp;integration=API%20only#additional-action\">handle the additional action<\/a>. <br> <code>action.type<\/code>: voucher.<\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\"> Before you begin, <a href=\"\/pt\/payment-methods\/add-payment-methods\">add Multibanco in your Customer Area<\/a>. <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>How it works<\/h2>\n<ol>\n<li>The shopper selects Multibanco as the payment method.<\/li>\n<li>The shopper enters their details in the <a href=\"#build-your-payment-form\">payment form that you build<\/a>.<\/li>\n<li>When you make the payment request, you <a href=\"#additional-parameters-payments\">include additional information about the items that the shopper intends to purchase<\/a>.<\/li>\n<li>You fulfill the order by sending items to the shopper.<\/li>\n<\/ol>\n<h2 id=\"build-your-payment-form\">Build your payment form<\/h2>\n<p>Include Multibanco in the list of <a href=\"#get-available-methods\">available payment methods<\/a>.<\/p>\n<p>You do not need to collect any information from the shopper in your payment form.<\/p>\n<div class=\"notices green\">\n<p>You can <a href=\"\/pt\/online-payments\/build-your-integration\/advanced-flow\/?platform=Web&amp;integration=API%2Bonly&amp;version=71#downloading-logos\">download the logo for Multibanco<\/a> to use in your form.<\/p>\n<\/div>\n<h2 id=\"get-available-methods\">Get Multibanco as an available payment method<\/h2>\n<p>When you make the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/paymentMethods\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/paymentMethods<\/a> to <a href=\"\/pt\/online-payments\/build-your-integration\/advanced-flow\/?platform=Web&amp;integration=API%20only#get-available-payment-methods\">get available payment methods<\/a>, specify the following so that Multibanco is included in the response.<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Values<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/paymentMethods#request-countryCode\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">countryCode<\/a><\/td>\n<td><span translate=\"no\"><strong><strong>PT<\/strong><\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/paymentMethods#request-amount-currency\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">amount.currency<\/a><\/td>\n<td><span translate=\"no\"><strong><strong>EUR<\/strong><\/strong><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Example request for available payment methods'\" :id=\"'payment-methods-request'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/checkout-test.adyen.com\\\/v72\\\/paymentMethods \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'idempotency-key: YOUR_IDEMPOTENCY_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X POST\\n-d '{\\n   \\&quot;merchantAccount\\&quot;: \\&quot;ADYEN_MERCHANT_ACCOUNT\\&quot;,\\n   \\&quot;countryCode\\&quot;: \\&quot;PT\\&quot;,\\n   \\&quot;amount\\&quot;: {\\n      \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n\\t  \\&quot;value\\&quot;: 1000\\n   },\\n   \\&quot;shopperLocale\\&quot;: \\&quot;pt-PT\\&quot;\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Example response with Multibanco available'\" :id=\"'payment-methods-response'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"paymentMethods\\\": [\\n        {\\n            \\\"name\\\": \\\"Multibanco\\\",\\n            \\\"type\\\": \\\"multibanco\\\"\\n        }\\n    ]\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2 id=\"additional-parameters-payments\">Add additional parameters to your \/payments request<\/h2>\n<p>You do not need to add any parameters when you <a href=\"\/pt\/online-payments\/build-your-integration\/advanced-flow\/?platform=Web&amp;integration=API%20only#make-a-payment\">make a payment<\/a>.<\/p>\n<h2>Test and go live<\/h2>\n<p>Before you can test Multibanco payments, you need to <a href=\"\/pt\/payment-methods\/add-payment-methods\">submit a request for Multibanco<\/a> in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">test Customer Area<\/a>.<\/p>\n<p>In the test environment, you can simulate a Multibanco payment by promoting the pending payment to a sale.<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">test Customer Area<\/a>.<\/li>\n<li>Go to <strong>Transactions<\/strong> &gt; <strong>Offers<\/strong>.<\/li>\n<li>Select the <strong>PSP reference<\/strong> of the pending Multibanco payment.<\/li>\n<li>Select <strong>Promote offer to sale<\/strong> button.<\/li>\n<\/ol>\n<p>Multibanco payments that have been paid (including test offers that you manually promoted to sale) are under <strong>Transactions<\/strong> &gt; <strong>Payments<\/strong>.<\/p>\n<p>Test the reconciliation process by promoting test payments from offer to sale in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">test Customer Area<\/a>.<\/p>\n<p>Before you can accept live Multibanco payments, you need to <a href=\"\/pt\/payment-methods\/add-payment-methods\">submit a request for Multibanco<\/a> in your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>.<\/p>\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/online-payments\/build-your-integration\/advanced-flow\/?platform=Web&amp;integration=API%20only\"\n                        target=\"_self\"\n                        >\n                    API-only integration guide\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/multibanco\/api-only","articleFields":{"description":"Add Multibanco to your API-only integration.","never_cache_twig":true,"parameters":{"flow":"Advanced","integration_guide_url":"\/online-payments\/build-your-integration\/advanced-flow\/?platform=Web&integration=API%20only","payment_method":"Multibanco","payment_method_type":"multibanco","payment_method_type_capitalized":"Multibanco","tx_variant":"multibanco","tx_variant_capitalized":"Multibanco","country_codes":"<strong>PT<\/strong>","currency_codes":"<strong>EUR<\/strong>","additional_api":"false","api_version":"none","action_type":"voucher","pm_directory":"multibanco","contact":"false"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/multibanco\/api-only","title":"Multibanco for API only","content":"You can add Multibanco to your existing integration. The following instructions show only what you must add to your integration specifically for Multibanco.\nIf an instruction on this page corresponds with a step in the main integration guide, it includes a link to that corresponding step of the main integration guide.\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have an existing API-only integration.\n \n\n\nAction handling\nMake sure that your existing integration is set up to handle the additional action.  action.type: voucher.\n\n\n\nSetup steps\n Before you begin, add Multibanco in your Customer Area. \n\n\n\nHow it works\n\nThe shopper selects Multibanco as the payment method.\nThe shopper enters their details in the payment form that you build.\nWhen you make the payment request, you include additional information about the items that the shopper intends to purchase.\nYou fulfill the order by sending items to the shopper.\n\nBuild your payment form\nInclude Multibanco in the list of available payment methods.\nYou do not need to collect any information from the shopper in your payment form.\n\nYou can download the logo for Multibanco to use in your form.\n\nGet Multibanco as an available payment method\nWhen you make the  \/paymentMethods to get available payment methods, specify the following so that Multibanco is included in the response.\n\n\n\nParameter\nValues\n\n\n\n\n countryCode\nPT\n\n\n amount.currency\nEUR\n\n\n\n\n    \n\n\n    \n\nAdd additional parameters to your \/payments request\nYou do not need to add any parameters when you make a payment.\nTest and go live\nBefore you can test Multibanco payments, you need to submit a request for Multibanco in your test Customer Area.\nIn the test environment, you can simulate a Multibanco payment by promoting the pending payment to a sale.\n\nLog in to your test Customer Area.\nGo to Transactions &gt; Offers.\nSelect the PSP reference of the pending Multibanco payment.\nSelect Promote offer to sale button.\n\nMultibanco payments that have been paid (including test offers that you manually promoted to sale) are under Transactions &gt; Payments.\nTest the reconciliation process by promoting test payments from offer to sale in your test Customer Area.\nBefore you can accept live Multibanco payments, you need to submit a request for Multibanco in your live Customer Area.\nSee also\n\n\n                    API-only integration guide\n                \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Multibanco","lvl3":"Multibanco for API only"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/pt\/payment-methods\/multibanco","lvl3":"\/pt\/payment-methods\/multibanco\/api-only"},"levels":4,"category":"Payment method","category_color":"green","tags":["Multibanco"]},"articleFiles":{"payment-methods-response.json":"<p alt=\"\">payment-methods-response.json<\/p>"}}
