Pular para o conteúdo principal

Parcelas

A Marlim fornece ao seu cliente a opção de parcelar a compra em até 12x. Esse endpoint só será necessário caso sua plataforma repasse as taxas de Adquirência para o seu consumidor final.

Com essa rota é possível calcular as taxas que sua plataforma precisa cobrar, antes de realizar uma transação para retornar os valores das parcelas e as taxas ao mês.

GETv3/installments

Request Query Params

AtributoTipoDescrição
net_valueint32O valor líquido que sua plataforma deseja receber por uma transação.
card_brandint32Bandeira do cartão. Valores aceitos: visa, mastercard, amex, hipercard e elo.
pt_brbooleanParâmetro opcional que pode ser passado para retornar valores formatados em Real Brasileiro (BRL).
Default: false
Atenção

O valor em net_value deve ser passado em centavos (ex: R$ 10,00 = 1000) e deve ser maior ou igual a R$ 1,00 (100).

Response Object

PropriedadeTipoDescrição
installmentstringQuantidade de parcelas.
amountint32Valor final a ser cobrado do consumidor referente a parcela (com as taxas de adquirência inclusas).
installment_valueint32Valor que o consumidor será cobrado ao mês.
interest_ratefloat32Valor referente a porcentagem da taxa de adquirência.
pt_brobjectObjeto com valores formatados em Real Brasileiro (BRL).

Real Brasileiro Object

Para facilitar o Front-End, opcionalmente você pode passar o parâmetro pt_br com o valor true para retornar os valores formatados em Real Brasileiro (BRL / R$).

PropriedadeTipoDescrição
amountfloat32O valor em amout dividido por 100. O caminho inverso dos centavos.
amount_currencystringO valor em amout utilizando o método do Javascript toLocaleString()
installment_valuefloat32O valor mensal da parcela dividido por 100. O caminho inverso dos centavos.
installment_value_currencystringO valor mensal da parcela utilizando o método do Javascript toLocaleString()
interest_ratestringPorcentagem da taxa de adquirência em formato pt_br.

Exemplos

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
}
]