Create payment agreement

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.

Type of payment agreement: 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)

Type of payment agreement: 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)

Type of payment agreement: 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)

Note: 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Account ID

Body Params
boolean
required

Is the generated agreement a statement agreement (true) or an installment agreement (false)?

installments
array of objects
required

Installment payments.

Note: You must define at least 2 installment payments.

installments*
boolean
Defaults to false

Is the generated agreement a compulsory agreement (true) or not (false)?

boolean
Defaults to false

Is the generated agreement settled to accrual (true) or not (false)? If true, pending accruals are included when calculating the refinanced amount.

boolean
Defaults to false

Should IOF be split? If true, the Pismo platform generates a separate transaction for the IOF tax.

boolean
Defaults to false

Set to true if the original installment rate should be used to generate accruals. Set to false, otherwise. The original installment rate is the payment agreement contract interest rate. So, if this field is set to true, this rate is used instead of the transaction category interest rate when a payment agreement installment is due.

date-time

Date/time of the down payment. Format = YYYY-MM-DDThr:mm:ss.

This field may represent the payment date for the down payment. When provided, this date is used as the transaction event date for credit and installments.

string

Credit Transaction Description field is up to 100 characters.

metadata
object

This is a JSON object converted to a string with additional information relevant to the customer. No business rule validation is performed on it.

custom_contract_transactions
array of objects

Allows to register a separate custom contract transaction

custom_contract_transactions
Headers
string
required

Account token, not a regular access token. Account tokens are encoded with an account ID. Tokens can expire quickly, which can result in an Unauthorized message.

Responses

Language
Credentials
Bearer
Account JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json