Installments
Marlim provides the option to split the purchase of foreign currencies in up to 12 installments. Use this endpoint before performing a authorization to return monthly installment amounts and fees.
GETv1/installments
Request Query Params
| Attribute | Type | Description |
|---|---|---|
| net_value | int32 | Amount to be charged. Must be spent in cents. E.g.: BRL 1,000.00 = 100000. |
| card_brand | int32 | Card brand. Accepted values: visa, mastercard, amex, hipercard e elo. |
| pt_br | boolean | Optional parameter that can be passed to return values formatted in Brazilian Real (BRL). |
caution
The value in net_value must be passed in cents (e.g.: BRL 10.00 = 1000) and must be greater than or equal to BRL 1.00 (100).
Response Object
| Property | Type | Description |
|---|---|---|
| installment | string | Number of installments. |
| gross_amout | int32 | Total amount to be charged to the customer for the installment. |
| installment_value | int32 | Amount that the customer will be charged per month. |
| interest_rate | float32 | Value referring to the percentage of the acquisition fee. |
| pt_br | object | Object with values formatted in Brazilian Real (BRL). |
Real Brasileiro Object
To facilitate the Front-End, you can optionally pass the pt_br parameter with the value true to return values formatted in Brazilian Real (BRL / R$).
| Propriedade | Tipo | Descrição |
|---|---|---|
| gross_amout | float32 | The value in amout divided by 100. The reverse path of cents. |
| gross_amout_currency | string | The value in amout using Javascript's toLocaleString() method. |
| installment_value | float32 | The monthly installment amount divided by 100. The reverse path of cents. |
| installment_value_currency | string | The monthly installment amount using the Javascript method toLocaleString(). |
| interest_rate | string | Acquire rate percentage in pt_br format. |
Samples
- Visa Card
- Amex Card
- With PT_BR
curl -X GET -G "https://api.wu.global.marlim.co/v1/installments" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d net_value=100000 \
-d card_brand="visa"
[
{
"installment": "1",
"gross_amout": 103950,
"installment_value": 103950,
"interest_rate": 3.95
},
{
"installment": "2",
"gross_amout": 105652,
"installment_value": 52826,
"interest_rate": 5.65
},
{
"installment": "3",
"gross_amout": 106781,
"installment_value": 35594,
"interest_rate": 6.78
},
{
"installment": "4",
"gross_amout": 107933,
"installment_value": 26983,
"interest_rate": 7.93
},
{
"installment": "5",
"gross_amout": 109111,
"installment_value": 21822,
"interest_rate": 9.11
},
{
"installment": "6",
"gross_amout": 110314,
"installment_value": 18386,
"interest_rate": 10.31
},
{
"installment": "7",
"gross_amout": 112233,
"installment_value": 16033,
"interest_rate": 12.23
},
{
"installment": "8",
"gross_amout": 113507,
"installment_value": 14188,
"interest_rate": 13.51
},
{
"installment": "9",
"gross_amout": 114811,
"installment_value": 12757,
"interest_rate": 14.81
},
{
"installment": "10",
"gross_amout": 116144,
"installment_value": 11614,
"interest_rate": 16.14
},
{
"installment": "11",
"gross_amout": 117508,
"installment_value": 10683,
"interest_rate": 17.51
},
{
"installment": "12",
"gross_amout": 118906,
"installment_value": 9909,
"interest_rate": 18.91
}
]
curl -X GET -G "https://api.wu.global.marlim.co/v1/installments" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d net_value=500000 \
-d card_brand="amex"
[
{
"installment": "1",
"gross_amout": 523013,
"installment_value": 523013,
"interest_rate": 4.6
},
{
"installment": "2",
"gross_amout": 529101,
"installment_value": 264551,
"interest_rate": 5.82
},
{
"installment": "3",
"gross_amout": 534759,
"installment_value": 178253,
"interest_rate": 6.95
},
{
"installment": "4",
"gross_amout": 540540,
"installment_value": 135135,
"interest_rate": 8.11
},
{
"installment": "5",
"gross_amout": 546448,
"installment_value": 109290,
"interest_rate": 9.29
},
{
"installment": "6",
"gross_amout": 552486,
"installment_value": 92081,
"interest_rate": 10.5
},
{
"installment": "7",
"gross_amout": 561798,
"installment_value": 80257,
"interest_rate": 12.36
},
{
"installment": "8",
"gross_amout": 568182,
"installment_value": 71023,
"interest_rate": 13.64
},
{
"installment": "9",
"gross_amout": 574713,
"installment_value": 63857,
"interest_rate": 14.94
},
{
"installment": "10",
"gross_amout": 581395,
"installment_value": 58140,
"interest_rate": 16.28
},
{
"installment": "11",
"gross_amout": 588235,
"installment_value": 53476,
"interest_rate": 17.65
},
{
"installment": "12",
"gross_amout": 595238,
"installment_value": 49603,
"interest_rate": 19.05
}
]
curl -X GET -G "https://api.wu.global.marlim.co/v1/installments" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d net_value=100000 \
-d card_brand="visa" \
-d pt_br=true
[
{
"installment": "1",
"gross_amout": 103950,
"installment_value": 103950,
"interest_rate": 3.95,
"pt_br": {
"gross_amout": 1039.5,
"gross_amout_currency": "R$ 1.039,50",
"installment_value": 1039.5,
"installment_value_currency": "R$ 1.039,50",
"interest_rate": "3,95%"
}
},
{
"installment": "2",
"gross_amout": 105652,
"installment_value": 52826,
"interest_rate": 5.65,
"pt_br": {
"gross_amout": 1056.52,
"gross_amout_currency": "R$ 1.056,52",
"installment_value": 528.26,
"installment_value_currency": "R$ 528,26",
"interest_rate": "5,65%"
}
},
{
"installment": "3",
"gross_amout": 106781,
"installment_value": 35594,
"interest_rate": 6.78,
"pt_br": {
"gross_amout": 1067.81,
"gross_amout_currency": "R$ 1.067,81",
"installment_value": 355.94,
"installment_value_currency": "R$ 355,94",
"interest_rate": "6,78%"
}
},
{
"installment": "4",
"gross_amout": 107933,
"installment_value": 26983,
"interest_rate": 7.93,
"pt_br": {
"gross_amout": 1079.33,
"gross_amout_currency": "R$ 1.079,33",
"installment_value": 269.83,
"installment_value_currency": "R$ 269,83",
"interest_rate": "7,93%"
}
},
{
"installment": "5",
"gross_amout": 109111,
"installment_value": 21822,
"interest_rate": 9.11,
"pt_br": {
"gross_amout": 1091.11,
"gross_amout_currency": "R$ 1.091,11",
"installment_value": 218.22,
"installment_value_currency": "R$ 218,22",
"interest_rate": "9,11%"
}
},
{
"installment": "6",
"gross_amout": 110314,
"installment_value": 18386,
"interest_rate": 10.31,
"pt_br": {
"gross_amout": 1103.14,
"gross_amout_currency": "R$ 1.103,14",
"installment_value": 183.86,
"installment_value_currency": "R$ 183,86",
"interest_rate": "10,31%"
}
},
{
"installment": "7",
"gross_amout": 112233,
"installment_value": 16033,
"interest_rate": 12.23,
"pt_br": {
"gross_amout": 1122.33,
"gross_amout_currency": "R$ 1.122,33",
"installment_value": 160.33,
"installment_value_currency": "R$ 160,33",
"interest_rate": "12,23%"
}
},
{
"installment": "8",
"gross_amout": 113507,
"installment_value": 14188,
"interest_rate": 13.51,
"pt_br": {
"gross_amout": 1135.07,
"gross_amout_currency": "R$ 1.135,07",
"installment_value": 141.88,
"installment_value_currency": "R$ 141,88",
"interest_rate": "13,51%"
}
},
{
"installment": "9",
"gross_amout": 114811,
"installment_value": 12757,
"interest_rate": 14.81,
"pt_br": {
"gross_amout": 1148.11,
"gross_amout_currency": "R$ 1.148,11",
"installment_value": 127.57,
"installment_value_currency": "R$ 127,57",
"interest_rate": "14,81%"
}
},
{
"installment": "10",
"gross_amout": 116144,
"installment_value": 11614,
"interest_rate": 16.14,
"pt_br": {
"gross_amout": 1161.44,
"gross_amout_currency": "R$ 1.161,44",
"installment_value": 116.14,
"installment_value_currency": "R$ 116,14",
"interest_rate": "16,14%"
}
},
{
"installment": "11",
"gross_amout": 117508,
"installment_value": 10683,
"interest_rate": 17.51,
"pt_br": {
"gross_amout": 1175.08,
"gross_amout_currency": "R$ 1.175,08",
"installment_value": 106.83,
"installment_value_currency": "R$ 106,83",
"interest_rate": "17,51%"
}
},
{
"installment": "12",
"gross_amout": 118906,
"installment_value": 9909,
"interest_rate": 18.91,
"pt_br": {
"gross_amout": 1189.06,
"gross_amout_currency": "R$ 1.189,06",
"installment_value": 99.09,
"installment_value_currency": "R$ 99,09",
"interest_rate": "18,91%"
}
}
]