--- title: "Solicitar Homologação da Carteira de Cobrança" method: GET path: "/v1/bank_billet_accounts/{id}/ask" tags: ["Carteiras de Cobrança"] --- # Solicitar Homologação da Carteira de Cobrança `GET /v1/bank_billet_accounts/{id}/ask` Solicitar homologação da Carteira de Cobrança ## Path parameters - `id` string, required ## Headers - `User-Agent` string - `X-Idempotency-Key` string ## Response `200` Solicitação de homologação realizada com sucesso - BankBilletAccountObject - `id` integer — ID da carteira - `bank_contract_slug` string, required — [Slug da Carteira](/reference/bancos-suportados) - `next_our_number` integer, nullable — Próximo Nosso Número. Default: 1 - `next_remittance_number` integer, nullable — Último sequencial da remessa Default: 1 - `agency_number` string, required — Agência - `agency_digit` string, nullable — Dígito da Agência. Opcional: será calculado automaticamente usando Módulo 11 quando o banco exigir e não for fornecido. - `account_number` string, required — Conta - `account_digit` string, required — Dígito da Conta - `extra1` string, nullable — Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio. - `extra1_digit` string, nullable — Digito do Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio. - `extra2` string, nullable — Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio. - `extra2_digit` string, nullable — Dígito do Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio. - `extra3` string, nullable — Código de Remessa - `payment_place` string, nullable — Local de Pagamento - `contract` string — Contrato - `contract_type` string — Tipo do Contrato - `beneficiary_name` string, required — Nome do Beneficiário - `beneficiary_cnpj_cpf` string, required — CNPJ/CPF do Beneficiário - `beneficiary_address_street` string, nullable, required — Rua do Beneficiário - `beneficiary_address_street_number` string, nullable, required — Numero da rua do Beneficiário - `beneficiary_address_complement` string, nullable, required — Complemento do endereço do Beneficiário - `beneficiary_address_neighborhood` string, nullable, required — Bairro do Beneficiário - `beneficiary_address_city` string, nullable, required — Cidade do Beneficiário - `beneficiary_address_state` string, nullable, required — Estado do Beneficiário - `beneficiary_address_zipcode` string, nullable, required — CEP do Beneficiário (formato 99999999) - `beneficiary_address` string, nullable, required — Endereço completo do Beneficiário. - `financial_account` object, nullable — Conta Financeira associada à carteira - `uid` string, uuid — UID da Conta Financeira - `bolepix_enabled_at` string, nullable — Data e Hora em que o boleto híbrido foi habilitado. - `bolepix` object, nullable — Configuração de Boleto Híbrido - `pix_mode` integer, nullable — Quem irá gerenciar o pix * 1 - Gerenciado pela Kobana * 2 - Gerenciado pelo Banco * 3 - Não configurado - `pix_account_id` integer, nullable — ID da conta pix que será usada na configuração do boleto híbrido. Se o responsável pelo gerenciamento do pix for o banco, a conta pix deve informada deve ser obrigatóriamente uma conta pix mesmo banco - `pix_account` object, nullable — Conta Pix que será usada na configuração do boleto híbrido. - `id` integer — ID da Conta Pix - `uid` string — UID da Conta Pix - `custom_name` string — Nome personalizado para a conta pix - `key` string — Chave pix da conta - `financial_provider_slug` string — Instituição financeira da conta pix - `enabled` boolean — Indica se a conta pix está habilitada - `default` boolean — Indica se a conta pix é a padrão - `beneficiary` object — Beneficiário da Conta Pix - `name` string — Nome do Beneficiário - `document` string — Documento do Beneficiário (CNPJ ou CPF) - `address` object — Endereço do Beneficiário - `street` string — Rua do beneficiário - `number` string — Número da rua do beneficiário - `complement` string — Complemento do endereço do beneficiário - `neighborhood` string — Bairro do beneficiário - `city_name` string — Cidade do beneficiário - `state` string — Estado do beneficiário - `zip_code` string — CEP do beneficiário (formato 99999999) - `pix_billing_options` object, nullable — Opções de cobrança do pix no boleto. Deve ser enviado quando o pix for gerenciado pela Kobana. - `kind` string — Tipo de cobrança * instant - Cobrança imediata * billing - Cobrança com vencimento - `interest` boolean, nullable — Habilitar juros - `fine` boolean, nullable — Habilitar multa - `discount` boolean, nullable — Habilitar desconto - `revoke_days` boolean, nullable — Habilitar dias para revogação - `name` string — 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 - `default` boolean, 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` - `configuration` object, nullable — Configuração de dados padrões para boleto - `bank_contract` object — Dados da Carteira. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem. - `custom_name` string — Nome da Carteira para identificação dentro da Kobana. - `kind` 'cnab400' | 'cnab240' — Tipo de CNAB: * `cnab400` CNAB 400 * `cnab240` CNAB 240 - `remittance_disabled` boolean, nullable — Desabilita geração de remessas. - `remittance_disabled_at` string, date-time, nullable — Data e hora em que a geração de remessa foi desabilitada. - `allow_expiration_on_weekends` boolean, nullable — Permitir vencimento em fim de semana e feriados - `created_at` string, date-time, nullable — Data e hora de criação da carteira - `updated_at` string, date-time, nullable — Data e hora da última atualização da carteira - `created_via_api` boolean, nullable — Indica se a carteira foi criada por API ## Other responses - `404` — Carteira não encontrada - `422` — Carteira já homologada --- [API](https://skmtc.net/kobana/apis/cobran-as.md) · [All operations](https://skmtc.net/kobana/apis/cobran-as/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kobana/cobran-as/revisions/728c362ec4d7/schema)