Skip to Content
docs
Installment PaymentInstallment Request

Installment Request

Create an installment payment with a selected installment card and month plan. Use the Get Installments endpoint first to retrieve available options.

POST
***

Request Parameters

NameTypeDescription
public_keyRequired
StringMerchant identifier. Example: `i000000001`
amountRequired
NumberPayment amount. Example: `100`, `20.50`
currencyRequired
StringPayment currency. Values: `AZN`, `USD`, `EUR`, `RUB`
languageRequired
StringPage display language. Values: `az`, `en`, `ru`
order_idRequired
StringUnique order ID. Max 250 characters.
installment_card_idRequired
StringInstallment card identifier from the [Get Installments](/installment/get-installment-request) response.
installment_monthRequired
NumberSelected installment month from available options. Example: `3`, `6`, `12`
descriptionOptional
StringDescription. Max 1000 characters.
success_redirect_urlOptional
StringRedirect URL on success.
error_redirect_urlOptional
StringRedirect URL on failure.
other_attrOptional
ArrayAdditional parameters. Max 1000 characters.

Request Example

Send Request
Payload
{
"public_key": "i000000001",
"amount": 600,
"currency": "AZN",
"language": "az",
"order_id": "order-456",
"installment_card_id": "1",
"installment_month": 6
}
1DATA=$(echo -n '{"public_key":"i000000001","amount":600,"currency":"AZN","language":"az","order_id":"order-456","installment_card_id":"1","installment_month":6}' | 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
statusRequired
StringOperation result: `success` or `error`
redirect_urlOptional
StringURL to redirect the customer to the bank payment page. Present on success.
transactionOptional
StringEpoint transaction identifier. Present on success.
messageOptional
StringError description. Present on failure.
trace_idRequired
StringUnique request identifier for debugging. Provide this to Epoint support for issue investigation.

Success

Success Response
1{
2 "status": "success",
3 "redirect_url": "***",
4 "transaction": "te_0000000001",
5 "trace_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
6}