Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Iugu] New charge attributes #97

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[Iugu] New charge attributes #97

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b58649
add new charge attributes
icaroang Oct 26, 2018
9ac92f2
add iugu info
icaroang Nov 5, 2018
3c158af
fix charge text
icaroang Nov 5, 2018
12e15cb
Fix merge conflicts
Nov 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 58 additions & 22 deletions source/includes/_charges.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,6 @@ e tem suas respostas dadas em payloads via webhook.
| charge_config_id | integer | identificador da configuração de cobrança a qual esta cobrança pertence |
| charged_amount | decimal | valor cobrado no boleto |
| due_date | date | data de vencimento da cobranca |
| interest_amount_per_month | decimal | porcentagem de juros mensal que deve ser aplicado em caso de atraso. Esse valore será dividido por 30 para ser encontrata a taxa diária |
| mulct_value | decimal | valor da multa que deve ser aplicada em caso de atraso |
| discount_amount | decimal | valor do disconto que deve ser aplicado em caso de pagamento até a data de vencimento |
| payer_id | integer | identificador do pagador |
Expand All @@ -190,7 +189,6 @@ e tem suas respostas dadas em payloads via webhook.
| payer_zipcode | string | cep do endereço do pagador |
| payer_city | string | cidade do endereço do pagador |
| payer_state | string | sigla do estado do endereço do pagador ("RJ" por exemplo) |
| document_kind | string | espécie do documento |
| auto_send_billet | boolean | indica se será enviado email de notificação automaticamente para os emails especificados no campo 'notification_emails' |
| notification_emails | array of strings | emails que receberão notificações sobre a cobrança |
| email_sender_name | string | nome do remetente do email de notificação de cobrança |
Expand All @@ -200,6 +198,20 @@ e tem suas respostas dadas em payloads via webhook.
| canceled_at | datetime | data e horário em que a cobrança foi cancelada, se for o caso |
| _links | array of object | links relacionados à cobrança |

**Parâmetros específicos para gateway PJBank**

| Campo | Tipo | Comentário |
|--------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| document_kind | string | espécie do documento |
| interest_amount_per_month | decimal | porcentagem de juros mensal que deve ser aplicado em caso de atraso. Esse valor será dividido por 30 para ser encontrata a taxa diária |

**Parâmetros específicos para gateway Iugu**

| Campo | Tipo | Comentário |
|--------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| per_day_interest | boolean | indica que será cobrado 1% de juros ao mês pro rata em caso de atraso. Este valor é fixado pelo Iugu. |


## Informações da Cobrança

