{"title":"Boleto Banc\u00e1rio for API only","category":"default","creationDate":1776961628,"content":"

You can add Boleto Banc\u00e1rio to your existing integration. The following instructions show only what you must add to your integration specifically for Boleto Banc\u00e1rio.<\/p>\n

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.<\/p>\n

Requirements<\/h2>\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nMake sure that you have an existing API-only integration<\/a>.<\/td>\n <\/td>\n<\/tr>\n
Action handling<\/strong><\/td>\nMake sure that your existing integration is set up to handle the additional action<\/a>.
action.type<\/code>: voucher<\/strong>.<\/td>\n		<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\n Before you begin, add Boleto Banc\u00e1rio in your Customer Area<\/a>. <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

How it works<\/h2>\n
    \n
  1. The shopper selects Boleto Banc\u00e1rio as the payment method.<\/li>\n
  2. The shopper enters their details in the payment form that you build<\/a>.<\/li>\n
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase<\/a>.<\/li>\n<\/ol>\n

    Build your payment form<\/h2>\n

    Include Boleto Banc\u00e1rio in the list of available payment methods. Include the following fields to collect information from your shopper in the payment form.<\/p>\n\n\n\n\n\n\n\n
    Fields<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    Personal details<\/td>\nFirst name, last name, and CPF\/CNPJ of the shopper. The CPF\/CNPJ is a unique identifier similar to a social security number. The shopper can provide their Cadastro de Pessoas F\u00edsicas (CPF)<\/a> number or their Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ)<\/a> number.<\/td>\n<\/tr>\n
    Billing address<\/td>\nShopper street, house number or name, city, postal code, and state or province.<\/td>\n<\/tr>\n
    Shopper email<\/td>\nThe shopper's email address so that you can send them a copy of the form details.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n

    You can download the logo for Boleto Banc\u00e1rio<\/a> to use in your form.<\/p>\n<\/div>\n

    Get Boleto Banc\u00e1rio as an available payment method<\/h2>\n

    When you make the \/paymentMethods<\/a> to get available payment methods<\/a>, specify the following so that Boleto Banc\u00e1rio is included in the response.<\/p>\n\n\n\n\n\n\n
    Parameter<\/th>\nValues<\/th>\n<\/tr>\n<\/thead>\n
    countryCode<\/a><\/td>\nBR<\/strong><\/td>\n<\/tr>\n
    amount.currency<\/a><\/td>\nBRL<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n
    \n <\/code-sample>\n<\/div>\n

    Add additional parameters to your \/payments request<\/h2>\n

    When you make a payment<\/a>, add the following additional parameters:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    paymentMethod.type<\/td>\n\"-white_check_mark-\"<\/td>\nboletobancario<\/strong><\/td>\n<\/tr>\n
    shopperName<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe shopper's firstName<\/code> and lastName<\/code>.<\/td>\n<\/tr>\n
    billingAddress<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe shopper's city<\/code>, country<\/code>, houseNumberOrName<\/code>, postalCode,stateOrProvince<\/code>, and street<\/code>.<\/td>\n<\/tr>\n
    socialSecurityNumber<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe shopper's CPF or CNPJ number.<\/td>\n<\/tr>\n
    deliveryDate<\/a><\/td>\n<\/td>\nThe due date of the payment, using ISO 8601<\/a> 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.<\/td>\n<\/tr>\n
    shopperEmail<\/a><\/td>\n<\/td>\nThe shopper's email address. This is used for sending the shopper a copy of the payment form.<\/td>\n<\/tr>\n
    shopperStatement<\/a><\/td>\n<\/td>\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.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    If you leave the shopperStatement<\/code> empty, it is populated with the following default Portuguese text:<\/p>\n\n\n\n\n\n\n\n\n
    <\/th>\n<\/th>\n<\/tr>\n<\/thead>\n
    N\u00e3o aceitar pagamento via cheque e\/ou ap\u00f3s a data do vencimento.<\/td>\nDo not accept payment by cheque and\/or after the due date.<\/td>\n<\/tr>\n
    Seu 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.<\/td>\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.<\/td>\n<\/tr>\n
    A falta de pagamento deste boleto n\u00e3o implica em qualquer multa ou juros e o pedido ser\u00e1 automaticamente cancelado.<\/td>\nFailure to pay this boleto will not incur any penalty or interest and your order will be automatically cancelled.<\/td>\n<\/tr>\n
    N\u00e3o deposite nem fa\u00e7a transfer\u00eancia.<\/td>\nDo not pay by deposit or bank transfer.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n

    The response includes the action.type<\/code>: voucher<\/strong>, and the following:<\/p>\n