Parcelas

A Marlim fornece a opção de parcelar a compra em até 12x no crédito na API Ouro Minas. Use esta rota para calcular as taxas antes de realizar uma transação, retornando os valores das parcelas e as taxas ao mês.

No débito, a cobrança é sempre à vista (1x). Nesse caso, informe payment_method=debit na query: a API devolve apenas um objeto de parcela (1x), com a taxa de adquirência própria do débito. O paid_amount do POST /v1/om/transactions deve coincidir com o campo amount desse retorno para o mesmo net_value.

No crédito, omita o parâmetro ou use payment_method=credit: a resposta lista as opções de 1 a 12 parcelas. O paid_amount informado no POST de criação de transação deve coincidir com o valor retornado por esta rota para o net_value e a quantidade de parcelas escolhida.

GETv1/om/installments

Request Query Params

Propriedade	Tipo	Descrição
net_value	int32	Valor líquido em centavos que sua plataforma deseja receber. Deve ser maior ou igual a 1 e no máximo 1.000.000.000 (10 milhões de reais).
payment_method	string	Opcional. credit (padrão quando omitido) ou debit. Com debit, a resposta contém somente a opção 1x. Outros valores retornam erro de validação.

Importante

O valor em net_value deve ser passado em centavos (ex.: R$ 10,00 = 1000).

Response Object

Retorna um array de objetos:

• payment_method=credit ou parâmetro omitido: um item para cada parcela de 1 a 12.
• payment_method=debit: um único item (sempre 1x).

Cada objeto possui:

Propriedade	Tipo	Descrição
installment	string	Quantidade de parcelas. No crédito: de 1 a 12. No débito: sempre 1.
amount	int32	Valor total em centavos a ser cobrado do consumidor (com as taxas de adquirência).
installment_value	int32	Valor em centavos que o consumidor pagará por mês.
interest_rate	float32	Taxa de adquirência em porcentagem.
monthly_interest_rate	float32	Taxa de adquirência mensal em porcentagem.
amount_pt_br	string	Valor total formatado em Real (BRL).
installment_value_pt_br	string	Valor mensal formatado em Real (BRL).
interest_rate_pt_br	string	Taxa em formato pt-BR.
monthly_interest_rate_pt_br	string	Taxa mensal em formato pt-BR (ex.: "X,X% a.m").

Exemplo cURL

# Crédito (1 a 12 parcelas; padrão se não enviar payment_method)
curl -X GET -G "https://api.om.marlim.co/v1/om/installments" \
  -H "Content-Type: application/json" \
  -H "api_key: api_key_value" \
  -d net_value=1000

# Débito (apenas 1x)
curl -X GET -G "https://api.om.marlim.co/v1/om/installments" \
  -H "Content-Type: application/json" \
  -H "api_key: api_key_value" \
  -d net_value=1000 \
  -d payment_method=debit

Exemplo de resposta

Crédito (net_value=1000)

Request

  curl GET https://api.om.marlim.co/v1/om/installments?net_value=1000
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{}'

Response

[
  {
    "installment": "1",
    "amount": 1048,
    "installment_value": 1048,
    "interest_rate": 4.76,
    "monthly_interest_rate": 4.76,
    "amount_pt_br": "R$ 10,48",
    "installment_value_pt_br": "R$ 10,48",
    "interest_rate_pt_br": "4,76%",
    "monthly_interest_rate_pt_br": "4,76% a.m"
  },
  {
    "installment": "2",
    "amount": 1063,
    "installment_value": 532,
    "interest_rate": 6.34,
    "monthly_interest_rate": 3.12,
    "amount_pt_br": "R$ 10,63",
    "installment_value_pt_br": "R$ 5,32",
    "interest_rate_pt_br": "6,34%",
    "monthly_interest_rate_pt_br": "3,12% a.m"
  },
  {
    "installment": "3",
    "amount": 1081,
    "installment_value": 360,
    "interest_rate": 8.06,
    "monthly_interest_rate": 2.61,
    "amount_pt_br": "R$ 10,81",
    "installment_value_pt_br": "R$ 3,60",
    "interest_rate_pt_br": "8,06%",
    "monthly_interest_rate_pt_br": "2,61% a.m"
  }
]

Débito 1x (net_value=1000)

Request

  curl GET https://api.om.marlim.co/v1/om/installments?net_value=1000&payment_method=debit
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{}'

Response

[
  {
    "installment": "1",
    "amount": 1016,
    "installment_value": 1016,
    "interest_rate": 1.57,
    "monthly_interest_rate": 1.57,
    "amount_pt_br": "R$ 10,16",
    "installment_value_pt_br": "R$ 10,16",
    "interest_rate_pt_br": "1,57%",
    "monthly_interest_rate_pt_br": "1,57% a.m"
  }
]