Boleto

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

PROPRIEDADE	TIPO	TAMANHO	OBRIGATÓRIO	DESCRIÇÃO
transactionId	Texto	150	Não	Utilize somente para intenções de venda previamente configuradas
referenceId	Texto	100	Sim	Número de identificação da loja.
amount	Número	16	Sim	Valor da transação sem pontuação. Os dois últimos dígitos são os centavos. (Ex: amount: 100 = R$ 1,00)
description	Texto	300	Não	Descrição da transação.
customer.name	Texto	100	Sim	Nome do pagador.
customer.document	Texto	18	Sim	Número do CPF/CNPJ do pagador.
customer.email	Texto	100	Sim	Email do pagador. Campo obrigatório apenas para clientes de sub.
customer.phoneNumber	Texto	18	Não	Número de telefone do cliente.
address.address	Texto	60	Sim	Endereço do comprador.
address.number	Texto	10	Sim	Número do comprador.
address.complement	Texto	150	Não	Complemento do endereço do comprador.
address.district	Texto	80	Sim	Bairro do comprador.
address.zipcode	Número	8	Sim	CEP do comprador sem formatação. Exemplo: 04549002.
address.city	Texto	30	Sim	Cidade do comprador.
address.state	Texto	2	Sim	Sigla do estado do comprador.
bankSlip.expirationDate	Texto	20	Sim	Data de vencimento do boleto. formato YYYY-MM-DD
bankSlip.instructions	Texto	300	Sim	Instruçõ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.guarantor	Texto	45	Sim	Nome do avalista.
bankSlip.provider	Texto	20	Sim	Nome da instituição financeira : _ BRADESCO _ ITAU _ SANTANDER

{
   "referenceId": "19893211234",
   "amount": "1000",
   "description": "Produto ou serviço",
   "customer": {
      "name": "Comprador",
      "document": "12345678909",
      "email" : "comprador@email.com",
      "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\" : \"comprador@ntk.com\","
        + "    \"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

PROPRIEDADE	TIPO	TAMANHO	DESCRIÇÃO
transactionId	Texto	150	Identificador da transação do GATE2all.
dtTransaction	DataHora	19	Data e hora da transação.
bankSlip.emissionDate	Texto	20	Data de emissão do boleto. formato YYYY-MM-DD
bankSlip.paymentDate	Texto	20	Data de pagamento do boleto. formato YYYY-MM-DD
bankSlip.paymentAmount	Número	16	Valor de pagamento do boleto sem pontuação. Os dois últimos dígitos são os centavos. (Ex: amount: 100 = R$ 1,00)
bankSlip.url	Texto	300	Endereço de acesso da transação.
bankSlip.providerReference	Texto	100	Referência da instituição.
bankSlip.providerCode	Texto	100	Código de resposta da instituição.
bankSlip.providerMessage	Texto	100	Mensagem da instituição.
status	Número	2	tabela 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": "comprador@email.com",
    "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.

Updated 2 months ago

Did this page help you?