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 Simples, Boleto Bancário Híbrido e PIX, 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.
Integração de Cobranças - Vórtx
Atualmente a Grafeno utiliza dois agentes bancarizadores: BMP (274) e Vórtx (310).
Estruturalmente não existem diferenças na integração via API Grafeno entre os dois bancarizadores, ou seja, a API de cobranças Grafeno deve funcionar para a criação de cobranças independente do bancarizador da conta (274 ou 310).
O que muda são algumas regras de negócios entre a Grafeno - BMP e Grafeno - Vórtx, seguem as regras que se aplicam para a integração Grafeno - Vórtx:
1 - Nosso Número: O cálculo do dígito do NN é o mesmo utilizado no layout BMP (274), a única diferença é na seleção do dígito. A Vórtx não utiliza o dígito P, logo, por via de regra, se o resto da divisão for menor do que 2, o dígito será 0 (ZERO).
Se o resto da divisão for 0 (zero), ou se o resultado da subtração for 10 ou 11, o dígito de auto conferência será 0 (zero). Exemplo: Se a soma fosse 77, e 77÷11 tivesse resto 0, então o dígito verificador seria 0.
2 - Regras de negócios relacionadas às cobranças do banco Vórtx (310):
- Não é possível alterar ou incluir uma definição de abatimento em cobranças já registradas;
- Não é possível alterar a data de vencimento de uma cobrança que tenha regra de desconto definida;
- Não é possível alterar o campo de multa de cobranças Vórtx registradas;
- Não é possível alterar o campo de juros de cobranças Vórtx registradas;
- Só existe um tipo de registro de boletos na Vórtx, neste caso é o registro online (imediato);
- É possível alterar o dado "seu número" via API para cobranças Vórtx;
- É possível alterar a data de vencimento de uma cobrança caso a mesma não tenha nenhuma regra de desconto definida.
3 - Código de barras / linha digitável: Diferente do banco BMP (274), na Vórtx (310), o número da conta na linha digitável do boleto bancário é informado com o dígito da conta.
4 - Carteira: A carteira Vórtx (310) é a 21, o banco é 310VORTX e a agência é a 0001.
5 - Modalidades de cobranças: Atualmente via Vórtx, só é possível gerar cobranças na modalide "Boleto Simples". As modalidades "PIX Cobrança" e "Boleto Híbrido" ainda não estão disponíveis.
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, boleto híbrido. | 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 |