Pular para o conteúdo principal
POST
/
api
/
Arquivo
/
EnviarArquivo
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.TipoArquivo=1 \
  --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 ContaDto.TipoConta=1 \
  --form ContaDto.ModeloConta=1 \
  --form 'NumeroCedente=<string>' \
  --form 'NumeroCarteira=<string>' \
  --form InstrucaoViaAprovacao=true
{
  "sucesso": true,
  "mensagem": "<string>",
  "jsonErros": "<string>",
  "codigoImportaArquivo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Headers

​
IdempotencyKey
string
required
​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

multipart/form-data
​
ArquivoDto.TipoArquivo
enum<integer>
required

Tipo arquivo.*

Valores: 1 - CNAB 240 2 - CNAB 400

Opções disponíveis:
1,
2
​
ArquivoDto.Arquivo
file
required

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.

Response

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.