Get installment options

GET/orders/installment-options

Retrieves available installment options based on the business and the amount to be paid. This is an authenticated route.

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/orders/installment-options?amountToBePaidInCents=4990' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/orders/installment-options?amountToBePaidInCents=4990', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/orders/installment-options?amountToBePaidInCents=4990"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "options": [
      {
        "installments": 1,
        "parcelValueInCents": 4990,
        "totalInterestInCents": 0,
        "totalValueInCents": 4990
      },
      {
        "installments": 2,
        "parcelValueInCents": 2626,
        "totalInterestInCents": 262,
        "totalValueInCents": 5252
      },
      {
        "installments": 3,
        "parcelValueInCents": 1797,
        "totalInterestInCents": 401,
        "totalValueInCents": 5391
      }
    ]
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.
business-idstringrequired
Business Identifier

Query parameters

amountToBePaidInCentsintegerrequired
Total amount to be paid in cents. It must be greater than zero.

Example:4990
>= 1
itemsarray of objects
Optional cart items, sent as items[0][offerItemId]=...&items[0][valueInCents]=.... When sent, the list cannot be empty and every item needs offerItemId (a valid id) and valueInCents (greater than zero).