Boleto payment request

A boleto payment request is a standard payment request with extra elements to accommodate the boleto form details:

  • amount
  • billingAddress
  • deliveryDate
  • merchantAccount
  • reference
  • selectedBrand – For boleto payments, the corresponding value usually follows this format: boletobancario_<issuer_bank_name>.
  • socialSecurityNumber – The shopper can provide their Cadastro de Pessoas Físicas (CPF) or Cadastro Nacional da Pessoa Jurídica (CNPJ) number, where necessary. This number is added to the Beneficiary field on boleto, along with firstName and lastName values. 
  • shopperName
  • shopperStatement – This is a free-text field where you may give the shopper ad-hoc instructions concerning the payment they are submitting. If you leave it empty, it is populated with the following default Portuguese text:

    Não aceitar pagamento via cheque e/ou após a data do vencimento. 

    Do not accept payment by cheque and/or after the due date.

    Seu pedido será enviado somente após a confirmação do pagamento deste boleto, desde que não tenha divergência de valores entre o valor cobrado e o valor pago.  

    Your 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.

    A falta de pagamento deste boleto não implica em qualquer multa ou juros e o pedido será automaticamente cancelado.

    Failure to pay this boleto will not incur any penalty or interest and your order will be automatically cancelled.

    Não deposite nem faça transferência.

    Do not pay by deposit or bank transfer.

For information on available fields, refer to PaymentRequest.

Code examples

Request

{
    "amount" : {
        "value" : 1000,
        "currency" : "BRL"
    },

    "billingAddress" : {
        "city" : "São Paulo",
        "country" : "BR",
        "houseNumberOrName" : "999",
        "postalCode" : "04787910",
        "stateOrProvince" : "SP",
        "street" : "Roque Petroni Jr"
    },
    
    "deliveryDate" : "2018-10-29T23:00:00.000Z",
    "reference" : "Teste Boleto",
    "merchantAccount" : "TestMerchant",
    "selectedBrand" : "boletobancario_santander",
    
    "shopperName": {
        "firstName" : "José",
        "lastName" : "Silva"
    },
    
    "shopperStatement" : "Aceitar o pagamento até 15 dias após o vencimento.&#xA;Não cobrar juros. Não aceitar o pagamento com cheque",
    "socialSecurityNumber" : "56861752509"
}
<?xml version="1.0" encoding="UTF-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns1:authorise xmlns:ns1="http://payment.services.adyen.com" xmlns:ns2="http://common.services.adyen.com">
      <paymentRequest>
        <amount>
          <ns2:currency>BRL</ns2:currency>
          <ns2:value>1000</ns2:value>
        </amount>
        <billingAddress>
          <ns2:city>São Paulo</ns2:city>
          <ns2:country>BR</ns2:country>
          <ns2:houseNumberOrName>999</ns2:houseNumberOrName>
          <ns2:postalCode>04787910</ns2:postalCode>
          <ns2:stateOrProvince>SP</ns2:stateOrProvince>
          <ns2:street>Roque Petroni Jr</ns2:street>
        </billingAddress>
        <ns1:deliveryDate>2018-10-29T23:00:00.000Z</ns1:deliveryDate>
        <ns1:merchantAccount>TestMerchant</ns1:merchantAccount>
        <ns1:reference>Teste Boleto</ns1:reference>
        <ns1:selectedBrand>boletobancario_santander</ns1:selectedBrand>
        <ns1:shopperName>
          <ns2:firstName>José</ns2:firstName>
          <ns2:lastName>Silva</ns2:lastName>
        </ns1:shopperName>
        <shopperStatement>Aceitar o pagamento até 15 dias após o vencimento.&#xA;Não cobrar juros. Não aceitar o pagamento com cheque.</shopperStatement>
        <socialSecurityNumber>56861752509</socialSecurityNumber>
      </paymentRequest>
    </ns1:authorise>
  </soap:Body>
</soap:Envelope>
amount.value=1000&amount.currency=BRL&billingAddress.city=São+Paulo&billingAddress.country=BR&billingAddress.houseNumberOrName=999&billingAddress.postalCode=04787910&billingAddress.stateOrProvince=SP&billingAddress.street=Roque+Petroni+Jr&deliveryDate=2018-10-29T23:00:00.000Z&merchantAccount=TestMerchant&reference=Teste+Boleto&selectedBrand=boletobancario_santander&shopperName.firstName=José&shopperName.lastName=Silva&shopperStatement=Aceitar+o+pagamento+até+15+dias+após+o+vencimento.%0A+Não+cobrar+juros.+Não+aceitar+o+pagamento+com+cheque.&socialSecurityNumber=56861752509

Aceitar o pagamento até 15 dias após o vencimento.

Não cobrar juros.

Não aceitar o pagamento com cheque.

Accept payment up to 15 days past due.

Do not charge interest.

Do not accept payment by check.

Response

