Version: current
Installments Plan
info
The Installments Plan API needs to be enabled on your account. Contact your account manager and our integration team for more details.
Overview
The End User Fees API returns a list of applicable installment options and their respective fees to allow a detailed selection for end users to choose the most appropriate combination for their purchases.
How it works
- Get the list of available installments plans
Call the Installments Plan API to get the list of applicable installments options that can be made available to the end user.
Installments Plan Request Structure
POST /ws/installments-plans/v2
| Parameter | Data Type | Description |
|---|---|---|
| integration_key | string | Your unique and secret integration key. |
| country | string | The two-letter country code for the customer country. |
| currency_code | string | Three-letter code of the payment currency. |
| amount | number | The amount in the specified currency (currency_code). |
| bin | string | 6 digit BIN Code |
Installments Plan Request Example
{
"integration_key": "{{integration_key}}",
"country": "br",
"currency_code": "BRL",
"amount": "100.00",
"bin": "411111"
}
Installments Plan Response Structure
| Parameter | Data Type | Description |
|---|---|---|
| status | string | The response status. |
| installments_plan_token | string | The installments plan token (EBANX unique identifier). |
| country | string | The two-letter country code for the customer country. |
| currency_code | string | Three-letter code of the payment currency. |
| amount | number | The amount in the specified currency (currency_code). |
| bin | string | 6 digit BIN Code |
| installments_plan | array of objects | An array containing the available installment options and their respective details. |
| total_amount | string | The amount in the specified currency (currency_code). |
| installments | number | The number of installments. |
| installment_amount | string | The amount for each installment in the specified currency (currency_code). |
| applied_fee | string | The fee applied amount in the specified currency (currency_code). |
Installments Plan Response Example
{
"status": "SUCCESS",
"installments_plan_token": "fee-6706e599dccbe4.96804402",
"country": "br",
"currency_code": "BRL",
"amount": 100.00,
"bin": "411111",
"installments_plan": [
{
"total_amount": "100.00",
"installments": 1,
"installment_amount": "100.00",
"applied_fee": "0.00"
},
{
"total_amount": "102.00",
"installments": 2,
"installment_amount": "51.00",
"applied_fee": "2.00"
},
{
"total_amount": "103.00",
"installments": 3,
"installment_amount": "34.33",
"applied_fee": "3.00"
},
{
"total_amount": "104.00",
"installments": 4,
"installment_amount": "26.00",
"applied_fee": "4.00"
},
{
"total_amount": "105.00",
"installments": 5,
"installment_amount": "21.00",
"applied_fee": "5.00"
},
{
"total_amount": "106.00",
"installments": 6,
"installment_amount": "17.67",
"applied_fee": "6.00"
},
{
"total_amount": "107.00",
"installments": 7,
"installment_amount": "15.29",
"applied_fee": "7.00"
},
{
"total_amount": "108.00",
"installments": 8,
"installment_amount": "13.50",
"applied_fee": "8.00"
},
{
"total_amount": "109.00",
"installments": 9,
"installment_amount": "12.11",
"applied_fee": "9.00"
},
{
"total_amount": "110.00",
"installments": 10,
"installment_amount": "11.00",
"applied_fee": "10.00"
},
{
"total_amount": "111.00",
"installments": 11,
"installment_amount": "10.09",
"applied_fee": "11.00"
},
{
"total_amount": "112.00",
"installments": 12,
"installment_amount": "9.33",
"applied_fee": "12.00"
}
]
}
- Send a payment request with installments
When using Direct API to place a payment request with installments, include the token for the Installments Plan in the payment.installments_plan_token() parameter.
{
"integration_key": "{{integration_key}}",
"operation": "request",
"payment": {
"name": "José Silva",
"email": "jose@example.com",
"document": "853.513.468-93",
"address": "Rua E",
"street_number": "1040",
"city": "Maracanaú",
"state": "CE",
"zipcode": "61919-230",
"country": "br",
"phone_number": "8522847035",
"payment_type_code": "creditcard",
"merchant_payment_code": "3ad1f4096a2",
"currency_code": "BRL",
"instalments": 3,
"installments_plan_token": "fee-6706e599dccbe4.96804402",
"amount_total": 100,
"creditcard": {
"card_number": "4111111111111111",
"card_name": "José Silva",
"card_due_date": "12/2019",
"card_cvv": "123"
}
}
}
Complete EBANX Direct API Reference
The complete API reference for the end-point ws/direct can be found here. We strongly recommend you to take a look in all the available options.
Getting help
We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:
- If you’re not our partner yet and would like to know more about our prices and conditions please fill our this form and our commercial team will get in touch with you.
- In case you’re already our partner please get in touch with our support team at integration@ebanx.com.