GuidesAPI ReferenceCommunity
GuidesCommunityLog In

Criar integração para um beneficiário

Uma integração é o nome dado ao vínculo de um beneficiário a uma carteira de cobrança.

Para esta integração é obrigatório que ambos já estejam cadastrados na plataforma. Isto é um pré-requisito.

  • um CNPJ cadastrado como Beneficiário na plataforma;
  • uma carteira de cobrança, registrada na plataforma;

Apenas informe a carteira de cobrança que deseje criar a integração e execute a requisição.

Usado para

  • criar uma intergração entre um Beneficiário e uma carteira de cobrança

Request

POST {{API_BASEURL}}boletos/emission/beneficiary/{{TAXID}}/billing
curl --location -g --request POST '{{API_BASEURL}}/boletos/emission/beneficiary/{{TAXID}}/billing' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalId": 1
}'

Body Request

{
    "externalId": 1
}

campo

tipo

descrição

externalId

number

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

Após a integração, todos os boletos emitidos por este beneficiário deverão ser informado o externalId declarado no body da requisição.

🚧

apenas para relembrar

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


Did this page help you?