15 - Gerar Cobrança

Gera uma nova cobrança (boleto/Pix) para quitação de parcelas.

curl --request POST \
  --url https://api.example.com/contrato/parcela/gerar-cobranca \
  --header 'Content-Type: application/json' \
  --data '
{
  "NumeroContrato": 123,
  "NroParcelas": [
    123
  ],
  "DataVencimento": "2023-11-07T05:31:56Z",
  "DataExpiracao": "2023-11-07T05:31:56Z",
  "Liquidacao": true,
  "DescricaoLiquidacao": "<string>",
  "PagamentoViaBoleto": true,
  "PagamentoViaPIX": true,
  "ValorLiquidacao": 123,
  "ValorDesconto": 123,
  "PermiteDescapitalizacao": true,
  "TipoRegistro": 123
}
'

import requests

url = "https://api.example.com/contrato/parcela/gerar-cobranca"

payload = {
    "NumeroContrato": 123,
    "NroParcelas": [123],
    "DataVencimento": "2023-11-07T05:31:56Z",
    "DataExpiracao": "2023-11-07T05:31:56Z",
    "Liquidacao": True,
    "DescricaoLiquidacao": "<string>",
    "PagamentoViaBoleto": True,
    "PagamentoViaPIX": True,
    "ValorLiquidacao": 123,
    "ValorDesconto": 123,
    "PermiteDescapitalizacao": True,
    "TipoRegistro": 123
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    NumeroContrato: 123,
    NroParcelas: [123],
    DataVencimento: '2023-11-07T05:31:56Z',
    DataExpiracao: '2023-11-07T05:31:56Z',
    Liquidacao: true,
    DescricaoLiquidacao: '<string>',
    PagamentoViaBoleto: true,
    PagamentoViaPIX: true,
    ValorLiquidacao: 123,
    ValorDesconto: 123,
    PermiteDescapitalizacao: true,
    TipoRegistro: 123
  })
};

fetch('https://api.example.com/contrato/parcela/gerar-cobranca', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/contrato/parcela/gerar-cobranca",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'NumeroContrato' => 123,
    'NroParcelas' => [
        123
    ],
    'DataVencimento' => '2023-11-07T05:31:56Z',
    'DataExpiracao' => '2023-11-07T05:31:56Z',
    'Liquidacao' => true,
    'DescricaoLiquidacao' => '<string>',
    'PagamentoViaBoleto' => true,
    'PagamentoViaPIX' => true,
    'ValorLiquidacao' => 123,
    'ValorDesconto' => 123,
    'PermiteDescapitalizacao' => true,
    'TipoRegistro' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/contrato/parcela/gerar-cobranca"

	payload := strings.NewReader("{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    123\n  ],\n  \"DataVencimento\": \"2023-11-07T05:31:56Z\",\n  \"DataExpiracao\": \"2023-11-07T05:31:56Z\",\n  \"Liquidacao\": true,\n  \"DescricaoLiquidacao\": \"<string>\",\n  \"PagamentoViaBoleto\": true,\n  \"PagamentoViaPIX\": true,\n  \"ValorLiquidacao\": 123,\n  \"ValorDesconto\": 123,\n  \"PermiteDescapitalizacao\": true,\n  \"TipoRegistro\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/contrato/parcela/gerar-cobranca")
  .header("Content-Type", "application/json")
  .body("{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    123\n  ],\n  \"DataVencimento\": \"2023-11-07T05:31:56Z\",\n  \"DataExpiracao\": \"2023-11-07T05:31:56Z\",\n  \"Liquidacao\": true,\n  \"DescricaoLiquidacao\": \"<string>\",\n  \"PagamentoViaBoleto\": true,\n  \"PagamentoViaPIX\": true,\n  \"ValorLiquidacao\": 123,\n  \"ValorDesconto\": 123,\n  \"PermiteDescapitalizacao\": true,\n  \"TipoRegistro\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/contrato/parcela/gerar-cobranca")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    123\n  ],\n  \"DataVencimento\": \"2023-11-07T05:31:56Z\",\n  \"DataExpiracao\": \"2023-11-07T05:31:56Z\",\n  \"Liquidacao\": true,\n  \"DescricaoLiquidacao\": \"<string>\",\n  \"PagamentoViaBoleto\": true,\n  \"PagamentoViaPIX\": true,\n  \"ValorLiquidacao\": 123,\n  \"ValorDesconto\": 123,\n  \"PermiteDescapitalizacao\": true,\n  \"TipoRegistro\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "cobrancas": [
    {
      "codigoLiquidacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parcelas": [
        {}
      ]
    }
  ]
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "Erro": "<string>"
}

Gera uma nova cobrança (boleto/Pix) para quitação de parcelas.

curl --request POST \
  --url https://api.example.com/contrato/parcela/gerar-cobranca \
  --header 'Content-Type: application/json' \
  --data '
{
  "NumeroContrato": 123,
  "NroParcelas": [
    123
  ],
  "DataVencimento": "2023-11-07T05:31:56Z",
  "DataExpiracao": "2023-11-07T05:31:56Z",
  "Liquidacao": true,
  "DescricaoLiquidacao": "<string>",
  "PagamentoViaBoleto": true,
  "PagamentoViaPIX": true,
  "ValorLiquidacao": 123,
  "ValorDesconto": 123,
  "PermiteDescapitalizacao": true,
  "TipoRegistro": 123
}
'

