Search Installments

As a result of the installment inquiry service, the amounts to be paid in installments and single installment of the card families are returned and this amount should be used together with the payment service paidPrice and installment parameters. If the service is to be used by entering the BIN number, it must be called after the first 8 digits of the card are entered on the payment page. It is used to show the returned answer to the user for installment selection. The installment options returned by the service are related to the information in the pos management in the merchant panel.

URL

The endpoint and http method information to search installments are stated below.

GETinstallment/v1/installments

Request Parameters

The parameters expected to be sent in requests to installment inquiry are listed under the table and subheadings below.

binNumber

number

The first 8 digits of the card to be used for installment inquiry.
- If this parameter is provided, installment options will be returned only for the card brand associated with the specified BIN number.
- If not provided, installment options for all card families supported by your POSs will be returned.

price

decimal

required

Price

currency

Currency

Currency of the price. See: Currencies

Values:

TRY

USD

EUR

GBP

CNY

ARS

BRL

AED

IQD

AZN

KZT

KWD

SAR

BHD

RUB

JPY

EGP

distinctCardBrandsWithLowestCommissions

boolean

In cases where multiple results exist for a single card brand, card-brand-based deduplication is performed based on the merchant's POS routing rules.
If this parameter is set to true and the binNumber parameter is not provided, the response will not include the bankCode and bankName fields.

loyaltyExists

boolean

It is used to return only loyalty supported installments.

paymentPhase

PaymentPhase

If the payment will be processed with pre-authorization, this values should be PRE_AUTH. See: Payment Phases

Values:

AUTH

PRE_AUTH

POST_AUTH

Response Parameters

binNumber

string

First 8 digits of the card number

price

decimal

Price

cardType

CardType

See: Card Types

Values:

CREDIT_CARD

DEBIT_CARD

PREPAID_CARD

cardAssociation

CardAssociation

Card Association

Values:

VISA

MASTER_CARD

AMEX

TROY

JCB

UNION_PAY

MAESTRO

DISCOVER

DINERS_CLUB

cardBrand

string

Represents card programme's of the banks such as Axess and Bonus

bankName

string

If binNumber parameter is provided, returns the name of the bank associated with the card.
If binNumber parameter is not provided and distinctCardBrandsWithLowestCommissions parameter is false, returns the bank name associated with the Virtual POS.
If binNumber parameter is not provided and distinctCardBrandsWithLowestCommissions parameter is true, this field will not be returned.

bankCode

number

If binNumber parameter is provided, returns the bank code associated with the card.
If binNumber parameter is not provided and distinctCardBrandsWithLowestCommissions parameter is false, returns the bank code associated with the Virtual POS.
If binNumber parameter is not provided and distinctCardBrandsWithLowestCommissions parameter is true, this field will not be returned.

force3ds

boolean

Information on whether 3DSecure payment is required. If the card used is debit and 3DSecure requirement is checked for the pos from the merchant panel, it returns true. If true is returned, the payment must be made through 3DSecure.

cvcRequired

boolean

Information on whether CVC is required. Returns true if payment without cvc option is not checked from the merchant panel.

commercial

boolean

Information on whether card is commercial. If a product such as food, which is prohibited from using installments for individual cards, is added to the basket, you should check the commercial parameter. You should not make installments when it returns false. If the card used is a commercial card, this parameter will return true.

installmentPrices

InstallmentPrice[]

Installment prices for each installment option.

tip

You can list installment options optimized for two different scenarios:

• To list installment options for all card brands:
  • distinctCardBrandsWithLowestCommissions: true
  • Do not use binNumber parameter
  • This way you can list installment options based on card brands

• To list installment options for the card entered during payment:
  • distinctCardBrandsWithLowestCommissions: true
  • Send the first 8 digits of the user's card number as binNumber parameter
  • This way you can list valid installment options specific to user's card

Sample Codes

You can review the sample codes in the open source Craftgate API clients.

Java.NETPHPNode.jsGo