GuidesAPI ReferenceCommunity
GuidesCommunityLog In

Carteira de cobrança

Uma carteira de cobrança é uma identificação interna usada para direcionar todo o valor de liquidação dos Boletos emitidos de um ou mais Beneficiários.

Uma carteira de cobrança pode ter um ou mais Beneficiários integrados/vinculados a esta carteira de cobrança.

A carteira de cobrança deve ser declarada na emissão do boleto, garantindo assim que o valor do Boleto será cobrado na carteira de cobrança especificada.

{
    ...

    "billing": {
        "externalId": 1
    }

    ...

}

campo

tipo

descrição

billing.externalId

number

  • identificação da carteira de cobrança;

📘

O acesso a carteira de cobrança não é um acesso externo, não se pode acessar via API, somente os gestores do fluxo do produto (cliente Bit Capital) possuem acesso a carteira de cobrança.

Pre-requisitos para o uso da carteira de cobrança

  • Ao emitir um Boleto na plataforma, deve-se especificar uma carteira de cobrança no corpo da requisição.

  • A carteira de cobrança deve estar previamente integrada com o beneficiário do Boleto. Veja mais em integrações

  • Caso não haja intergação criada entre o beneficiário do Boleto e a carteira de cobrança, a plataforma não emitirá o Boleto.

🚧

externalId = carteira de cobrança

A identificação da carteira de cobrança varia por cliente Bit Capital. Para requerer a configuração da carteira de cobrança para o uso no produto, entre em contato com o Help Desk

Informações

  • o registro de uma carteira de cobrança não pode ser feito pela API da plataforma;

Did this page help you?