Checkout reference data

Get one bank's installment plans

Retrieves the installment plans a single bank offers on the merchant account — the durations the customer can pick from and the minimum amount each plan requires. Returns an empty array when the bank has no plans enabled on the account. To price a plan against a specific basket amount, including the monthly instalment and the bank interest rate, use the Installments endpoints instead.

get/v2/merchants/{merchantId}/installments/banks/{bankId}

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/merchants/{merchantId}/installments/banks/{bankId}
  • Auth: none required

Path parameters

merchantIdstring required

Merchant account number or merchant ID, in the MID-XXX-XXX format, e.g. YOUR_MID.

bankIdstring required

The bank's bankId, taken from the installment banks lookup.

Response

The bank's installment plans, or an empty array when none are enabled.

_idstring

The plan's identifier.

planDurationinteger

The number of months the customer pays over.

minimunInstallmentAmountnumber

The smallest amount that qualifies for the plan. (The field name is misspelled in the API and kept as-is for compatibility.)

feesnumber

The fee applied to the plan.

Changes

No recorded changes to this operation across all 1 revision of this API.