Skip to Content
docs
Installment PaymentGet Installments

Get Installments

Retrieve available installment cards and their supported month options. Use this endpoint to display installment plans to the customer before creating a payment.

POST
***

Request Parameters

NameTypeDescription
public_keyRequired
StringMerchant identifier. Example: `i000000001`
currencyRequired
StringPayment currency. Values: `AZN`, `USD`, `EUR`, `RUB`
languageRequired
StringPage display language. Values: `az`, `en`, `ru`
order_idRequired
StringUnique order ID. Max 250 characters.
amountOptional
NumberPayment amount. Example: `100`, `20.50`
descriptionOptional
StringDescription. Max 1000 characters.
other_attrOptional
ArrayAdditional parameters. Max 1000 characters.

Request Example

Send Request
Payload
{
  "public_key": "i000000001",
  "currency": "AZN",
  "language": "az",
  "order_id": "order-123"
}
1DATA=$(echo -n '{"public_key":"i000000001","currency":"AZN","language":"az","order_id":"order-123"}' | base64)
2SIGNATURE=$(echo -n "$PRIVATE_KEY$DATA$PRIVATE_KEY" | openssl dgst -sha1 -binary | base64)
3

4curl -X POST *** \
5-H "Content-Type: application/x-www-form-urlencoded" \
6-d "data=$DATA&signature=$SIGNATURE"

Response Parameters

NameTypeDescription
nameRequired
StringInstallment card name.
installment_card_idRequired
StringInstallment card identifier. Use this value when creating an installment payment.
installment_monthsRequired
ArrayAvailable installment month options. Example: `[3, 6, 12]`

Success

Success Response
1[
2  {
3    "name": "Birbank Taksit",
4    "installment_card_id": "1",
5    "installment_months": [
6      3,
7      6,
8      12
9    ]
10  },
11  {
12    "name": "Tamkart Taksit",
13    "installment_card_id": "2",
14    "installment_months": [
15      3,
16      6,
17      9,
18      12
19    ]
20  }
21]

Note: Use the installment_card_id and one of the installment_months values when creating an installment payment via the Installment Request endpoint.

OverviewInstallment Request