Skip to main content

Installments

Marlim provides your customer with the option to split the purchase into up to 18 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.

Warning

Even with installments above 12x enabled on Marlim, transactions with 13 to 18 installments are subject to the rules of the card issuer and the brand used. Not all issuing banks and brands support this type of installment.

When a transaction is declined due to this restriction, Marlim has no control over the decision and does not receive an indication from the acquirer that the decline occurred specifically because of the number of installments requested.

Because of this behavior, customers may receive an error response when attempting transactions with installments above 12x, even if the feature is enabled on the platform.

GETv3/installments

Request Query Params​

AttributeTypeDescription
net_valueint32The net value that your platform wants to receive for a transaction.
card_brandint32Card brand. Accepted values: visa, mastercard, amex, hipercard and elo.
pt_brbooleanOptional parameter that can be passed to return values formatted in Brazilian Real (BRL).
Default: false
chargeback_ownerstringOptional 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​

PropertyTypeDescription
installmentstringNumber of installments.
amountint32Final amount to be charged to the consumer regarding the installment (including acquirer fees).
installment_valueint32Amount that the consumer will be charged monthly.
interest_ratefloat32Value referring to the percentage of the acquirer fee.
pt_brobjectObject 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$).

PropertyTypeDescription
amountfloat32The amount value divided by 100. The reverse path of cents.
amount_currencystringThe amount value using the Javascript method toLocaleString()
installment_valuefloat32The monthly installment value divided by 100. The reverse path of cents.
installment_value_currencystringThe monthly installment value using the Javascript method toLocaleString()
interest_ratestringPercentage of the acquirer fee in pt_br format.
Warning

Installments above 12x (13x to 18x) are not enabled by default for all accounts. This feature must be previously enabled by Marlim before your platform can use it. Contact our support team to check the availability and enablement of these additional installments.

Examples​

Request
curl -X GET -G "https://api.marlim.co/v3/installments" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d net_value=1000 \ 
-d card_brand="visa"
Response200
[
  {
    "installment": "1",
    "amount": 1054,
    "installment_value": 1054,
    "interest_rate": 5.4
  },
  {
    "installment": "2",
    "amount": 1078,
    "installment_value": 539,
    "interest_rate": 7.78
  },
  {
    "installment": "3",
    "amount": 1091,
    "installment_value": 364,
    "interest_rate": 9.09
  },
  {
    "installment": "4",
    "amount": 1104,
    "installment_value": 276,
    "interest_rate": 10.41
  },
  {
    "installment": "5",
    "amount": 1118,
    "installment_value": 224,
    "interest_rate": 11.78
  },
  {
    "installment": "6",
    "amount": 1132,
    "installment_value": 189,
    "interest_rate": 13.17
  },
  {
    "installment": "7",
    "amount": 1152,
    "installment_value": 165,
    "interest_rate": 15.25
  },
  {
    "installment": "8",
    "amount": 1167,
    "installment_value": 146,
    "interest_rate": 16.74
  },
  {
    "installment": "9",
    "amount": 1183,
    "installment_value": 131,
    "interest_rate": 18.26
  },
  {
    "installment": "10",
    "amount": 1198,
    "installment_value": 120,
    "interest_rate": 19.83
  },
  {
    "installment": "11",
    "amount": 1214,
    "installment_value": 110,
    "interest_rate": 21.43
  },
  {
    "installment": "12",
    "amount": 1231,
    "installment_value": 103,
    "interest_rate": 23.08
  },
  {
    "installment": "13",
    "amount": 1248,
    "installment_value": 96,
    "interest_rate": 24.77
  },
  {
    "installment": "14",
    "amount": 1265,
    "installment_value": 90,
    "interest_rate": 26.5
  },
  {
    "installment": "15",
    "amount": 1283,
    "installment_value": 86,
    "interest_rate": 28.27
  },
  {
    "installment": "16",
    "amount": 1301,
    "installment_value": 81,
    "interest_rate": 30.08
  },
  {
    "installment": "17",
    "amount": 1319,
    "installment_value": 78,
    "interest_rate": 31.93
  },
  {
    "installment": "18",
    "amount": 1338,
    "installment_value": 74,
    "interest_rate": 33.82
  }
]