O boleto bancário ou bloqueto é um método de pagamento de produtos ou serviços. É amplamente utilizado por empresas no Brasil.

Entidades envolvidas: “Banco” que são as instituições financeiras responsáveis pela emissão, recebimento e pagamento do boleto, “Cedente” é quem solicita a emissão do documento de cobrança e o que receberá o valor do pagamento e o “Sacado” que é consumidor do produto ou serviço, ou seja, quem paga o boleto.

Como é o processo de pagamento com boleto bancário:

  • Cedente encaminha para o Sacado o Boleto
  • Sacado efetua o pagamento até a data de vencimento estipulada.
  • Banco recebe o valor e repassa para conta do Cedente.
  • Banco aplica a taxa acordada entre as partes.

REQUISIÇÃO

🚧

POST

/v1/transactions

PROPRIEDADETIPOTAMANHOOBRIGATÓRIODESCRIÇÃO
transactionIdTexto150NãoUtilize somente para intenções de venda previamente configuradas
referenceIdTexto100SimNúmero de identificação da loja.
amountNúmero16SimValor da transação sem pontuação. Os dois últimos dígitos são os centavos. (Ex: amount: 100 = R$ 1,00)
descriptionTexto300NãoDescrição da transação.
customer.nameTexto100SimNome do pagador.
customer.documentTexto18SimNúmero do CPF/CNPJ do pagador.
customer.emailTexto100SimEmail do pagador.
Campo obrigatório apenas para clientes de sub.
customer.phoneNumberTexto18NãoNúmero de telefone do cliente.
address.addressTexto60SimEndereço do comprador.
address.numberTexto10SimNúmero do comprador.
address.complementTexto150NãoComplemento do endereço do comprador.
address.districtTexto80SimBairro do comprador.
address.zipcodeNúmero8SimCEP do comprador sem formatação.
Exemplo: 04549002.
address.cityTexto30SimCidade do comprador.
address.stateTexto2SimSigla do estado do comprador.
bankSlip.expirationDateTexto20SimData de vencimento do boleto. formato YYYY-MM-DD
bankSlip.instructionsTexto300SimInstruções do boleto.
Para o Itaú a quantidade máxima de caracteres será: 180, e o texto será truncado em 3 partes de 60 caracteres.
bankSlip.guarantorTexto45SimNome do avalista.
bankSlip.providerTexto20SimNome da instituição financeira :

** BRADESCO
_ ITAU
_ SANTANDER**
{
   "referenceId": "19893211234",
   "amount": "1000",
   "description": "Produto ou serviço",
   "customer": {
      "name": "Comprador",
      "document": "12345678909",
      "email" : "[email protected]",
      "phoneNumber" : "1199922322322",
      "address" : {
          "address" : "Endereco",
          "number" : "100",
          "complement": "Apartamento 22",
          "district" : "Vila Olimpia",
          "zipcode" : "09878675",
          "city" : "Sao Paulo",
          "state" : "SP"
      }
   },
   "payment": {
       "bankSlip" : {
            "expirationDate" :"2020-12-10",
            "instructions" : "Aceitar somente até a data de vencimento, após essa data juros de 1% dia",
            "guarantor" : "Comprador",
            "provider":"Itau"
       }
    }
}
import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

URL obj = new URL("https://api.gate2all.com.br/v1/transactions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setRequestMethod("POST");
con.setRequestProperty("content-type", "application/json");
con.setRequestProperty("authenticationApi", "demo");
con.setRequestProperty("authenticationKey", "demo");

String body = "{"
        + "\"referenceId\": \"123456789\","
        + "\"amount\": \"1000\","
        + "\"description\": \"TV LG 42\","
        + "\"postBackUrl\": \"http://url-notificacao\","
        + "\"customer\": {"
        + "    \"name\": \"COMPRADOR TEST\","
        + "    \"document\": \"12345678909\","
        + "    \"email\" : \"[email protected]\","
        + "    \"address\" : {"
        + "        \"address\" : \"Rua Fidencio Ramos\","
        + "        \"number\": \" 100\","
        + "        \"complement\": \"Apartamento 22\","
        + "        \"district\" : \"Vila Olimpia\","
        + "        \"zipcode\" : \"05890090\","
        + "        \"city\" : \"Sao Paulo\","
        + "        \"state\" : \"SP\""
        + "        }"
        + "    },"
        + "    \"payment\": {"
        + "        \"bankSlip\" : {"
        + "            \"expirationDate\" :\"2020-12-10\","
        + "            \"instructions\" : \"Aceitar somente ate a data de vencimento, apos essa data juros de 1% dia\","
        + "            \"guarantor\" : \"Joao da Silva\","
        + "            \"provider\":\"Itau\""
        + "        }"
        + "    }"
        + "}";

con.setDoOutput(true);
DataOutputStream dos = new DataOutputStream(con.getOutputStream());
dos.writeBytes(body);
dos.flush();
dos.close();

Scanner scanner = new Scanner(new BufferedReader(new InputStreamReader(con.getInputStream())));
String response = scanner.nextLine();
scanner.close();

System.out.println(response);

RESPOSTA

PROPRIEDADETIPOTAMANHODESCRIÇÃO
transactionIdTexto150Identificador da transação do GATE2all.
dtTransactionDataHora19Data e hora da transação.
bankSlip.emissionDateTexto20Data de emissão do boleto. formato YYYY-MM-DD
bankSlip.paymentDateTexto20Data de pagamento do boleto. formato YYYY-MM-DD
bankSlip.paymentAmountNúmero16Valor de pagamento do boleto sem pontuação. Os dois últimos dígitos são os centavos. (Ex: amount: 100 = R$ 1,00)
bankSlip.urlTexto300Endereço de acesso da transação.
bankSlip.providerReferenceTexto100Referência da instituição.
bankSlip.providerCodeTexto100Código de resposta da instituição.
bankSlip.providerMessageTexto100Mensagem da instituição.
statusNúmero2tabela de Status
{
  "transactionId": "7365ca65-70d4-4d7c-ac3d-a20f5730c241",
  "referenceId": "19893211234",
  "amount": "1000",
  "description": "Produto ou serviço",
  "dtTransaction": "2020-12-08T10:46:31-0300",
  "customer": {
    "name": "Comprador",
    "document": "12345678909",
    "email": "[email protected]",
    "address": {
      "address": "Endereco",
      "number": "100",
      "complement": "Apartamento 22",
      "district": "Vila Olimpia",
      "zipcode": "09878675",
      "city": "Sao Paulo",
      "state": "SP"
    }
  },
  "payment": {
    "bankSlip": {
      "providerReference": "20575112",
      "providerCode": "00",
      "providerMessage": "Transação iniciada",
      "emissionDate": "2020-12-08",
      "expirationDate": "2020-12-10",
      "instructions": "Aceitar somente até a data de vencimento, após essa data juros de 1% dia",
      "guarantor": "Comprador",
      "provider": "ITAU",
      "paymentDate": "2020-12-08",
      "paymentAmount": "100",
      "url": "https://api.gate2all.com.br/v1/payment/6400d988-cc4b-4084-80ee-d5575dbbed4d"
    }
  },
  "status": 0
}

🚧

Ao gerar uma transação com boleto, existindo uma configuração padrão para Pix, esta será incluída automaticamente.