import requests

url = "https://api.example.com/contrato/parcela/gerar-cobranca"

payload = {
    "NumeroContrato": 123,
    "NroParcelas": [123],
    "DataVencimento": "2023-11-07T05:31:56Z",
    "DataExpiracao": "2023-11-07T05:31:56Z",
    "Liquidacao": True,
    "DescricaoLiquidacao": "<string>",
    "PagamentoViaBoleto": True,
    "PagamentoViaPIX": True,
    "ValorLiquidacao": 123,
    "ValorDesconto": 123,
    "PermiteDescapitalizacao": True,
    "TipoRegistro": 123
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    NumeroContrato: 123,
    NroParcelas: [123],
    DataVencimento: '2023-11-07T05:31:56Z',
    DataExpiracao: '2023-11-07T05:31:56Z',
    Liquidacao: true,
    DescricaoLiquidacao: '<string>',
    PagamentoViaBoleto: true,
    PagamentoViaPIX: true,
    ValorLiquidacao: 123,
    ValorDesconto: 123,
    PermiteDescapitalizacao: true,
    TipoRegistro: 123
  })
};

fetch('https://api.example.com/contrato/parcela/gerar-cobranca', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/contrato/parcela/gerar-cobranca",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'NumeroContrato' => 123,
    'NroParcelas' => [
        123
    ],
    'DataVencimento' => '2023-11-07T05:31:56Z',
    'DataExpiracao' => '2023-11-07T05:31:56Z',
    'Liquidacao' => true,
    'DescricaoLiquidacao' => '<string>',
    'PagamentoViaBoleto' => true,
    'PagamentoViaPIX' => true,
    'ValorLiquidacao' => 123,
    'ValorDesconto' => 123,
    'PermiteDescapitalizacao' => true,
    'TipoRegistro' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/contrato/parcela/gerar-cobranca"

	payload := strings.NewReader("{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    123\n  ],\n  \"DataVencimento\": \"2023-11-07T05:31:56Z\",\n  \"DataExpiracao\": \"2023-11-07T05:31:56Z\",\n  \"Liquidacao\": true,\n  \"DescricaoLiquidacao\": \"<string>\",\n  \"PagamentoViaBoleto\": true,\n  \"PagamentoViaPIX\": true,\n  \"ValorLiquidacao\": 123,\n  \"ValorDesconto\": 123,\n  \"PermiteDescapitalizacao\": true,\n  \"TipoRegistro\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/contrato/parcela/gerar-cobranca")
  .header("Content-Type", "application/json")
  .body("{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    123\n  ],\n  \"DataVencimento\": \"2023-11-07T05:31:56Z\",\n  \"DataExpiracao\": \"2023-11-07T05:31:56Z\",\n  \"Liquidacao\": true,\n  \"DescricaoLiquidacao\": \"<string>\",\n  \"PagamentoViaBoleto\": true,\n  \"PagamentoViaPIX\": true,\n  \"ValorLiquidacao\": 123,\n  \"ValorDesconto\": 123,\n  \"PermiteDescapitalizacao\": true,\n  \"TipoRegistro\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/contrato/parcela/gerar-cobranca")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    123\n  ],\n  \"DataVencimento\": \"2023-11-07T05:31:56Z\",\n  \"DataExpiracao\": \"2023-11-07T05:31:56Z\",\n  \"Liquidacao\": true,\n  \"DescricaoLiquidacao\": \"<string>\",\n  \"PagamentoViaBoleto\": true,\n  \"PagamentoViaPIX\": true,\n  \"ValorLiquidacao\": 123,\n  \"ValorDesconto\": 123,\n  \"PermiteDescapitalizacao\": true,\n  \"TipoRegistro\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "cobrancas": [
    {
      "codigoLiquidacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parcelas": [
        {}
      ]
    }
  ]
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "Erro": "<string>"
}

Corpo

application/json

NumeroContrato

integer<int64>

obrigatório

Número do contrato.

NroParcelas

integer<int32>[]

obrigatório

Lista de parcelas a serem cobradas.

DataVencimento

string<date-time>

obrigatório

Data de vencimento da cobrança.

DataExpiracao

string<date-time>

obrigatório

Data de expiração da cobrança.

Liquidacao

boolean

obrigatório

Indica se é quitação total do contrato (true = liquidar contrato).

DescricaoLiquidacao

string

obrigatório

Descrição da liquidação (opcional, usado em caso de quitação total).

PagamentoViaBoleto

boolean

Gerar cobrança via Boleto (true/false).

PagamentoViaPIX

boolean

Gerar cobrança via PIX (true/false).

ValorLiquidacao

number<double>

Valor da liquidação (opcional, valor total a liquidar se diferente do calculado).

ValorDesconto

number<double>

Valor do desconto aplicado (opcional).

PermiteDescapitalizacao

boolean

Indica se permite descapitalização (opcional).

TipoRegistro

integer<int32>

Tipo de registro/cobrança (código interno, opcional).

Resposta

cobrancas

object[]

obrigatório

Lista de cobranças geradas.

Show child attributes

Guia Inicial

Métodos de Assinatura

Guia do Desenvolvedor

Referências de API

Guias e Casos de Uso

15 - Gerar Cobrança

Corpo

Resposta