# Installments

{% hint style="success" %}
Please check-in with your Sales contact for the corresponding configuration and eligibility of this functionality.
{% endhint %}

<details>

<summary>Server2Server</summary>

To create a deposit with installments through our Server2Server solution, the parameter **`installments`** should be sent in the request with a valid amount of installments.

The deposit will be synchronously processed, and charged with installments to the cardholder with the amount detailed in the **`installments`** parameter.

<pre class="language-javascript" data-title="Example request"><code class="lang-javascript">curl -L \
  --request POST \
  --url 'https://cc-api-stg.onekeypayments.com/v3/deposits' \
  --header 'Content-Type: application/json' \
  --header 'X-Date: 2025-07-15T12:57:14.936Z' \
  --header 'X-Login: text' \
  --header 'Authorization: text' \
  --data '{
    "invoice_id": "800000001",
    "amount": 1000,
    "country": "BR",
    "currency": "BRL",
<strong>    "installments":3,
</strong>    "payer": {
      "id": "11111",
      "document": "84932568207",
      "document_type": "CPF",
      "email": "johnSmith12@hotmail.com",
      "first_name": "John",
      "last_name": "Smith",
    },
    "credit_card": {
      "cvv": "123",
      "card_number": "4111111111111111",
      "expiration_month": "10",
      "expiration_year": "25",
      "holder_name": "JOHN SMITH"
    }

  }'
</code></pre>

</details>

<details>

<summary>Fragments Lite</summary>

Fragments Lite is similar to our Server2Server solution in regards of charging deposits with Installments.\
Remember, that in this solution you should send the **`card_token`** instead of the `credit_card[]` object alongside with **`installments`** parameter.

<pre class="language-shellscript" data-title="Example request"><code class="lang-shellscript">curl -L \
  --request POST \
  --url 'https://cc-api-stg.onekeypayments.com/v3/deposits' \
  --header 'Content-Type: application/json' \
  --header 'X-Date: 2025-07-15T12:57:14.936Z' \
  --header 'X-Login: text' \
  --header 'Authorization: text' \
  --data '{
    "invoice_id": "800000001",
    "amount": 1000,
    "country": "BR",
    "currency": "BRL",
<strong>    "installments":3,
</strong>    "payer": {
      "id": "11111",
      "document": "84932568207",
      "document_type": "CPF",
      "email": "johnSmith12@hotmail.com",
      "first_name": "John",
      "last_name": "Smith",
    },
<strong>   "card_token": "C4RD_T0K3N_G3N3R4T3D_W1TH_FR4GM3N7S_L1T3"
</strong>
  }'
</code></pre>

</details>

<details>

<summary>Fragments all-in-one</summary>

Merchants using the Fragments all-in-one solution can offer payments in installments to their users.

For doing so, they must include in the deposit request the parameter **`allow_installments`** with value **`true`**. The frontend component will render the dropdown for the user to select the desired amount.

<pre class="language-shellscript"><code class="lang-shellscript">curl -L \
  --request POST \
  --url 'https://api-stg.onekeypayments.com/v3/deposits' \
  --header 'Content-Type: application/json' \
  --header 'X-Date: 2025-07-17T13:13:15.442Z' \
  --header 'X-Login: text' \
  --header 'Authorization: text' \
  --data '{
    "invoice_id" : "1000000001",
    "amount": "1000",
    "country": "MX",
    "currency": "MXN",
    "payer": {
        "id": "11",
        "document": "CURP4321TEST",
        "first_name": "Ricardo",
        "last_name": "Carlos",
        "email": "juanCarlos@hotmail.com"
    },
<strong>    "payment_method": "CC",
</strong><strong>    "token_requested":true,
</strong><strong>    "allow_installments":true,
</strong>    "client_ip": "123.123.123.123",
    "back_url": "https://www.merchant.com/deposit_cancelled",
    "success_url": "https://www.merchant.com/deposit_completed",
    "error_url": "https://www.merchant.com/deposit_error",
    "notification_url": "https://www.merchant.com/onekeypayments/notify"
}'
</code></pre>

</details>

<details>

<summary>OneShot</summary>

In the OneShot integration, users select the desired amount of installments in the credit card checkout page.

In order to display the installments dropdown to the user, merchants must indicate in the deposit request that installments are allowed, with the parameter **`allow_installments`** with value **`true`**&#x20;

<pre class="language-shellscript"><code class="lang-shellscript">curl -L \
  --request POST \
  --url 'https://api-stg.onekeypayments.com/v3/deposits' \
  --header 'Content-Type: application/json' \
  --header 'X-Date: 2025-07-17T13:13:15.442Z' \
  --header 'X-Login: text' \
  --header 'Authorization: text' \
  --data '{
    "invoice_id" : "1000000001",
    "amount": "1000",
    "country": "MX",
    "currency": "MXN",
    "payer": {
        "id": "11",
        "document": "CURP4321TEST",
        "first_name": "Ricardo",
        "last_name": "Carlos",
        "email": "juanCarlos@hotmail.com"
    },
    "payment_method": "CC",
<strong>    "allow_installments": true,
</strong>    "client_ip": "123.123.123.123",
    "back_url": "https://www.merchant.com/deposit_cancelled",
    "success_url": "https://www.merchant.com/deposit_completed",
    "error_url": "https://www.merchant.com/deposit_error",
    "notification_url": "https://www.merchant.com/onekeypayments/notify"
    "logo": "https://www.merchant.com/merchant-logo.png",
}'
</code></pre>

#### Experience

| Regular card                                                                                                                                                                                                                                                     | Multiplo card                                                                                                                                                                                                                                                    |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![](https://2745084985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNmmYRmGEpduaZ8YTyKQQ%2Fuploads%2FtOhfxG9GtYTNjAaiFBCw%2FScreenshot%202025-11-25%20at%2012.09.28%E2%80%AFPM.png?alt=media\&token=7ebfaa80-fa56-4c21-b037-63de84f145f8) | ![](https://2745084985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNmmYRmGEpduaZ8YTyKQQ%2Fuploads%2FBiwXx6ai3YBa1KTi8Rtn%2FScreenshot%202025-11-25%20at%2012.06.00%E2%80%AFPM.png?alt=media\&token=063a6ae6-aa56-462a-ad4f-e87eb32e09f8) |

</details>