```shell
Expand Down Expand Up @@ -541,24 +553,22 @@ Caso exista um Pagador (Person) com o mesmo <code>national_identifier</code>, n

**Parâmetros**

| Campo | Tipo | Comentário |
|---------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| type | string | **(requerido)** tipo da cobrança, nesse caso deve ser "billet" |
| charge_config_id | integer | **(requerido)** código de identificação da configuração de cobrança da qual a cobrança irá pertencer |
| charged_amount | decimal | **(requerido)** valor cobrado |
| due_date | date | **(requerido)** data de vencimento da cobrança |
| payer_id | integer | **(requerido, se não enviar payer_attributes)** identificador do pagador (caso seja fornecido, o parâmetro payer_attributes será ignorado) |
| payer_attributes* | object | **(requerido, se não enviar payer_id)** atributos para a criação de um novo pagador ou atualização de um pagador existente com o mesmo documento (national_identifier) |
| document_kind | string | (opcional) espécie do documento, podendo ser DM (Duplicata Mercantil), DS (Duplicata de Serviço), NP (Nota Promissória) ou DV (Diversos). Caso não seja informado o valor assumido será "DM". |
| interest_amount_per_month | decimal | (opcional) porcentagem de juros mensal que deve ser aplicado em caso de atraso. Esse valore será dividido por 30 para ser encontrata a taxa diária |
| mulct_value | decimal | (opcional) porcentagem de multa que deve ser aplicada em caso de atraso |
| discount_amount | decimal | (opcional) valor do disconto que deve ser aplicado em caso de pagamento até a data de vencimento |
| auto_send_billet | boolean | (opcional) Indica se será enviado email de notificação automaticamente para os emails especificados no campo 'notification_emails'. Caso não seja informada assumirá valor 'false' |
| notification_emails | array of strings | (opcional - requerido caso `auto_send_billet` seja `true`) emails que receberão notificações sobre a cobrança |
| email_sender_name | string | (opcional) Nome do remetente do email de notificação de cobrança, caso a opção auto_send_billet estiver com valor 'true' |
| email_subject | string | (opcional) Assunto do email de notificação de cobrança, caso a opção auto_send_billet estiver com valor 'true' |
| email_text | string | (opcional) Texto do email de notificação de cobrança, caso a opção auto_send_billet estiver com valor 'true' |
| email_reply_to | string | (opcional) Endereço de email a ser utilizado na resposta ao email de notificação de cobrança, caso a opção auto_send_billet estiver com valor 'true' |
| Campo | Tipo | Comentário |
|---------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| type | string | **(requerido)** tipo da cobrança, nesse caso deve ser "billet" |
| charge_config_id | integer | **(requerido)** código de identificação da configuração de cobrança da qual a cobrança irá pertencer |
| charged_amount | decimal | **(requerido)** valor cobrado |
| due_date | date | **(requerido)** data de vencimento da cobrança |
| payer_id | integer | **(requerido, se não enviar payer_attributes)** identificador do pagador (caso seja fornecido, o parâmetro payer_attributes será ignorado) |
| payer_attributes* | object | **(requerido, se não enviar payer_id)** atributos para a criação de um novo pagador ou atualização de um pagador existente com o mesmo documento (national_identifier) |
| mulct_value | decimal | (opcional) porcentagem de multa que deve ser aplicada em caso de atraso |
| discount_amount | decimal | (opcional) valor do disconto que deve ser aplicado em caso de pagamento até a data de vencimento |
| auto_send_billet | boolean | (opcional) Indica se será enviado email de notificação automaticamente para os emails especificados no campo 'notification_emails'. Caso não seja informada assumirá valor 'false' |
| notification_emails | array of strings | (opcional - requerido caso `auto_send_billet` seja `true`) emails que receberão notificações sobre a cobrança |
| email_sender_name | string | (opcional) Nome do remetente do email de notificação de cobrança, caso a opção auto_send_billet estiver com valor 'true' |
| email_subject | string | (opcional) Assunto do email de notificação de cobrança, caso a opção auto_send_billet estiver com valor 'true' |
| email_text | string | (opcional) Texto do email de notificação de cobrança, caso a opção auto_send_billet estiver com valor 'true' |
| email_reply_to | string | (opcional) Endereço de email a ser utilizado na resposta ao email de notificação de cobrança, caso a opção auto_send_billet estiver com valor 'true' |

**payer_attributes**

Expand All @@ -579,6 +589,20 @@ Caso exista um Pagador (Payer) com o mesmo <code>national_identifier</code>, nã
| city | string | (opcional) cidade do endereço do pagador |
| state | string | (opcional) sigla do estado do endereço do pagador ("RJ" por exemplo) |

**Parâmetros específicos para gateway PJBank**

| Campo | Tipo | Comentário |
|--------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| document_kind | string | (opcional) espécie do documento, podendo ser DM (Duplicata Mercantil), DS (Duplicata de Serviço), NP (Nota Promissória) ou DV (Diversos) |
| interest_amount_per_month | decimal | (opcional) porcentagem de juros mensal que deve ser aplicado em caso de atraso. Esse valor será dividido por 30 para ser encontrata a taxa diária |

**Parâmetros específicos para gateway Iugu**

| Campo | Tipo | Comentário |
|--------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| per_day_interest | boolean | (opcional) indica que será cobrado 1% de juros ao mês pro rata em caso de atraso. Este valor é fixado pelo Iugu. |


## Atualização de Cobrança

```shell
Expand Down Expand Up @@ -758,8 +782,6 @@ No contexto de Cobrança utilizamos o nome 'Pagador' para referirmos à Pessoa (
| due_date | date | **(requerido)** data de vencimento da cobrança |
| payer_id | integer | **(requerido, se não enviar payer_attributes)** identificador do pagador (caso seja fornecido, o parâmetro payer_attributes será ignorado) |
| payer_attributes* | object | **(requerido, se não enviar payer_id)** atributos para a criação de um novo pagador ou atualização de um pagador existente com o mesmo documento (national_identifier) |
| document_kind | string | (opcional) espécie do documento, podendo ser DM (Duplicata Mercantil), DS (Duplicata de Serviço), NP (Nota Promissória) ou DV (Diversos) |
| interest_amount_per_month | decimal | (opcional) porcentagem de juros mensal que deve ser aplicado em caso de atraso. Esse valore será dividido por 30 para ser encontrata a taxa diária |
| mulct_value | decimal | (opcional) porcentagem de multa que deve ser aplicada em caso de atraso |
| discount_amount | decimal | (opcional) valor do disconto que deve ser aplicado em caso de pagamento até a data de vencimento |
| auto_send_billet | boolean | (opcional) Indica se será enviado email de notificação automaticamente para os emails especificados no campo 'notification_emails'. Caso não seja informada assumirá valor 'false' |
Expand Down Expand Up @@ -792,6 +814,20 @@ Caso exista um Pagador (Payer) com o mesmo <code>national_identifier</code>, nã
| city | string | (opcional) cidade do endereço do pagador |
| state | string | (opcional) sigla do estado do endereço do pagador ("RJ" por exemplo) |

**Parâmetros específicos para gateway PJBank**

| Campo | Tipo | Comentário |
|--------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| document_kind | string | (opcional) espécie do documento, podendo ser DM (Duplicata Mercantil), DS (Duplicata de Serviço), NP (Nota Promissória) ou DV (Diversos) |
| interest_amount_per_month | decimal | (opcional) porcentagem de juros mensal que deve ser aplicado em caso de atraso. Esse valor será dividido por 30 para ser encontrata a taxa diária |

**Parâmetros específicos para gateway Iugu**

| Campo | Tipo | Comentário |
|--------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| per_day_interest | boolean | (opcional) indica que será cobrado 1% de juros ao mês pro rata em caso de atraso. Este valor é fixado pelo Iugu. |


## Re-tentativa de efetivar de Cobrança (Cartão de crédito)

```shell
Expand Down