bank_contract_slugstring required
next_our_numberinteger nullable
Próximo Nosso Número. Default: 1
next_remittance_numberinteger nullable
Último sequencial da remessa Default: 1
agency_numberstring required
agency_digitstring nullable
Dígito da Agência. Opcional: será calculado automaticamente usando Módulo 11 quando o banco exigir e não for fornecido.
account_numberstring required
account_digitstring required
extra1string nullable
Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio.
extra1_digitstring nullable
Digito do Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio.
extra2string nullable
Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio.
extra2_digitstring nullable
Dígito do Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio.
payment_placestring nullable
beneficiary_namestring required
beneficiary_cnpj_cpfstring required
beneficiary_address_streetstring nullable required
beneficiary_address_street_numberstring nullable required
Numero da rua do Beneficiário
beneficiary_address_complementstring nullable required
Complemento do endereço do Beneficiário
beneficiary_address_neighborhoodstring nullable required
beneficiary_address_citystring nullable required
beneficiary_address_statestring nullable required
beneficiary_address_zipcodestring nullable required
CEP do Beneficiário (formato 99999999)
beneficiary_addressstring nullable required
Endereço completo do Beneficiário.
bolepix_enabled_atstring nullable
Data e Hora em que o boleto híbrido foi habilitado.
namestring
Nome da Conta. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem
status'pending' | 'homologating' | 'validating' | 'active'
Situação da carteira:
Quando a carteira acaba de ser cadastrada, ela ganha o status pending.
Nesse momento o usuário deve aceitar os termos e iniciar a homologação.
Ao clicar em “Prosseguir com a Homologação”, o status passa para homologating.
Será gerado um boleto e uma remessa de Homologação para ser enviada ao banco. Após o término, o status passa para validating.
A partir desse momento o usuário precisa informar o valor do boleto que foi gerado ou enviar o retorno processado pelo banco.
Quando o valor é informado corretamente, ou no retorno processado, o banco diz estar tudo certo, o status passa para active.
- pending Homologação não iniciada
- homologating Em homologação, aguardando pagamento do boleto
- validating Boleto pago, aguardando validação
- active Ativa e pronta para uso
defaultboolean nullable
Padrão.
O campo default determina a carteira de cobrança que será usada na criação do boleto quando nenhuma carteira for informada.
No momento que a primeira carteira é homologada (passa para o status = active), ela recebe o valor default = true
configurationobject nullable
Configuração de dados padrões para boleto
bank_contractobject
Dados da Carteira. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem.
custom_namestring
Nome da Carteira para identificação dentro da Kobana.
kind'cnab400' | 'cnab240'
Tipo de CNAB:
- cnab400 CNAB 400
- cnab240 CNAB 240
remittance_disabledboolean nullable
Desabilita geração de remessas.
remittance_disabled_atstring date-time nullable
Data e hora em que a geração de remessa foi desabilitada.
allow_expiration_on_weekendsboolean nullable
Permitir vencimento em fim de semana e feriados
created_atstring date-time nullable
Data e hora de criação da carteira
updated_atstring date-time nullable
Data e hora da última atualização da carteira
created_via_apiboolean nullable
Indica se a carteira foi criada por API