GuidesAPI ReferenceCommunity
GuidesCommunityLog In

Beneficiário

Beneficiário é o indivídio pessoa jurídica ou pessoa física que receberá o saldo de um Boleto emitido na plataforma, independente que quem tenha sido o pagador, e independente de onde tenha sido pago o Boleto.

Os Beneficiários podem ser de 2 tipos:

  • corporate: pessoa jurídica
  • personal : pessoal física

Tanto corporatequanto personal possuem documento de identificação: CNPJ e CPF respectivamente.

Para este caso, a plataforma possue apenas um campo denominado taxId que identificará o número da documentação, tanto para o corporate quanto para o personal

Identificando dados de uma pessoa jurídica ( corporate )

{

...

"type: "corporate",
"taxid: "12345678901232" //CNPJ

...
}

Identificando dados de uma pessoa física ( personal )

{

...

"type: "personal",
"taxid: "12345678912" //CPF

...
}

O atributo taxId, vai exigir o número de caracteres baseando-se no que for declarado no atributo type.

Se for declarado type: personal então o taxIdexigirá 11 caracteres, se for declarado type:corporate então o taxId exigirá 14 caracteres.

Informações

  • o registro de um Beneficiário pode ser feito pela API da plataforma;

Did this page help you?