34 - Registro Boleto CNAB

Realiza o upload de um arquivo de remessa no padrão CNAB 400.

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --form ArquivoDto.Arquivo='@example-file' \
  --form 'ContaDto.Agencia=<string>' \
  --form 'ContaDto.AgenciaDigito=<string>' \
  --form 'ContaDto.Conta=<string>' \
  --form 'ContaDto.ContaDigito=<string>' \
  --form 'ContaDto.ContaPgto=<string>' \
  --form 'NumeroCedente=<string>' \
  --form 'NumeroCarteira=<string>' \
  --form InstrucaoViaAprovacao=true

import requests

url = "https://api.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo"

files = { "ArquivoDto.Arquivo": ("example-file", open("example-file", "rb")) }
payload = {
    "ContaDto.Agencia": "<string>",
    "ContaDto.AgenciaDigito": "<string>",
    "ContaDto.Conta": "<string>",
    "ContaDto.ContaDigito": "<string>",
    "ContaDto.ContaPgto": "<string>",
    "NumeroCedente": "<string>",
    "NumeroCarteira": "<string>",
    "InstrucaoViaAprovacao": "true"
}
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "IgnoraHandshake": "<ignorahandshake>",
    "Authorization": "<api-key>"
}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('ArquivoDto.Arquivo', '<string>');
form.append('ContaDto.Agencia', '<string>');
form.append('ContaDto.AgenciaDigito', '<string>');
form.append('ContaDto.Conta', '<string>');
form.append('ContaDto.ContaDigito', '<string>');
form.append('ContaDto.ContaPgto', '<string>');
form.append('NumeroCedente', '<string>');
form.append('NumeroCarteira', '<string>');
form.append('InstrucaoViaAprovacao', 'true');

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    IgnoraHandshake: '<ignorahandshake>',
    Authorization: '<api-key>'
  }
};

options.body = form;

fetch('https://api.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo', 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.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ArquivoDto.Arquivo\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Agencia\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.AgenciaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Conta\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaPgto\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCedente\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCarteira\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"InstrucaoViaAprovacao\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data",
    "IdempotencyKey: <idempotencykey>",
    "IgnoraHandshake: <ignorahandshake>"
  ],
]);

$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.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ArquivoDto.Arquivo\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Agencia\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.AgenciaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Conta\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaPgto\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCedente\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCarteira\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"InstrucaoViaAprovacao\"\r\n\r\ntrue\r\n-----011000010111000001101001--")

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

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
	req.Header.Add("Authorization", "<api-key>")

	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.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("IgnoraHandshake", "<ignorahandshake>")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ArquivoDto.Arquivo\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Agencia\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.AgenciaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Conta\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaPgto\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCedente\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCarteira\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"InstrucaoViaAprovacao\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo")

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

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ArquivoDto.Arquivo\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Agencia\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.AgenciaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Conta\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaPgto\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCedente\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCarteira\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"InstrucaoViaAprovacao\"\r\n\r\ntrue\r\n-----011000010111000001101001--"

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

{
  "sucesso": true,
  "mensagem": "<string>",
  "jsonErros": "<string>",
  "codigoImportaArquivo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

Realiza o upload de um arquivo de remessa no padrão CNAB 400.

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --form ArquivoDto.Arquivo='@example-file' \
  --form 'ContaDto.Agencia=<string>' \
  --form 'ContaDto.AgenciaDigito=<string>' \
  --form 'ContaDto.Conta=<string>' \
  --form 'ContaDto.ContaDigito=<string>' \
  --form 'ContaDto.ContaPgto=<string>' \
  --form 'NumeroCedente=<string>' \
  --form 'NumeroCarteira=<string>' \
  --form InstrucaoViaAprovacao=true

import requests

url = "https://api.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo"

files = { "ArquivoDto.Arquivo": ("example-file", open("example-file", "rb")) }
payload = {
    "ContaDto.Agencia": "<string>",
    "ContaDto.AgenciaDigito": "<string>",
    "ContaDto.Conta": "<string>",
    "ContaDto.ContaDigito": "<string>",
    "ContaDto.ContaPgto": "<string>",
    "NumeroCedente": "<string>",
    "NumeroCarteira": "<string>",
    "InstrucaoViaAprovacao": "true"
}
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "IgnoraHandshake": "<ignorahandshake>",
    "Authorization": "<api-key>"
}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('ArquivoDto.Arquivo', '<string>');
form.append('ContaDto.Agencia', '<string>');
form.append('ContaDto.AgenciaDigito', '<string>');
form.append('ContaDto.Conta', '<string>');
form.append('ContaDto.ContaDigito', '<string>');
form.append('ContaDto.ContaPgto', '<string>');
form.append('NumeroCedente', '<string>');
form.append('NumeroCarteira', '<string>');
form.append('InstrucaoViaAprovacao', 'true');

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    IgnoraHandshake: '<ignorahandshake>',
    Authorization: '<api-key>'
  }
};

options.body = form;

fetch('https://api.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo', 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.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ArquivoDto.Arquivo\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Agencia\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.AgenciaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Conta\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaPgto\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCedente\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCarteira\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"InstrucaoViaAprovacao\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data",
    "IdempotencyKey: <idempotencykey>",
    "IgnoraHandshake: <ignorahandshake>"
  ],
]);

