Installments

Endpoint that returns an array with all available installment options based on the input data provided for merchants.

Choose your environment

Bamboo provides two environments. Depending on how you handle card data, the endpoint you should use varies:

  • Staging for simulations and homologation (recommended first).
  • Production for live payments after certification.

EnvironmentEndpoint
Staginghttps://api.stage.bamboopayment.com/v1/api/installment/calculate
Productionhttps://api.bamboopayment.com/v1/api/installment/calculate

Building the request

Headers

⚠️

Remember to include the Merchant Private Key in the request headers.

For more details, refer to our Authentication Guide

Request parameters

ParameterTypeMandatory?Description
CountryCodestringYesCountry where the payment will be processed (ISO-3166-1).
CurrencyCodestringYesISO-4217 currency.
Amountinteger (64bit)YesAmount with two decimals, no separators (12.251225).
BINstringNoCard BIN.
TokenstringNoCard Token.

Request example

{
  "CountryCode": "AR",
  "CurrencyCode": "ARS",
  "Amount": 150000,
  "Bin": "123456",
  "Token": "OT__ar_7Jr8K2rQyZC9m4fVx1pQw2e3s4t5u6v"
}

Response Parameters

ParameterTypeDescription
CountryCodestringCountry where the payment will be processed (ISO-3166-1).
CurrencyCodestringISO-4217 currency.
Amountinteger (64bit)Amount with two decimals, no separators (12.251225).
BINstringCard BIN.
TokenstringCard Token.
InstallmentsobjectInstallments Data

Installments Data Obtect

Parameter

Type

Description

InstallmentNumber

integer

Installment number configure for the merchant

InstallmentFee

integer (64bit)

Fee percentage that applies to the transaction

TotalAmount

integer (64bit)

Final transaction amount with the fee assumed by the end user
Amount with two decimals, no separators (12.251225).

InstallmentAmount

integer (64bit)

Amount of each installment


Response example

{
    "CountryCode": "AR",
    "CurrencyCode": "ARS",
    "Amount": 150000,
    "Bin": null,
    "Token": null,
    "Installments": [
        {
            "InstallmentNumber": 2,
            "InstallmentFee": 10,
            "TotalAmount": 165000,
            "InstallmentAmount": 82500
        },
        {
            "InstallmentNumber": 3,
            "InstallmentFee": 20,
            "TotalAmount": 180000,
            "InstallmentAmount": 60000
        }
    ]
}