{
    "additionaldata" : {
        "boletobancario.url" : "https://test.adyen.com/hpp/generationBoleto.shtml?data=AgABAQAk5QYbuNl9TiV63c5KeLTvXpB03Ml3krv%2FtwYj....2FFq3920vVWRd5HKHT96mCdVXyo4Gzq%2BTkzNbmT2XcgFf%2FwhYkU4%3D",
        "boletobancario.data" : "AgABAQAk5QYbuNl9TiV63c5KeLTvXpB03Ml3krv/twYj....2FFq3920vVWRd5HKHT96mCdVXyo4Gzq+TkzNbmT2XcgFf/whYkU4=",
        "boletobancario.expirationDate" : "2018-11-14",
        "boletobancario.dueDate" : "2018-10-30"
    },
    
    "pspReference" : "8813760397300101",
    "resultCode" : "Received"
}
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://payment.services.adyen.com">
    <soap:Body>
        <ns1:authoriseResponse>
            <ns1:paymentResult>
                <ns1:additionalData>
                    <ns1:entry>
                        <ns1:key xsi:type="xsd:string">boletobancario.barCodeReference</ns1:key>
                        <ns1:value xsi:type="xsd:string">03399.32225 33897.803304 82223.201027 9 76930000001000</ns1:value>
                    </ns1:entry>
                    <ns1:entry>
                        <ns1:key xsi:type="xsd:string">boletobancario.data</ns1:key>
                        <ns1:value xsi:type="xsd:string">BQABAQBn2luGsOzfTke2whlBTlZS.....TOUZJ7AA356PisDmnQhyxrtAIhyex/SxshWeUvUSgLeQ=</ns1:value>
                    </ns1:entry>
                    <ns1:entry>
                        <ns1:key xsi:type="xsd:string">boletobancario.dueDate</ns1:key>
                        <ns1:value xsi:type="xsd:string">2018-10-30</ns1:value>
                    </ns1:entry>
                    <ns1:entry>
                        <ns1:key xsi:type="xsd:string">boletobancario.url</ns1:key>
                        <ns1:value xsi:type="xsd:string">https://test.adyen.com/hpp/generationBoleto.shtml?data=BQABAQBn2luGsOzfTEA7TmjSS52Re.....nQhyxKrtAeUvUSgLeQ%3D</ns1:value>
                    </ns1:entry>
                    <ns1:entry>
                        <ns1:key xsi:type="xsd:string">boletobancario.expirationDate</ns1:key>
                        <ns1:value xsi:type="xsd:string">2018-11-14</ns1:value>
                    </ns1:entry>
                </ns1:additionalData>
                <ns1:pspReference>7914734540825637</ns1:pspReference>
                <ns1:resultCode>Received</ns1:resultCode>
            </ns1:paymentResult>
        </ns1:authoriseResponse>
    </soap:Body>
</soap:Envelope>
additionalData.boletobancario.url=https://test.adyen.com/hpp/generationBoleto.shtml?data=AgABAQClZUyg1NqsD7nN5X1uqN4mabJ7A3FH5LgAUbqDnJ6EAQlnSAVL%2Bu7eWIXY%2Fo%2B7F0v04ZEnh6VR%2F%2BIAUfJoMQba2uHb2%2BqezXU%2FhgULKuFov7s2ZnwmszAuuHgE6JvahvWtAygC5lnpLEgw34pp7z8Vf2hAQYO9mvELei6ZR8S6DMxVTObYGE6r%2FanhX1ucteKztIR79zv1wWWzV%2FbccQIqgOEp5b8AYU6mwOlbm0oP2lPZofq4CFAQfs%2FROyBk0JBQlQDaZHQRmY8YP3236nD6eEr4cBEy6MpULl8w0iin39NxXGsi7OCmuQDe2w1Fy%2F40Iv6AA2sar3JTo4Ap3eraC6PEN8s5%2BSoOB5MO%2BfpFbRSfFeSHGh9L3%2FwzuxaXCHopNfwjjgx6aJEVv1FmaPzyVYm9kB7%2B%2F1IpaxzBIp6nTh5VSMp8iJOyOccCoV4e7Qv6SKNDkvT5lc2KPXg6jUC4tQJWyFFbvgV55rlQojjRecQfLwCiQ51tONSyaw2QLewemJJys9Q2AyIXYemGUXdzYAORNlSLJkTQdkoQZKdMwuOx4LDPFkNQuzHLlg4Xg%2BpWYhgSz0TEZJrS83voNSRTbrIwOPN3&additionalData.boletobancario.data=AgABAQClZUyg1NqsD7nN5X1uqN4mabJ7A3FH5LgAUbqDnJ6EAQlnSAVL+u7eWIXY/o+7F0v04ZEnh6VR/+IAUfJoMQba2uHb2+qezXU/hgULKuFov7s2ZnwmszAuuHgE6JvahvWtAygC5lnpLEgw34pp7z8Vf2hAQYO9mvELei6ZR8S6DMxVTObYGE6r/anhX1ucteKztIR79zv1wWWzV/bccQIqgOEp5b8AYU6mwOlbm0oP2lPZofq4CFAQfs/ROyBk0JBQlQDaZHQRmY8YP3236nD6eEr4cBEy6MpULl8w0iin39NxXGsi7OCmuQDe2w1Fy/40Iv6AA2sar3JTo4Ap3eraC6PEN8s5+SoOB5MO+fpFbRSfFeSHGh9L3/wzuxaXCHopNfwjjgx6aJEVv1FmaPzyVYm9kB7+/1IpaxzBIp6nTh5VSMp8iJOyOccCoV4e7Qv6SKNDkvT5lc2KPXg6jUC4tQJWyFFbvgV55rlQojjRecQfLwCiQ51tONSyaw2QLewemJJys9Q2AyIXYemGUXdzYAORNlSLJkTQdkoQZKdMwuOx4LDPFkNQuzHLlg4Xg+pWYhgSz0TEZJrS83voNSRTbrIwOPN3&additionalData.boletobancario.expirationDate=2013-08-19&additionalData.boletobancario.dueDate=2013-08-12&pspReference=8813760397300101&resultCode=Received