$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.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ArquivoDto.Arquivo\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Agencia\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.AgenciaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Conta\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaPgto\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCedente\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCarteira\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"InstrucaoViaAprovacao\"\r\n\r\ntrue\r\n-----011000010111000001101001--")

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

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
	req.Header.Add("Authorization", "<api-key>")

	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.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("IgnoraHandshake", "<ignorahandshake>")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ArquivoDto.Arquivo\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Agencia\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.AgenciaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Conta\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaPgto\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCedente\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCarteira\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"InstrucaoViaAprovacao\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ext.dbs.moneyp.dev.br/api/Arquivo/EnviarArquivo")

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

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ArquivoDto.Arquivo\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Agencia\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.AgenciaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.Conta\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaDigito\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ContaDto.ContaPgto\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCedente\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"NumeroCarteira\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"InstrucaoViaAprovacao\"\r\n\r\ntrue\r\n-----011000010111000001101001--"

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

{
  "sucesso": true,
  "mensagem": "<string>",
  "jsonErros": "<string>",
  "codigoImportaArquivo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

Por meio deste endpoint, o parceiro pode enviar um arquivo do tipo CNAB 400 para efetuar registros de boletos em lote.

Antes de efetuar o registro do boleto é necessário que o emissor tenha um número de cedente vinculado a conta e uma carteira registrada, sendo carteira “1” para boleto simples e “9” para CNAB que é a situação que se aplica neste endpoint. O registro do cedente deve ser realizado no endpoint /api/Cedente e o vínculo do cedente a uma carteira deve ser realizado no endpoint /api/Cedente/AdicionarCarteira.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Endpoint	Mensagem de erro
/api/Arquivo/EnviarArquivo	Extensão de arquivo inválida. Arquivo deve ser do tipo ‘.zip’ ou ’.REM’
/api/Arquivo/EnviarArquivo	Tipo de arquivo não implementado
/api/Arquivo/EnviarArquivo
/api/Arquivo/EnviarArquivo	Operador sem parceiro cadastrado
/api/Arquivo/EnviarArquivo
/api/Arquivo/EnviarArquivo	O modelo conta deve ser informado
/api/Arquivo/EnviarArquivo
/api/Arquivo/EnviarArquivo	Número do Cedente ou da Carteira Inválido
/api/Arquivo/EnviarArquivo	Não é possível importar o arquivo. Verifique a situação do cedente
/api/Arquivo/EnviarArquivo	Não existe cedente ativo para a conta informada
/api/Arquivo/EnviarArquivo	Número do Cedente informado não corresponde ao cedente relacionado a conta informada
/api/Arquivo/EnviarArquivo	Número da Carteira não encontrada
/api/Arquivo/EnviarArquivo	Relação Cedente x Carteira não encontrada
/api/Arquivo/EnviarArquivo	Cedente x Carteira não permite importação de arquivos CNAB
/api/Arquivo/EnviarArquivo	Conteúdo arquivo em branco ou inválido
/api/Arquivo/EnviarArquivo	Layout do arquivo CNAB inconsistente

Autorizações

Authorization

string

header

obrigatório

Copie 'Bearer ' + token

Cabeçalhos

IdempotencyKey

string

obrigatório

IgnoraHandshake

boolean

padrão:true

obrigatório

(somente em homologação)

Corpo

multipart/form-data

ArquivoDto.TipoArquivo

enum<integer>

obrigatório

Tipo arquivo.*

Valores: 1 - CNAB 240 2 - CNAB 400

Opções disponíveis:

1,

2

ArquivoDto.Arquivo

file

obrigatório

Arquivo.*

ContaDto.Agencia

string

Número da agência bancária.*

Observações:

O número da agência pode ter no máximo 4 caracteres.

ContaDto.AgenciaDigito

string

Dígito verificador da agência bancária.

Observações:

O dígito verificador da agência bancária pode ter no máximo 1 caracter.

ContaDto.Conta

string

Número da conta bancária.

Observações:

O número da conta bancária pode ter no máximo 12 caracteres.
Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (contaPgto) ou o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
Caso o 'número da conta com dígito' (contaPgto) seja informado, não é necessário preencher os campos 'número da conta' (conta) e 'dígito verificador' (contaDigito).
Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital.

ContaDto.ContaDigito

string

Dígito verificador do número da conta bancária.

Observações:

O dígito verificador do número da conta bancária pode ter no máximo 1 caracter.

ContaDto.ContaPgto

string

Número da conta bancária seguido do dígito verificador.

Observações:

O número da conta seguido do dígito verificador pode ter no máximo 20 caracteres.

ContaDto.TipoConta

enum<integer>

Tipo da conta.*

Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario

Opções disponíveis:

1,

2,

3,

4

ContaDto.ModeloConta

enum<integer>

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Opções disponíveis:

1,

2,

3

NumeroCedente

string

Código de identificação do correntista cadastrado junto a CIP.*

Maximum string length: 19

NumeroCarteira

string

Número de identificação do tipo padrão de emissão de boleto.*

Observação:

O número de identificação do tipo padrão de emissão de boleto pode ter no máximo 10 caracteres.

InstrucaoViaAprovacao

boolean

Instrucao via aprovacao.

Resposta

Success

sucesso

boolean

mensagem

string | null

jsonErros

string | null

Variável de retorno que contém uma lista de erros ocorridos durante a execução de uma operação.

codigoImportaArquivo

string<uuid>

UUID de retorno que contém um código único de importação de arquivo.

33 - Transferência tipo TED 35 - Consulta de Pagamento e Registro de Boleto

Guia Inicial

Guia do Desenvolvedor

Referências de API

Layouts de CNAB

34 - Registro Boleto CNAB

Autorizações

Cabeçalhos

Corpo

Resposta