Este recurso permite a criação, consulta e alteração de cobranças.
Com a API de cobranças Grafeno, é possível emitir cobranças com as formas de pagamento Boleto Bancário, PIX e TED, além de ser possível editar as cobranças criadas e enviar para protesto as cobranças que não foram pagas.
A API de cobranças Grafeno possui suporte a webhooks, ou seja, notificaremos a sua aplicação sempre que suas cobranças sofrerem alguma alteração de status.
Estrutura de uma cobrança
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
| paymentMethod | Método de pagamento da cobrança, valores possíveis: boleto, pix, ted. | String | Não (se omitido, o valor padrão será boleto.) |
| dueDate | Dat de vencimento da cobrança. | Date (YYYY-MM-DD) | Sim |
| value | Valor da cobrança. | Double | Sim |
| abatementValue | Valor do abatimento da cobrança em reais. | Double | Não |
| abatement | Valor do abatimento da cobrança em percentual. | Double | Não |
| interestType | Tipo de juros que será aplicado a cobrança. Valores possíveis: fixed_value ou percentage. | String | Não |
| interestValue | Valor de juros que será aplicado a cobrança. | Double | Não |
| applicableFine | Multa por atraso. | Double | Não |
| clientControlNumber | Identificador próprio definido pelo cliente. | String | Não |
| expiresAfter | Dias para baixa automática da cobrança após a data de vencimento. | Int | Não |
| receiptNumber | Número da nota fiscal vinculada a cobrança. | String | Não |
| discount.range | Data limite para aplicação de desconto na cobrança. | Date (YYYY-MM-DD) | Não |
| discount.discountType | Tipo de desconto. Valores possíveis fixed e percentage. | String | Não |
| discount.discountValue | Valor do desconto. | Double | Não |
| payer.name | Nome do pagador. | String | Sim |
| payer.documentNumber | CPF ou CNPJ do pagador. | String | Sim |
| payer.email | E-mail do pagador. | String | Sim |
| payer.phone.number | Número de telefone do pagador. | String | Não |
| payer.phone.areaCode | Código de área do telefone do pagador. | String | Não |
| payer.phone.countryCode | Código de país do telefone do pagador. | String | Não |
| payer.address.street | Endereço do pagador: rua. | String | Sim |
| payer.address.number | Endereço do pagador: número. | String | Sim |
| payer.address.complement | Endereço do pagador: complemento. | String | Não |
| payer.address.neighborhood | Endereço do pagador: bairro. | String | Sim |
| payer.address.city | Endereço do pagador: cidade. | String | Sim |
| payer.address.state | Endereço do pagador: estado. | String | Sim |
| payer.address.zipCode | Endereço do pagador: CEP. | String | Sim |
| payer.address.country | Endereço do pagador: país. | String | Não |
| boletoDetails.registrationMethod | Método de registro do boleto bancário. Valores possíveis: online e offline. | String | Não (se omitido, o valor padrão será offline.) |
| boletoDetails.titleType | Natureza da cobrança. Clique aqui para obter os valores possíveis. | String | Não (se omitido, o valor padrão será several.) |
| boletoDetails.messagingRuleId | Régua de cobrança que será utilizada. | String | Não |
| boletoDetails.ourNumber | Nosso número do boleto bancário. | String | Não |
| boletoDetails.yourNumber | Seu número do boleto bancário. | String | Não |
| boletoDetails.observation | Instruções do boleto bancário. | String | Não |
| grantor.name | Nome do sacador / avalista. | String | Não |
| grantor.documentNumber | CPF ou CNPJ do sacador / avalista. | String | Não |
| grantor.address.street | Endereço do sacador / avalista: rua. | String | Não |
| grantor.address.number | Endereço do sacador / avalista: número. | String | Não |
| grantor.address.complement | Endereço do sacador / avalista: complemento. | String | Não |
| grantor.address.neighborhood | Endereço do sacador / avalista: bairro. | String | Não |
| grantor.address.city | Endereço do sacador / avalista: cidade. | String | Não |
| grantor.address.state | Endereço do sacador / avalista: estado. | String | Não |
| grantor.address.zipCode | Endereço do sacador / avalista: CEP. | String | Não |
| grantor.address.country | Endereço do sacador / avalista: país. | String | Não |