Referência da API
SiteCentral de AjudaAPI Status
Start typing to search…

Criar Carteira de Cobrança

post
https://{apiHost}/v1/bank_billet_accounts

Cria uma nova carteira de cobrança para emissão de boletos bancários. A carteira precisa ser homologada antes de poder ser utilizada em produção.

Body Params

Informações a serem salvas na carteira de cobrança

string
required
length ≤ 50

Slug da Carteira

uuid | null
required

UID da Conta Financeira. Quando informado, os dados de agência e conta serão preenchidos automaticamente a partir da conta financeira.

integer | null

Próximo Nosso Número. Default: 1

integer | null

Último sequencial da remessa Default: 1

string | null

Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio.

string | null

Digito do Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio.

string | null

Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio.

string | null

Dígito do Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio.

string
length ≤ 30

Código de Remessa

string | null

Local de Pagamento

string
length ≤ 15

Contrato

string
length ≤ 2

Tipo do Contrato

string
required
length ≤ 100

Nome do Beneficiário

string
required
length ≤ 20

CNPJ/CPF do Beneficiário

string | null
required

Rua do Beneficiário

string | null
required

Numero da rua do Beneficiário

string | null
required

Complemento do endereço do Beneficiário

string | null
required

Bairro do Beneficiário

string | null
required

Cidade do Beneficiário

string | null
required

Estado do Beneficiário

string | null
required

CEP do Beneficiário (formato 99999999)

bolepix
object | null

Configuração de Boleto Híbrido

string
length ≤ 255

Nome da Conta. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem

configuration
object | null

Configuração de dados padrões para boleto

string
length ≤ 255

Nome da Carteira para identificação dentro da Kobana.

string
enum

Tipo de CNAB:

  • cnab400 CNAB 400
  • cnab240 CNAB 240
Allowed:
boolean | null

Desabilita geração de remessas.

boolean | null

Permitir vencimento em fim de semana e feriados

Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Updated 6 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago