\n <\/in-page-filtering>\n<\/div>\n\n <\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/boleto-bancario\/web-component","articleFields":{"description":"Add Boleto Banc\u00e1rio to your Components integration.","never_cache_twig":true,"parameters":{"tx_variant":"boleto","component_class_name":"Boleto Banc\u00e1rio","component_class_lowercase":"boleto","integration":"Components","pm_directory":"boleto","payment_method":"Boleto Banc\u00e1rio","action_type":"voucher"},"filters_component":true,"filters_config_folder":"payment-methods\/boleto-bancario\/web\/component-web"},"algolia":[{"url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/boleto-bancario\/web-component","title":"Boleto Banc\u00e1rio Web Component","content":"Requirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have an existing Sessions flow Web Components integration.\n\n\n\nCheckout API\nMake sure that you use Checkout API v68 or later.\n \n\n\nSetup steps\nBefore you begin, add Boleto Banc\u00e1rio in your Customer Area.\n\n\n\nAdd additional parameters to your \/sessions request\nWhen you create a payment session, add the following parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n shopperName\n\nThe shopper's firstName and lastName.\n\n\n billingAddress\n\nThe shopper's city, country, houseNumberOrName, postalCode,stateOrProvince, and street.\n\n\n socialSecurityNumber\n\nThe shopper's CPF or CNPJ number.\n\n\n deliverAt\n\nCheckout API v68 or laterThe due date of the payment, using ISO 8601 format in UTC. If this is in a weekend or national holiday, the shopper can pay the Boleto the next working day.By default, the shopper has five days to complete the payment.\n\n\n shopperEmail\n\nThe shopper's email address. This is used for sending the shopper a copy of the payment form.\n\n\n shopperStatement\n\nFree-text field with payment instructions. If you include this, make sure to state that you do not accept payments for a higher or lower amount than the original amount, or payments after the due date.\n\n\n\nIf you leave the shopperStatement empty, it is populated with the following default Portuguese text:\n\n\n\n\n\n\n\n\n\nN\u00e3o aceitar pagamento via cheque e\/ou ap\u00f3s a data do vencimento.\nDo not accept payment by cheque and\/or after the due date.\n\n\nSeu pedido ser\u00e1 enviado somente ap\u00f3s a confirma\u00e7\u00e3o do pagamento deste boleto, desde que n\u00e3o tenha diverg\u00eancia de valores entre o valor cobrado e o valor pago.\nYour order will only be processed once the payment of this Boleto has been confirmed and as long as there is no difference between the payable and paid amounts.\n\n\nA falta de pagamento deste boleto n\u00e3o implica em qualquer multa ou juros e o pedido ser\u00e1 automaticamente cancelado.\nFailure to pay this boleto will not incur any penalty or interest and your order will be automatically cancelled.\n\n\nN\u00e3o deposite nem fa\u00e7a transfer\u00eancia.\nDo not pay by deposit or bank transfer.\n\n\n\nImport Boleto Banc\u00e1rio\nWhen you import Adyen Web, include Boleto.\n\n \nAdd additional configuration for Boleto Banc\u00e1rio\nConfigure the Component with the following configuration object:\nYou can add the following optional configuration for collecting the shopper details:\n\nIf you already have the required shopper details, you can turn off the form sections where these details are collected.\nYou can pre-fill some of the fields. To collect the missing details, turn on the corresponding form sections.\n\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\npersonalDetailsRequired\n\nSet to false if you have already collected the shopper's first name, last name, and CPF\/CNPJ (socialSecurityNumber).The CPF\/CNPJ is a unique identifier similar to a social security number. The shopper can provide their Cadastro de Pessoas F\u00edsicas (CPF) number or their Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\n\nbillingAddressRequired\n\nSet this to false if you have already collected the shopper's street, house number or name, city, postal code, and state or province.\n\n\nshowEmailAddress\n\nSet this to false if you have already collected the shopper's email address.\n\n\ndata\n\nObject to pre-fill shopper details on the form: socialSecurityNumber, shopperName, billingAddress, and shopperEmail as shown in the example below. By default this object is empty.\n\n\n\nIf you want to add optional configuration, include this in a configuration object. The following example shows how to configure the Component to remove the shopper details fields and prefill the form.\n\n \n\nInitialize the Component for Boleto Banc\u00e1rio\nTo initialize Boleto Banc\u00e1rio, use the Boleto class.\n\n \n\nTest and go live\nBoleto Banc\u00e1rio is an offline payment method.\n \nIn the test environment, you can simulate a Boleto payment by promoting the pending payment to a sale.\n\nLog in to your test Customer Area.\nGo to Transactions > Offers.\nSelect the PSP reference of the pending Boleto payment.\nSelect the Promote this offer to a sale button.\n\n \nCheck the status of Boleto Banc\u00e1rio test payments in your Customer Area:\n\nBoletos that are pending or that have expired are under Transactions\u00a0>\u00a0Offers.\nBoletos that have been paid (including test offers that you manually promoted to sale) are under Transactions\u00a0>\u00a0Payments.\n\n \nTest the reconciliation process by promoting test payments from offer to sale in your test Customer Area.\n \nBefore you can accept live Boleto Banc\u00e1rio payments, you need to submit a request for Boleto Banc\u00e1rio in your live Customer Area.","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Boleto Banc\u00e1rio","lvl3":"Boleto Banc\u00e1rio Web Component"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/pt\/payment-methods\/boleto-bancario","lvl3":"\/pt\/payment-methods\/boleto-bancario\/web-component"},"levels":4,"category":"Payment method","category_color":"green","tags":["Boleto","Banc\u00e1rio","Component"]},{"url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/boleto-bancario\/web-component?flow=Sessions flow&integration=Component","title":"Sessions flow Component","content":"Requirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have an existing Sessions flow Web Components integration.\n\n\n\nCheckout API\nMake sure that you use Checkout API v68 or later.\n \n\n\nSetup steps\nBefore you begin, add Boleto Banc\u00e1rio in your Customer Area.\n\n\n\nAdd additional parameters to your \/sessions request\nWhen you create a payment session, add the following parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n shopperName\n\nThe shopper's firstName and lastName.\n\n\n billingAddress\n\nThe shopper's city, country, houseNumberOrName, postalCode,stateOrProvince, and street.\n\n\n socialSecurityNumber\n\nThe shopper's CPF or CNPJ number.\n\n\n deliverAt\n\nCheckout API v68 or laterThe due date of the payment, using ISO 8601 format in UTC. If this is in a weekend or national holiday, the shopper can pay the Boleto the next working day.By default, the shopper has five days to complete the payment.\n\n\n shopperEmail\n\nThe shopper's email address. This is used for sending the shopper a copy of the payment form.\n\n\n shopperStatement\n\nFree-text field with payment instructions. If you include this, make sure to state that you do not accept payments for a higher or lower amount than the original amount, or payments after the due date.\n\n\n\nIf you leave the shopperStatement empty, it is populated with the following default Portuguese text:\n\n\n\n\n\n\n\n\n\nN\u00e3o aceitar pagamento via cheque e\/ou ap\u00f3s a data do vencimento.\nDo not accept payment by cheque and\/or after the due date.\n\n\nSeu pedido ser\u00e1 enviado somente ap\u00f3s a confirma\u00e7\u00e3o do pagamento deste boleto, desde que n\u00e3o tenha diverg\u00eancia de valores entre o valor cobrado e o valor pago.\nYour order will only be processed once the payment of this Boleto has been confirmed and as long as there is no difference between the payable and paid amounts.\n\n\nA falta de pagamento deste boleto n\u00e3o implica em qualquer multa ou juros e o pedido ser\u00e1 automaticamente cancelado.\nFailure to pay this boleto will not incur any penalty or interest and your order will be automatically cancelled.\n\n\nN\u00e3o deposite nem fa\u00e7a transfer\u00eancia.\nDo not pay by deposit or bank transfer.\n\n\n\nImport Boleto Banc\u00e1rio\nWhen you import Adyen Web, include Boleto.\n\n \nAdd additional configuration for Boleto Banc\u00e1rio\nConfigure the Component with the following configuration object:\nYou can add the following optional configuration for collecting the shopper details:\n\nIf you already have the required shopper details, you can turn off the form sections where these details are collected.\nYou can pre-fill some of the fields. To collect the missing details, turn on the corresponding form sections.\n\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\npersonalDetailsRequired\n\nSet to false if you have already collected the shopper's first name, last name, and CPF\/CNPJ (socialSecurityNumber).The CPF\/CNPJ is a unique identifier similar to a social security number. The shopper can provide their Cadastro de Pessoas F\u00edsicas (CPF) number or their Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\n\nbillingAddressRequired\n\nSet this to false if you have already collected the shopper's street, house number or name, city, postal code, and state or province.\n\n\nshowEmailAddress\n\nSet this to false if you have already collected the shopper's email address.\n\n\ndata\n\nObject to pre-fill shopper details on the form: socialSecurityNumber, shopperName, billingAddress, and shopperEmail as shown in the example below. By default this object is empty.\n\n\n\nIf you want to add optional configuration, include this in a configuration object. The following example shows how to configure the Component to remove the shopper details fields and prefill the form.\n\n \n\nInitialize the Component for Boleto Banc\u00e1rio\nTo initialize Boleto Banc\u00e1rio, use the Boleto class.\n\n \n\nTest and go live\nBoleto Banc\u00e1rio is an offline payment method.\n \nIn the test environment, you can simulate a Boleto payment by promoting the pending payment to a sale.\n\nLog in to your test Customer Area.\nGo to Transactions > Offers.\nSelect the PSP reference of the pending Boleto payment.\nSelect the Promote this offer to a sale button.\n\n \nCheck the status of Boleto Banc\u00e1rio test payments in your Customer Area:\n\nBoletos that are pending or that have expired are under Transactions\u00a0>\u00a0Offers.\nBoletos that have been paid (including test offers that you manually promoted to sale) are under Transactions\u00a0>\u00a0Payments.\n\n \nTest the reconciliation process by promoting test payments from offer to sale in your test Customer Area.\n \nBefore you can accept live Boleto Banc\u00e1rio payments, you need to submit a request for Boleto Banc\u00e1rio in your live Customer Area.","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Boleto Banc\u00e1rio","lvl3":"Boleto Banc\u00e1rio Web Component"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/pt\/payment-methods\/boleto-bancario","lvl3":"\/pt\/payment-methods\/boleto-bancario\/web-component"},"levels":4,"category":"Payment method","category_color":"green","tags":["Sessions flow","Component"]},{"url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/boleto-bancario\/web-component?flow=Advanced flow&integration=Component","title":"Advanced flow Component","content":"Requirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have an existing Advanced flow Web Components 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\nBefore you begin, add Boleto Banc\u00e1rio in your Customer Area.\n\n\n\nImport Boleto Banc\u00e1rio\nWhen you import Adyen Web, include Boleto.\n\n \nInitialize the Component for Boleto Banc\u00e1rio\nTo initialize Boleto Banc\u00e1rio, use the Boleto class.\n\n \n\nAdd additional parameters to your \/payments request\nWhen you make a payment, add the following parameters to the \/payments request:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\npaymentMethod.type\n\nboletobancario\n\n\n shopperName\n\nThe shopper's firstName and lastName.\n\n\n billingAddress\n\nThe shopper's city, country, houseNumberOrName, postalCode,stateOrProvince, and street.\n\n\n socialSecurityNumber\n\nThe shopper's CPF or CNPJ number.\n\n\n deliveryDate\n\nThe due date of the payment, using ISO 8601 format in UTC. If this is in a weekend or national holiday, the shopper can pay the Boleto the next working day.By default, the shopper has five days to complete the payment.\n\n\n shopperEmail\n\nThe shopper's email address. This is used for sending the shopper a copy of the payment form.\n\n\n shopperStatement\n\nFree-text field with payment instructions. If you include this, make sure to state that you do not accept payments for a higher or lower amount than the original amount, or payments after the due date.\n\n\n\nIf you leave the shopperStatement empty, it is populated with the following default Portuguese text:\n\n\n\n\n\n\n\n\n\nN\u00e3o aceitar pagamento via cheque e\/ou ap\u00f3s a data do vencimento.\nDo not accept payment by cheque and\/or after the due date.\n\n\nSeu pedido ser\u00e1 enviado somente ap\u00f3s a confirma\u00e7\u00e3o do pagamento deste boleto, desde que n\u00e3o tenha diverg\u00eancia de valores entre o valor cobrado e o valor pago.\nYour order will only be processed once the payment of this Boleto has been confirmed and as long as there is no difference between the payable and paid amounts.\n\n\nA falta de pagamento deste boleto n\u00e3o implica em qualquer multa ou juros e o pedido ser\u00e1 automaticamente cancelado.\nFailure to pay this boleto will not incur any penalty or interest and your order will be automatically cancelled.\n\n\nN\u00e3o deposite nem fa\u00e7a transfer\u00eancia.\nDo not pay by deposit or bank transfer.\n\n\n\nThe response includes the action.type: voucher, and the following:\n\npspReference: Our unique reference for the payment.\nresultCode: PresentToShopper\naction: Object containing information about the voucher:\n\ndownloadUrl: Link to the downloadable Boleto in PDF format.\nexpiresAt: The date and time when the due date expires.\npaymentMethodType: Indicates the issuing bank.\nreference: The barcode number for the payment.\ntotalAmount: The currency and value of the amount due.\n\n\nTest and go live\nBoleto Banc\u00e1rio is an offline payment method.\n \nIn the test environment, you can simulate a Boleto payment by promoting the pending payment to a sale.\n\nLog in to your test Customer Area.\nGo to Transactions > Offers.\nSelect the PSP reference of the pending Boleto payment.\nSelect the Promote this offer to a sale button.\n\n \nCheck the status of Boleto Banc\u00e1rio test payments in your Customer Area:\n\nBoletos that are pending or that have expired are under Transactions\u00a0>\u00a0Offers.\nBoletos that have been paid (including test offers that you manually promoted to sale) are under Transactions\u00a0>\u00a0Payments.\n\n \nTest the reconciliation process by promoting test payments from offer to sale in your test Customer Area.\n \nBefore you can accept live Boleto Banc\u00e1rio payments, you need to submit a request for Boleto Banc\u00e1rio in your live Customer Area.","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Boleto Banc\u00e1rio","lvl3":"Boleto Banc\u00e1rio Web Component"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/pt\/payment-methods\/boleto-bancario","lvl3":"\/pt\/payment-methods\/boleto-bancario\/web-component"},"levels":4,"category":"Payment method","category_color":"green","tags":["Advanced flow","Component"]}]}