Retrieve Installment Options

The main endpoint is GET /installment/v1/installments. Send merchantId in the request header and the fields below as query parameters. For JSON requests grouped by card brand, use POST /installment/v1/installments/retrieve. Wallet-specific retrieval is available at GET /installment/v1/installments/retrieveWalletInstallments.

Request Fields

  • binNumber: optional string containing 6–8 leading card digits.
  • price: required number, zero or positive.
  • currency: optional Currency value in the current DTO.
  • excludeGatewayPos: optional boolean, default false.
  • subMerchantIds: optional list of sub-merchant identifiers.
  • productItems: optional product information used by applicable installment rules.
  • buyerId, branch, checkoutToken, and subscription: optional flow-specific filters.
  • garantiPay: optional boolean, default false.

Response Fields

Each result can contain binNumber, price, cardType, cardAssociation, cardBrand, bankName, bankCode, force3ds, commercial, farmerCard, posAlias, and installmentPrices.

Each installment-price item contains installmentNumber, installmentPrice, totalPrice, additionalInstallment, description, pfCommissionRate, buyerServicePrice, and buyerPfCommissionRate.