Installments
Marlim provides your customer with the option to split the purchase into up to 12 installments. This endpoint will only be necessary if your platform passes on the Acquirer fees to your end consumer.
With this route, it is possible to calculate the fees that your platform needs to charge, before making a transaction to return the installment values and monthly fees.
GETv3/installments
Request Query Params
| Attribute | Type | Description |
|---|---|---|
| net_value | int32 | The net value that your platform wants to receive for a transaction. |
| card_brand | int32 | Card brand. Accepted values: visa, mastercard, amex, hipercard and elo. |
| pt_br | boolean | Optional parameter that can be passed to return values formatted in Brazilian Real (BRL). Default: false |
| chargeback_owner | string | Optional parameter that defines who will be responsible for the transaction chargeback. Accepted values: acquirer or seller Default: acquirer |
Warning
The value in net_value must be passed in cents (e.g., R$ 10.00 = 1000) and must be greater than or equal to R$ 1.00 (100).
Response Object
| Property | Type | Description |
|---|---|---|
| installment | string | Number of installments. |
| amount | int32 | Final amount to be charged to the consumer regarding the installment (including acquirer fees). |
| installment_value | int32 | Amount that the consumer will be charged monthly. |
| interest_rate | float32 | Value referring to the percentage of the acquirer fee. |
| pt_br | object | Object with values formatted in Brazilian Real (BRL). |
Brazilian Real Object
To facilitate the Front-End, you can optionally pass the parameter pt_br with the value true to return the values formatted in Brazilian Real (BRL / R$).
| Property | Type | Description |
|---|---|---|
| amount | float32 | The amount value divided by 100. The reverse path of cents. |
| amount_currency | string | The amount value using the Javascript method toLocaleString() |
| installment_value | float32 | The monthly installment value divided by 100. The reverse path of cents. |
| installment_value_currency | string | The monthly installment value using the Javascript method toLocaleString() |
| interest_rate | string | Percentage of the acquirer fee in pt_br format. |