Create a payment agreement and post the refinanced debt as new installment transactions, beginning from the currently open statement.

The statement_agreement and compulsory flags are used to specify the transaction types of the transactions that are created on the customer's statement. Here are the possible combinations.

<b>Type of payment agreement:</b> Statement agreement Description: The customer renegotiates all debt for all their statements. statement_agreement: true compulsory: false Transaction types of transactions: 712 (INSTALLMENT AGREEMENT) 711 (CREDIT BY AGREEMENT) 713 (CONTRACT AGREEMENT)

<b>Type of payment agreement:</b> Installment agreement Description: This an agreement that the customer makes with their credit card issuer stating that they aren't able to pay off their debt within the current month, so they intend to settle the amount over the next few bills. In other words, the amount that remains outstanding is added to their statement for the following month. statement_agreement: false compulsory: false Transaction types of transactions: 702 (REFINANCING INSTALLMENT) 701 (INSTALLMENT CREDIT) 703 (REFINANCING CONTRACT)

<b>Type of payment agreement:</b> Compulsory agreement Description: This is the same as an installment agreement, except that it's the result of a renegotiation that was made independently of the customer. This is mandatory in Brazil, due to a measure initiated by the Central Bank to protect customers from revolving credit interest charged on the unpaid amount of the invoice. According to this measure, after 30 days, the bank or financial institution must offer more advantageous conditions for the customer to pay off the debt. In practice, the amount owed is automatically divided into installments, allowing the user to fit the payment of the debt into their monthly budget. statement_agreement: false compulsory: true Transaction types of transactions: 722 (CP REFINANCING INSTALLMENT) 721 (CP INSTALLMENT CREDIT) 723 (CP REFINANCING CONTRACT)

<b>Notes:</b>

• The installment transactions for the refinanced debt have transaction type REFINANCING AGREEMENT.
• The following combination is not valid. It returns the error message "A compulsory request requires the statement agreement field to be set to false." statement_agreement: true compulsory: true
• After the installments are created, the Pismo platform asynchronously generates an Installment payment processed event. You should not try to access the new payment agreement until you receive this event.

{
  "statement_agreement": true,
  "installments": [
    {
      "installment_number": 1,
      "total_amount": 40,
      "principal_amount": 38,
      "interest_amount": 1,
      "interest_rate": 0.1,
      "iof_amount": 0.5,
      "daily_iof_amount": 0.5,
      "description": "installment #1",
      "custom_transactions": [
        {
          "custom_key": "tax",
          "amount": 1
        }
      ]
    },
    {
      "installment_number": 2,
      "total_amount": 40,
      "principal_amount": 38,
      "interest_amount": 1,
      "interest_rate": 0.1,
      "iof_amount": 0.5,
      "daily_iof_amount": 0.5,
      "description": "installment #2",
      "custom_transactions": [
        {
          "custom_key": "insurance",
          "amount": 3.99
        }
      ]
    }
  ],
  "compulsory": true,
  "payment_datetime": "2021-04-14T12:00:00-03:00",
  "credit_transaction_description": "CREDIT TRANSACTION",
  "metadata": {
    "key-1": 10,
    "key-2": 5
  },
  "custom_contract_transactions": [
    {
      "custom_key": "tax",
      "amount": 100
    },
    {
      "custom_key": "insurance",
      "amount": 200
    }
  ]
}

{
  "id": 1,
  "statement_agreement": false,
  "status": "PROCESSED",
  "created_at": "2020-08-15T11:55:39Z",
  "compulsory": true,
  "split_iof": true
}