GitHubFeedback Form

Installment & BIN Service

Installment Inquiry

post

The API provides installment counts, rates and amounts, as well as attributes such as issuing bank, card family and card scheme. It lists available installment options based on the given BIN and amount. You can also query installment rates with only the BIN or only the amount.

Header parameters
AuthorizationstringRequired

Authorization header that starts with IYZWSv2 and contains a Base64-encoded signed hash.

Example: IYZWSv2 aXBzaWduYXR1cmU...
Content-TypestringRequired

Content-Type value.

Example: application/json
Body
localestring · enumOptional

Language preference used in requests and responses.

Example: enPossible values:
pricenumber · decimalRequired

Amount for installment calculation.

Example: 100
binNumberstringOptional

8-digit card BIN. If provided, suitability is returned per card/bank. If omitted, installment rates can be returned based on the amount only.

Example: 54308100
conversationIdstringOptional

Request/response correlation ID. The value sent in the request is returned as-is in the response.

Example: 123456789
Responses
200

Successful response

application/json
post
POST https://sandbox-api.iyzipay.com/payment/iyzipos/installment
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib3gtcU43VzljOXI3aWhZZUs5Z2ZqbFhRWFlPUUZteEQyNkEmcmFuZG9tS2V5OjE3NTY0NjkyMjgyMzQxMjM0NTY3ODkmc2lnbmF0dXJlOmRmMzEwNjI2MTI0OGNhZTcxMDJlZDQxMjhjODA4MmIwOTlhMzU4OWNmZDc3MTNkODNlODk5YWEzMDg0NDBkZDg=
Content-Type: application/json

{
  "locale": "en",
  "price": 100.0,
  "binNumber": "54308100",
  "conversationId": "123456789"
}

{
  "status": "success",
  "locale": "en",
  "systemTime": 1755547819061,
  "conversationId": "123456789",
  "installmentDetails": [
    {
      "binNumber": "54308100",
      "price": 100,
      "cardType": "CREDIT_CARD",
      "cardAssociation": "MASTER_CARD",
      "cardFamilyName": "Paraf",
      "force3ds": 0,
      "bankCode": 12,
      "bankName": "Halkbank",
      "forceCvc": 0,
      "commercial": 0,
      "dccEnabled": 0,
      "agricultureEnabled": 0,
      "installmentPrices": [
        {
          "installmentPrice": 100,
          "totalPrice": 100,
          "installmentNumber": 1
        },
        {
          "installmentPrice": 51.61,
          "totalPrice": 103.22,
          "installmentNumber": 2
        },
        {
          "installmentPrice": 35.08,
          "totalPrice": 105.25,
          "installmentNumber": 3
        },
        {
          "installmentPrice": 18.7,
          "totalPrice": 112.22,
          "installmentNumber": 6
        },
        {
          "installmentPrice": 13.35,
          "totalPrice": 120.19,
          "installmentNumber": 9
        },
        {
          "installmentPrice": 10.77,
          "totalPrice": 129.2,
          "installmentNumber": 12
        }
      ]
    }
  ]
}

BIN Inquiry

post

Retrieves card attributes in BIN inquiries such as issuing bank, card family, and card scheme. To obtain the desired information, simply include the required parameters in your request. The API will respond with comprehensive details.

Header parameters
AuthorizationstringRequired

Authorization header that starts with IYZWSv2 and contains a Base64-encoded signed hash.

Example: IYZWSv2 aXBzaWduYXR1cmU...
Content-TypestringRequired

Content-Type value.

Example: application/json
Body
localestring · enumOptional

Language preference used in requests and responses.

Example: enPossible values:
binNumberstringRequired

BIN to query (8 digits).

Example: 41579200
conversationIdstringOptional

Request/response correlation ID. The value sent in the request is returned as-is in the response.

Example: 1a2b3c4d5e6f
Responses
200

Successful response

application/json
post
POST https://sandbox-api.iyzipay.com/payment/bin/check
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib3gtNE9hdVQwRX....cwZWMxZWIzZGU5Y2IwNTRkMjk4Zjc1NThlNmRiMmQwYTQ2NjA4NzJmYzY0NGFjNg==
Content-Type: application/json

{
  "locale": "en",
  "binNumber": "41579200",
  "conversationId": "1a2b3c4d5e6f"
}

{
  "binNumber": "41579200",
  "cardType": "CREDIT_CARD",
  "cardAssociation": "MASTER_CARD",
  "cardFamily": "World",
  "bankName": "Vakıfbank",
  "bankCode": 15,
  "commercial": 0,
  "status": "success",
  "locale": "en",
  "systemTime": 1755547712091,
  "conversationId": "1a2b3c4d5e6f"
}
PreviousAPI Reference (Beta)NextPayment Methods

Last updated