Create an installment plan

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/installments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subMerchantId": "mtck-md-1",
  "customerId": "2ce8fe11-e111-4d76-a59e-7914d903ec12",
  "totalAmount": 100,
  "payments": {
    "frequency": "monthly",
    "amount": 9,
    "qty": 10,
    "startDate": "2026-02-10"
  },
  "paymentToken": {
    "type": "creditcard",
    "token": {
      "provider": "jupico",
      "token": "f309450d-ef37-42f1-ac04-b04192a8d65f"
    }
  }
}
'

import requests

url = "https://sandbox-platform.jupico.com/v1/installments"

payload = {
    "subMerchantId": "mtck-md-1",
    "customerId": "2ce8fe11-e111-4d76-a59e-7914d903ec12",
    "totalAmount": 100,
    "payments": {
        "frequency": "monthly",
        "amount": 9,
        "qty": 10,
        "startDate": "2026-02-10"
    },
    "paymentToken": {
        "type": "creditcard",
        "token": {
            "provider": "jupico",
            "token": "f309450d-ef37-42f1-ac04-b04192a8d65f"
        }
    }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subMerchantId: 'mtck-md-1',
    customerId: '2ce8fe11-e111-4d76-a59e-7914d903ec12',
    totalAmount: 100,
    payments: {frequency: 'monthly', amount: 9, qty: 10, startDate: '2026-02-10'},
    paymentToken: {
      type: 'creditcard',
      token: {provider: 'jupico', token: 'f309450d-ef37-42f1-ac04-b04192a8d65f'}
    }
  })
};

fetch('https://sandbox-platform.jupico.com/v1/installments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/installments';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subMerchantId: 'mtck-md-1',
    customerId: '2ce8fe11-e111-4d76-a59e-7914d903ec12',
    totalAmount: 100,
    payments: {frequency: 'monthly', amount: 9, qty: 10, startDate: '2026-02-10'},
    paymentToken: {
      type: 'creditcard',
      token: {provider: 'jupico', token: 'f309450d-ef37-42f1-ac04-b04192a8d65f'}
    }
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Installments

Create an installment plan

Creates an installment plan that splits a total amount into scheduled payments for a customer. The initial charge depends on the deposit and start date: with no deposit and no future start date, the first payment is charged immediately; with a future start date and no deposit, only card validation is performed; with a deposit and no future start date, the deposit plus the first payment are charged immediately; with both, only the deposit is charged immediately.

POST

https://sandbox-platform.jupico.com

/

v1

/

installments

Create an installment plan

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/installments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subMerchantId": "mtck-md-1",
  "customerId": "2ce8fe11-e111-4d76-a59e-7914d903ec12",
  "totalAmount": 100,
  "payments": {
    "frequency": "monthly",
    "amount": 9,
    "qty": 10,
    "startDate": "2026-02-10"
  },
  "paymentToken": {
    "type": "creditcard",
    "token": {
      "provider": "jupico",
      "token": "f309450d-ef37-42f1-ac04-b04192a8d65f"
    }
  }
}
'

import requests

url = "https://sandbox-platform.jupico.com/v1/installments"

payload = {
    "subMerchantId": "mtck-md-1",
    "customerId": "2ce8fe11-e111-4d76-a59e-7914d903ec12",
    "totalAmount": 100,
    "payments": {
        "frequency": "monthly",
        "amount": 9,
        "qty": 10,
        "startDate": "2026-02-10"
    },
    "paymentToken": {
        "type": "creditcard",
        "token": {
            "provider": "jupico",
            "token": "f309450d-ef37-42f1-ac04-b04192a8d65f"
        }
    }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subMerchantId: 'mtck-md-1',
    customerId: '2ce8fe11-e111-4d76-a59e-7914d903ec12',
    totalAmount: 100,
    payments: {frequency: 'monthly', amount: 9, qty: 10, startDate: '2026-02-10'},
    paymentToken: {
      type: 'creditcard',
      token: {provider: 'jupico', token: 'f309450d-ef37-42f1-ac04-b04192a8d65f'}
    }
  })
};

fetch('https://sandbox-platform.jupico.com/v1/installments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/installments';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subMerchantId: 'mtck-md-1',
    customerId: '2ce8fe11-e111-4d76-a59e-7914d903ec12',
    totalAmount: 100,
    payments: {frequency: 'monthly', amount: 9, qty: 10, startDate: '2026-02-10'},
    paymentToken: {
      type: 'creditcard',
      token: {provider: 'jupico', token: 'f309450d-ef37-42f1-ac04-b04192a8d65f'}
    }
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

subMerchantId

string

required

The subMerchantId associated with the installment.

Example:

"mtck-md-1"

customerId

string

required

The ID of the customer for this installment.

Example:

"2ce8fe11-e111-4d76-a59e-7914d903ec12"

totalAmount

number

required

The total amount to be paid across all installments.

Example:

100

payments

object

required

Recurring payment schedule configuration.

Hide child attributes

payments.frequency

string

required

Billing frequency.

Example:

"monthly"

payments.amount

number

required

Amount per installment payment.

Example:

9

payments.qty

number

required

Number of installment payments.

Example:

10

payments.startDate

string

Optional first installment date in YYYY-MM-DD format. If omitted or today, first payment is charged immediately.

Example:

"2026-02-10"

paymentToken

object

required

The customer's permanent payment token.

Hide child attributes

paymentToken.type

string

Type of token supplied.

Example:

"creditcard"

paymentToken.token

object

Token payload returned by tokenization.

Hide child attributes

paymentToken.token.provider

string

Payment provider that issued the token (for example, jupico).

Example:

"jupico"

paymentToken.token.token

string

The token value.

Example:

"f309450d-ef37-42f1-ac04-b04192a8d65f"

deposit

object

Optional deposit charged at creation time.

Hide child attributes

deposit.amount

number

Deposit amount. Use 0 for no deposit.

Example:

10

Response

Installment successfully created.