Emissão e registro do boleto na CIP
Funcionalidade que trata dos dados de criação e registro de boletos junto à CIP.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| seuNumero | Número do boleto à escolha do cliente. Caso não seja informado, geramos automaticamente esse número | string | Não |
| beneficiarioFinal | Dono do produto e/ou serviço oferecido e que será creditado pelos valores das cobranças, solicitamos informar: razão social, nome fantasia e o CPF/CNPJ | object | Não |
| cliente | Dados do pagador do boleto. Aceitamos um clienteId para clientes que já tiveram boleto emitido ou os dados de novos clientes para cadastro e geração de um clienteId | object | Sim |
| sacadorAvalista | Dados da pessoa física ou jurídica que receberá o valor pago por meio do boleto, solicitamos informar CPF/CNPJ, nome e endereço | object | Não |
| vencimento | Data de vencimento do boleto, que deverá ser maior ou igual à data atual | date-time | Sim |
| valor | Valor da cobrança original | number <double> | Sim |
| multa | Multa que será aplicada no boleto; solicitamos informar: valor, data a partir da qual será cobrada e o percentual | object | Não |
| desconto | Desconto que poderá ser aplicado no boleto; solicitamos informar: percentual, valor fixo, valor diário ou por limite | object | Não |
| mensagem | Mensagens referentes às linhas 1, 2 3 e 4 do boleto | objetc | Não |
| aceite | Campo para definição de aceite do boleto para casos de protesto do título. Por padrão enviamos 'false' | boolean | Não |
| especie | Código para identificar o tipo de boleto de pagamento de cobrança. | string | Não |
| dataLimitePagamento | Data limite para o pagamento do boleto | date-time | Não |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | Identificador do boleto | string | Não |
| sacado | Sacado é aquele que paga o boleto (normalmente, o cliente). Informamos e-mail, telefone, CPF/CNPJ, nome e endereço | number <double> | Sim |
| status | Código de status do boleto, conforme tabela [Status do boleto] | integer | Não |
| nossoNumero | Nosso número do boleto | integer | Sim |
| codigoDeBarra | Código de barras do boleto | string | Sim |
| linhaDigitavel | Linha digitável do boleto | string | Sim |
| beneficiarioFinal | Dono do produto e/ou serviço oferecido e que será creditado pelos valores das cobranças; solicitamos informar: razão social, nome fantasia e o CPF/CNPJ | object | Sim |
| seuNumero | Seu número do boleto. Caso não tenha sido informado, enviamos o número gerado automaticamente | string | Não |
| clienteId | Número identificador do cliente que pagará o boleto | string | Não |
| sacadorAvalista | Dados da pessoa física ou jurídica que receberá o valor pago por meio do boleto (CPF/CNPJ, nome, endereço) | object | Não |
| vencimento | Data de vencimento definida para o boleto | date-time | Sim |
| valor | Valor definido para o boleto | number<double> | Não |
| multa | Multa definida que será aplicada ao boleto (valor, data a partir da qual será cobrada e o percentual) | object | Sim |
| desconto | Desconto definido que poderá ser aplicado ao boleto (percentual, valor fixo, valor diário ou por limite) | object | Sim |
| mensagem | Mensagens definidas referentes às linhas 1, 2 3 e 4 do boleto | objetc | Sim |
| aceite | Campo para definição de aceite do boleto para casos de protesto do título | boolean | Sim |
| especie | Código para identificar o tipo de boleto de pagamento de cobrança. | string | Sim |
Emitir e registrar boleto na CIP
Status do boleto
O boleto poderá ter os seguintes status:
| Enumeração | Descrição |
|---|---|
| 1 | Aberto |
| 2 | Vencido |
| 3 | Cancelado |
| 4 | Pago |
Updated 8 months ago