v1

latestOpenAPI 3.1.02026-07-249043961.2 KB

Carteiras de Cobrança

Atualizar a Carteira

Atualiza informações específicas de uma Carteira.

put/v1/bank_billet_accounts/{id}

Path parameters

idstring required

ID da Carteira

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Request body

kind'cnab400' | 'cnab240'

Tipo de CNAB:

cnab400 CNAB 400
cnab240 CNAB 240

bank_contract_slugstring

Slug da Carteira. Carteiras ativas não poderão ter o campo bank_contract_slug alterados.

payment_placestring nullable

Local de Pagamento

custom_namestring

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

allow_expiration_on_weekendsboolean nullable

Permitir vencimento em fim de semana e feriados

beneficiary_namestring

Nome do Beneficiário

beneficiary_cnpj_cpfstring

CNPJ/CPF do Beneficiário

agency_numberstring

Agência. Preenchido automaticamente quando financial_account_uid é fornecido.

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. Preenchido automaticamente quando financial_account_uid é fornecido.

account_numberstring

Conta. Preenchida automaticamente quando financial_account_uid é fornecido.

account_digitstring

Dígito da Conta. Preenchido automaticamente quando financial_account_uid é fornecido.

extra1string nullable

Campo extra 1.

extra1_digitstring nullable

Digito do Campo extra 1.

extra2string nullable

Campo extra 2.

extra2_digitstring nullable

Dígito do Campo extra 2.

contractstring

Contrato

contract_typestring

Tipo do Contrato

extra3string nullable

Código de Remessa

beneficiary_address_streetstring nullable

Rua do Beneficiário

beneficiary_address_street_numberstring nullable

Numero da rua do Beneficiário

beneficiary_address_complementstring nullable

Complemento do endereço do Beneficiário

beneficiary_address_neighborhoodstring nullable

Bairro do Beneficiário

beneficiary_address_citystring nullable

Cidade do Beneficiário

beneficiary_address_statestring nullable

Estado do Beneficiário

beneficiary_address_zipcodestring nullable

CEP do Beneficiário (formato 99999999)

beneficiary_addressstring nullable

Endereço completo do Beneficiário.

bolepix_enabledboolean nullable

Habilitar Bolepix (legado — prefira o objeto bolepix)

bolepix_keystring nullable

Chave Pix que será usada no Bolepix

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`

remittance_disabledboolean nullable

Desabilita geração de remessas.

next_our_numberinteger nullable

Último nosso número

next_remittance_numberinteger nullable

Último sequencial da remessa Default: 1

Example request

{
  "beneficiary_address_zipcode": "01310100",
  "bolepix": {
    "pix_mode": 2,
    "pix_account": {
      "uid": "018df180-7208-727b-a10a-ea545e4a75a8"
    },
    "pix_billing_options": {
      "kind": "instant",
      "interest": true,
      "fine": true,
      "discount": true,
      "revoke_days": true
    }
  },
  "next_remittance_number": 1,
  "bank_billet_account_next_our_number_attributes": {
    "next_our_number": 1
  },
  "bank_billet_account_next_remittance_number_attributes": {
    "next_remittance_number": 1
  }
}

Response

Carteira atualizada