PARAMETERS page, page_size
Testar no Playground
### Response
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoices
MÉTODO GET
HTTP STATUS 200
Limite de itens retornados por página: 100
Response Body
```json
{
"wallet_key": "9798d733-7f68-4929-8877-a00bfda9735e",
"invoice_closing_day": 2,
"invoice_due_day": 10,
"page": "1",
"last_page": "False",
"invoices": [
{
"invoice_key": "b32e7eae-eaab-4402-9126-9fcf42741c24",
"due_date": "2023-04-10",
"closing_date": "2023-04-02",
"status": "opened",
"number_of_items": 2
},
{
"invoice_key": "2af90944-1377-447c-aa70-0efd24c17d6f",
"due_date": "2023-05-10",
"closing_date": "2023-05-02",
"status": "opened",
"number_of_items": 12
},
{
"invoice_key": "26e18c39-8f67-4399-9a42-8d18bc175da2",
"due_date": "2023-04-10",
"closing_date": "2023-04-02",
"status": "opened",
"number_of_items": 1
},
{
"invoice_key": "6991f8e6-7b1d-4496-a08f-8a9eef263f07",
"due_date": "2023-06-10",
"closing_date": "2023-06-02",
"status": "opened",
"number_of_items": 12
}
]
}
```
## 6. Listar transações de uma fatura:
### Request
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]
MÉTODO GET
Testar no Playground
### Response
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]
MÉTODO GET
HTTP STATUS 200
Response Body
```json
{
"due_date": "2023-06-10",
"closing_date": "2023-06-02",
"status": "closed",
"amount": 12345.67,
"paid_amount": 0,
"delay_interest_total_amount": 0,
"delay_fine_total_amount": 0,
"number_of_items": 1,
"invoice_payments": [
{
"invoice_payment_key": "63a7c7a2-9e13-48cf-aea2-3b494125d14b",
"invoice_payment_type": "bankslip",
"charge_type": "ordinary",
"data": {
"digitable_line": "32990001039000000000104620768103992260000004183",
"qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/881979cb-1c15-4dea-a05e-316caae22f5e5204000053039865802BR5925LOTEAMENTO RESIDENCIAL PO6014PORTO NACIONAL61087750000062070503***630414B8"
},
"expiration": "2023-07-10",
"status": "opened",
"total_amount": 0,
"paid_amount": 0,
"chargeback_amount": 50
}
],
"items": [
{
"item_key": "37ebad25-7eef-4a46-b497-ce46c2c04f68",
"amount": 12345.67,
"used_limit": 12300,
"status": "active",
"card_entry": {
"card_entry_key": "ad8e073a-2159-479b-b141-cd5d8ceb8567",
"card_entry_datetime": "2022-11-13T10:29:49",
"description": "Compra Padaria do João",
"final_amount": 12345.67,
"number_of_installments": 2,
"card": {
"card_key": "d41bd53e-eedc-4d62-97dd-26bbaefadb20"
}
},
"installment_number": 1
}
]
}
```
#### Enumeradores Item status
| Enumerador | Descrição |
|------------------------------|---------------------------------------------------------------------------------------------|
| **pending_activation** | Item aguardando ativação, o valor do item compôe o valor da fatura |
| **active** | Item ativo, o valor do item compôe o valor da fatura |
| **canceled** | Item cancelado, o valor do item é removido do valor da fatura |
| **paid** | Item pago na fatura do mês, o valor do item compôe o valor da fatura |
| **paid_early** | Item pago adiantado, o valor do item não compôe mais o valor da fatura |
| **reversed** | Item cancelado após fechamento da fatura, o valor do item gerará um estorno |
## 7. Geração de boletos:
A geração do boleto ordinário acontecerá automaticamente no dia de fechamento da fatura e poderá ser resgatado através do get de pagamento da fatura. O query parameter "shorten_url" é uma flag para solicitar a URL do boleto encurtada.
:::caution ATENÇÃO
O boleto pode ser pago em até 30 dias após o vencimento da fatura.
:::
:::danger ATENÇÃO
O encurtamento de URL é limitado a 60 requisições por minuto.
:::
### Request
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]/invoice_payment/[INVOICE-PAYMENT-KEY]
MÉTODO GET
PARAMETER shorten_url
Testar no Playground
### Response
#### Parameter shorten_url=False
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]/invoice_payment/[INVOICE-PAYMENT-KEY]?shorten_url=False
MÉTODO GET
HTTP STATUS 200
Response Body
```json
{
"invoice_payment_key": "63a7c7a2-9e13-48cf-aea2-3b494125d14b",
"invoice_payment_type": "bankslip",
"charge_type": "ordinary",
"data": {
"bank_slip_key": "dc4a27db-2fe1-474d-aa02-88d6fffb8d0d",
"digitable_line": 32990001039000000000104620768103992260000004183,
"qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/881979cb-1c15-4dea-a05e-316caae22f5e5204000053039865802BR5925LOTEAMENTO RESIDENCIAL PO6014PORTO NACIONAL61087750000062070503***630414B8",
"bank_slip_url": "\"
},
"expiration": "2023-07-10",
"status": "issued",
"total_amount": 0,
"paid_amount": 0,
"chargeback_amount": 50,
}
```
#### Parameter shorten_url=True
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]/invoice_payment/[INVOICE-PAYMENT-KEY]?shorten_url=True
MÉTODO GET
HTTP STATUS 200
Response Body
```json
{
"invoice_payment_key": "63a7c7a2-9e13-48cf-aea2-3b494125d14b",
"invoice_payment_type": "bankslip",
"charge_type": "ordinary",
"data": {
"bank_slip_key": "dc4a27db-2fe1-474d-aa02-88d6fffb8d0d",
"digitable_line": 32990001039000000000104620768103992260000004183,
"qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/881979cb-1c15-4dea-a05e-316caae22f5e5204000053039865802BR5925LOTEAMENTO RESIDENCIAL PO6014PORTO NACIONAL61087750000062070503***630414B8",
"bank_slip_url": "\",
"short_bank_slip_url": "\"
},
"expiration": "2023-07-10",
"status": "issued",
"total_amount": 0,
"paid_amount": 0
}
```
## 7.1 Geração de boleto extraordinário de adiantamento:
### Request
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]/invoice_payment
MÉTODO POST
Testar no Playground
Request Body
```json
{
"invoice_payment_type": "bankslip",
"charge_type": "early",
"expiration": "2023-08-15",
"invoice_items": [
"key_1",
"key_2"
]
}
```
:::note ATENÇÃO
Condição: "expiration" deve ser dois dias úteis menor que a data de fechamento da fatura para garantir que o pagamento não irá interferir
em tal rotina.
:::
### Response
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]/invoice_payment
MÉTODO POST
HTTP STATUS 200
Response Body
```json
{
"invoice_payment_key": "63a7c7a2-9e13-48cf-aea2-3b494125d14b",
"invoice_payment_type": "bankslip",
"charge_type": "early",
"data": {
"digitable_line": 32990001039000000000104620768103992260000004183,
"qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/881979cb-1c15-4dea-a05e-316caae22f5e5204000053039865802BR5925LOTEAMENTO RESIDENCIAL PO6014PORTO NACIONAL61087750000062070503***630414B8",
},
"expiration": "2023-08-15",
"status": "issued",
"total_amount": 200,
"paid_amount": 0
}
```
## 7.2 Simulação de boleto extraordinário de atraso:
:::caution ATENÇÃO
A simulação só pode ser solicitada após o termino do prazo de pagamento do boleto ordinário.
:::
### Request
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]/invoice_payment/simulation
MÉTODO POST
Testar no Playground
Request Body
```json
{
"invoice_payment_type": "bankslip",
"charge_type": "delay",
"expiration": "2023-08-15"
}
```
### Request com desconto
Request Body
```json
{
"invoice_payment_type": "bankslip",
"charge_type": "delay",
"expiration": "2023-08-15",
"discount_amount": 50
}
```
### Response
Response Body
```json
{
"invoice_payment_type": "bankslip",
"charge_type": "delay",
"total_amount": 150,
"discount_amount": 50
}
```
## 7.3 Geração de boleto extraordinário de atraso:
:::caution ATENÇÃO
O boleto de atraso só pode ser gerado após o termino do prazo de pagamento do boleto ordinário.
:::
### Request
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]/invoice_payment
MÉTODO POST
Testar no Playground
Request Body
```json
{
"invoice_payment_type": "bankslip",
"charge_type": "delay",
"expiration": "2023-08-15"
}
```
### Request com desconto
Request Body
```json
{
"invoice_payment_type": "bankslip",
"charge_type": "delay",
"expiration": "2023-08-15",
"discount_amount": 50
}
```
### Response
Response Body
```json
{
"invoice_payment_key": "63a7c7a2-9e13-48cf-aea2-3b494125d14b",
"invoice_payment_type": "bankslip",
"charge_type": "delay",
"data": {
"digitable_line": 32990001039000000000104620768103992260000004183,
"qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/881979cb-1c15-4dea-a05e-316caae22f5e5204000053039865802BR5925LOTEAMENTO RESIDENCIAL PO6014PORTO NACIONAL61087750000062070503***630414B8",
},
"expiration": "2023-07-10",
"status": "issued",
"total_amount": 0,
"paid_amount": 0,
"discount_amount": 50
}
```
## 7.4 Cancelamento de boleto de pagamento de fatura
### Request
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]/invoice_payment/[INVOICE-PAYMENT-KEY]
MÉTODO DELETE
Testar no Playground
### Response
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/invoice/[INVOICE-KEY]/invoice_payment/[INVOICE-PAYMENT-KEY]
MÉTODO DELETE
HTTP STATUS 204
Response Body
```json
{}
```
## 8. Estornos:
## 8.1. Consultar estornos:
### Request
ENDPOINT
/card_invoice/wallet/[WALLET-KEY]/chargebacks
MÉTODO
GET
Testar no Playground
#### PATH PARAMETERS
| Enumerador | Descrição |
|------------------------------|-------------------------------------------------------------|
| **status** | Status do estorno('active'/'used'/'pending_payment') |
### Response
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/chargebacks
MÉTODO GET
HTTP STATUS 200
Response Body
```json
{
"page": 1,
"last_page": true,
"data": [
{
"charge_back_key": "key",
"amount": 100,
"used_amount": 0,
"status": "active",
"reference_card_entry_key": "key",
"reference_item_key": "key"
}
]
}
```
## 9. Webhooks:
## 9.1. Alteração de status de fatura:
### Webhook
WEBHOOK_TYPE card_invoice.invoice.status_change
STATUS opened
Webhook Body
```json
{
"webhook_type": "card_invoice.invoice.status_change",
"key": "\",
"event_datetime": "\",
"status": "opened",
"data": {
"wallet_key":"\",
"due_date": "2023-07-10",
"closing_date": "2023-07-02"
}
}
```
:::note ATENÇÃO
O conteúdo do campo "data" mantém o mesmo padrão para todos os status
:::
#### Enumeradores Invoice status
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------|
| **opened** | Fatura aberta |
| **closed** | Fatura fechada |
| **paid** | Fatura paga dentro da data de vencimento |
| **paid_overdue** | Fatura paga em atraso |
## 9.2. Alteração de status da transação:
### Webhook
WEBHOOK_TYPE card_invoice.card_entry.status_change
STATUS active
Webhook Body
```json
{
"webhook_type": "card_invoice.card_entry.status_change",
"key": "\",
"event_datetime": "\",
"status": "active",
"data": {
"wallet_key":"\"
}
}
```
#### Enumeradores Card Entry status
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------|
| **active** | Contrato ativo e desembolsado |
| **canceled** | Contrato cancelado |
:::caution ATENÇÃO
O envio deste webhook só ocorrerá quando a transação estiver no status de "pending_activation"
:::
## 9.3. Criação do boleto após fechamento da fatura:
### Webhook
WEBHOOK_TYPE card_invoice.invoice_payment.status_change
STATUS issued
Webhook Body
```json
{
"webhook_type": "card_invoice.invoice_payment.status_change",
"key": "\",
"event_datetime": "\",
"status": "issued",
"data": {
"charge_type": "ordinary",
"wallet_key":"\",
"invoice_key":"\",
"digitable_line":"\",
"qr_code_url":"\"
}
}
```
#### Enumeradores Charge type
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------|
| **ordinary** | Pagamento ordinário |
| **early** | Pagamento extraordinário de adiantamento |
| **delay** | Pagamento extraordinário de atraso |
## 9.4. Alteração de status do pagamento da fatura:
### Webhook
WEBHOOK_TYPE card_invoice.invoice_payment.status_change
STATUS paid
Webhook Body
```json
{
"webhook_type": "card_invoice.invoice_payment.status_change",
"key": "\",
"event_datetime": "\",
"status": "paid",
"data": {
"wallet_key":"\",
"charge_type": "ordinary",
"invoice_key":"\",
"paid_amount": 150.0
}
}
```
#### Enumeradores Invoice Payment status
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------|
| **issued** | Emissão do boleto para pagamento da fatura |
| **paid** | Boleto pago |
| **canceled** | Pagamento do boleto cancelado |
## 9.5. Alteração de status do estorno:
### Webhook
WEBHOOK_TYPE card_invoice.chargeback.status_change
STATUS active
Webhook Body
```json
{
"webhook_type": "card_invoice.chargeback.status_change",
"key": "\",
"event_datetime": "\",
"status": "active",
"data": {
"wallet_key":"\",
"chargeback_amount":150.00,
"reference_card_entry_key":"\",
"reference_item_key" :"\"
}
}
```
#### Enumeradores status estorno
| Enumerador | Descrição |
|------------------------------|-------------------------------------------------------------|
| **active** | Estorno ativo para ser utilizado em um pagamento de fatura |
| **used** | Estorno ja utilizado no pagamento de uma fatura |
| **pending_payment** | Estorno aguardando pagamento para ser ativado |
:::caution Status 'pending_payment'
O status pending_payment representa o estorno de um item que pertence a uma fatura fechada que ainda não foi paga, o valor do estorno só pode ser utilizado após o pagamento da fatura.
:::
## 9.6.1 Rejeição de renegociação de transação:
### Webhook
WEBHOOK_TYPE card_invoice.renegotiation.status_change
STATUS rejected
Webhook Body
```json
{
"webhook_type": "card_invoice.renegotiation.status_change",
"key": "\\",
"event_datetime": "\\",
"status": "rejected",
"data": {
"wallet_key": "\\"
}
}
```
## 9.6.2 Pagamento de renegociação de transação:
### Webhook
WEBHOOK_TYPE card_invoice.renegotiation.status_change
STATUS paid
Webhook Body
```json
{
"webhook_type": "card_invoice.renegotiation.status_change",
"key": "\\",
"event_datetime": "\\",
"status": "paid",
"data": {
"wallet_key": "\\",
"paid_method_type": "",
"paid_in": {
"code_number": "",
"ispb": "",
"name": ""
}
}
}
```
#### Enumeradores status renegociação
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------------------------------------------|
| **pending_payment** | Renegociação de adiantamento de pagamento aguardando pagamento |
| **paid** | Renegociação de adiantamento de pagamento paga |
| **canceled** | Renegociação de adiantamento de pagamento cancelada |
| **rejected** | Renegociação de adiantamento de pagamento rejeitada por pagamento de parcela por fora da renegociação ou decurso de prazo |
## 10. Cancelamento de compra em até 7 dias:
## 10.1. Solicitação de cancelamento de compra:
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/card/[CARD-KEY]/card_entry/[CARD-ENTRY-KEY]/reversal
MÉTODO POST
Testar no Playground
### Request
Request Body
```json
{}
```
### Response
Response Body
```json
{
"amount": "2026.93",
"copy_paste_pix": "00020126930014br.gov.bcb.pix2571qrcode-h.dev.qitech.app/bacen/cobv/dece8d3e-32ce-439e-8204000053039865802BR5925Joao61080150400062070503***63046ECD",
"expiration_date": "2022-09-28"
}
```
## 10.2. Consulta de cancelamento de compra ativo:
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/card/[CARD-KEY]/card_entry/[CARD-ENTRY-KEY]/reversal
MÉTODO GET
Testar no Playground
### Response
Response Body
```json
{
"amount": "2026.93",
"copy_paste_pix": "00020126930014br.gov.bcb.pix2571qrcode-h.dev.qitech.app/bacen/cobv/dece8d3e-32ce-439e-8204000053039865802BR5925Joao61080150400062070503***63046ECD",
"expiration_date": "2022-09-28"
}
```
## 11. Renegociação de compras:
## 11.1. Simular renegociação de compras:
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/renegotiation/simulation
MÉTODO POST
Testar no Playground
### Request
Request Body
```json
{
"reference_date": "2024-07-20",
"card_entries": [
{
"card_entry_key": "817dced9-3216-410b-a51c-645019ab320b",
"items": [
{
"item_key": "04318ab7-7b3c-4558-ad7b-4e9e2d9e0e6e"
}
]
},
{
"card_entry_key": "3a3d8bbb-be30-41b0-b5be-8d358dc059ea"
}
]
}
```
### Request body details
| Campo | Tipo | Descrição | Caracteres |
|---| ---| ---| ---|
| `reference_date` | string | Data de referencia da renegociação.| |
### Response
Response Body
```json
{
"renegotiation_payment_amount": 350,
"reference_date": "2022-07-20",
"discount_percentage": 0,
"discount_amount": 0,
"card_entries": [
{
"card_entry_key": "817dced9-3216-410b-a51c-645019ab320b",
"payment_amount": 125,
"discount_amount": 0,
"affected_items": [
{
"item_key": "04318ab7-7b3c-4558-ad7b-4e9e2d9e0e6e",
"due_date": "2022-07-15",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125,
"present_amount": 100
}
]
},
{
"card_entry_key": "3a3d8bbb-be30-41b0-b5be-8d358dc059ea",
"payment_amount": 225,
"discount_amount": 0,
"affected_items": [
{
"item_key": "1249249c-95b5-45aa-81f1-967abf5e6eef",
"due_date": "2022-07-15",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125,
"present_amount": 100
},
{
"item_key": "c66dad81-ecb4-4afa-8713-a85ee8e721ec",
"due_date": "2022-08-15",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 100,
"present_amount": 120
}
]
}
]
}
```
## 11.2. Criar uma renegociação de compras:
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/renegotiation
MÉTODO POST
Testar no Playground
:::caution Objeto 'items'
Quando não informado o objeto "items", será considerado que todos os itens disponíveis da transação sejam incluídos na renegociação, ou seja, itens com status diferente de "active" serão ignorados.
Além disso, caso a carteira ja possua uma renegociação aguardando pagamento, ela deve ser cancelada para que seja possível gerar uma nova renegociação.
:::
### Request
Request Body
```json
{
"reference_date": "2024-07-20",
"proposal_due_date": "2024-07-27",
"card_entries": [
{
"card_entry_key": "817dced9-3216-410b-a51c-645019ab320b",
"items": [
{
"item_key": "04318ab7-7b3c-4558-ad7b-4e9e2d9e0e6e"
}
]
},
{
"card_entry_key": "3a3d8bbb-be30-41b0-b5be-8d358dc059ea"
}
]
}
```
### Campos de desconto
Adicionar um destes campos na requisição permite definir um valor de desconto percentual ou absoluto na criação ou simulação da proposta de renegociação.
Desconto percentual
```json
{
"discount_percentage": 0.5
}
```
Desconto absoluto
```json
{
"discount_amount": 200
}
```
### Request body details
| Campo | Tipo | Descrição | Caracteres |
|---| ---| ---| ---|
| `reference_date` | string | Data de referencia da renegociação.| |
| `proposal_due_date` | string | Data do vencimento da proposal da renegociação.| |
### Response
Response Body
```json
{
"renegotiation_key": "2af29916-582b-4ce7-8440-352a0d9543f7",
"renegotiation_payment_amount": 350,
"reference_date": "2022-07-20",
"renegotiation_status": "pending_payment",
"proposal_due_date": "2022-07-27",
"discount_percentage": 0,
"discount_amount": 0,
"payment": {
"digitable_line": "",
"qr_code_url": "",
"qr_code_key": "",
"bank_slip_key": "",
"paid_method_type": null
},
"card_entries": [
{
"card_entry_key": "817dced9-3216-410b-a51c-645019ab320b",
"payment_amount": 125,
"discount_amount": 0,
"affected_items": [
{
"item_key": "04318ab7-7b3c-4558-ad7b-4e9e2d9e0e6e",
"due_date": "2022-07-15",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125,
"present_amount": 100
}
]
},
{
"card_entry_key": "3a3d8bbb-be30-41b0-b5be-8d358dc059ea",
"payment_amount": 225,
"discount_amount": 0,
"affected_items": [
{
"item_key": "1249249c-95b5-45aa-81f1-967abf5e6eef",
"due_date": "2022-07-15",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125,
"present_amount": 100
},
{
"item_key": "c66dad81-ecb4-4afa-8713-a85ee8e721ec",
"due_date": "2022-08-15",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 100,
"present_amount": 120
}
]
}
]
}
```
### Response body details
| Campo | Tipo | Descrição | Caracteres |
|---| ---| ---| ---|
| `reference_date` | string | Data de referencia da renegociação.| |
| `proposal_due_date` | string | Data do vencimento da proposal da renegociação.| |
| `renegotiation_key` | string | Identificador único da renegociação(uuid).| |
| `renegotiation_payment_amount` | number | Valor total da renegociação.| |
| `discount_percentage` | number | Valor do desconto percentual a ser aplicado na renegociação.| |
| `discount_amount` | number | Valor de desconto absoluto a ser aplicado na renegociação.| |
| `payment` | object | Objeto que contém as informações para pagamento da renegociação.| |
| `card_entries` | list | Lista de transações e suas respectivas parcelas a serem renegociadas.| |
## 11.3. Consultar uma renegociação de compras existente:
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/renegotiation/[RENEGOTIATION-KEY]
MÉTODO GET
Testar no Playground
#### QUERY PARAMETERS
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------------------|
| **shorten_url** | Parâmetro utilizado para solicitar uma url de boleto encurtada |
### Response
Response Body
```json
{
"renegotiation_key": "2af29916-582b-4ce7-8440-352a0d9543f7",
"renegotiation_payment_amount": 350,
"reference_date": "2022-07-20",
"renegotiation_status": "pending_payment",
"proposal_due_date": "2022-07-27",
"discount_percentage": 0,
"discount_amount": 0,
"payment": {
"digitable_line": "",
"qr_code_url": "",
"qr_code_key": "",
"bank_slip_key": "",
"paid_method_type": null,
"bank_slip_url": "\",
"short_bank_slip_url": "\"
},
"card_entries": [
{
"card_entry_key": "817dced9-3216-410b-a51c-645019ab320b",
"payment_amount": 125,
"discount_amount": 0,
"affected_items": [
{
"item_key": "04318ab7-7b3c-4558-ad7b-4e9e2d9e0e6e",
"due_date": "2022-07-15",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125,
"present_amount": 100
}
]
},
{
"card_entry_key": "3a3d8bbb-be30-41b0-b5be-8d358dc059ea",
"payment_amount": 225,
"discount_amount": 0,
"affected_items": [
{
"item_key": "1249249c-95b5-45aa-81f1-967abf5e6eef",
"due_date": "2022-07-15",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125,
"present_amount": 100
},
{
"item_key": "c66dad81-ecb4-4afa-8713-a85ee8e721ec",
"due_date": "2022-08-15",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 100,
"present_amount": 120
}
]
}
]
}
```
## 11.4. Cancelamento manual de uma de renegociação:
ENDPOINT /card_invoice/wallet/[WALLET-KEY]/renegotiation/[RENEGOTIATION-KEY]
MÉTODO DELETE
Testar no Playground
### Response
Response Body
```json
{
"renegotiation_key": "2af29916-582b-4ce7-8440-352a0d9543f7",
"renegotiation_status": "canceled"
}
```
## 12. Simulação de cenários:
## 12.1. Fechamento de fatura:
:::info DUE_DATE
O campo due date é um campo opcional, quando não informado a fatura mantém a data de vencimento já definida. a data de fechamento não pode ser informada no futuro e a data de vencimento não pode ser definida antes da data de fechamento.
:::
ENDPOINT /mock/card_invoice/invoice/[INVOICE-KEY]/close
MÉTODO PATCH
### Request
Request Body
```json
{
"closing_date":"2024-10-08",
"due_date":"2024-10-20"
}
```
### Response
Response Body
```json
{}
```