---
title: "Partial payments"
description: "Let your shoppers make a purchase with multiple payment methods."
url: "https://docs.adyen.com/online-payments/partial-payments"
source_url: "https://docs.adyen.com/online-payments/partial-payments.md"
canonical: "https://docs.adyen.com/online-payments/partial-payments"
last_modified: "2022-12-13T08:48:00+01:00"
language: "en"
---

# Partial payments

Let your shoppers make a purchase with multiple payment methods.

[View source](/online-payments/partial-payments.md)

The [/orders](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders) endpoint lets you combine different payment methods when a shopper makes a payment. For example, a shopper can use a gift card with a balance lower than the amount of the purchase and pay the remaining amount with a credit card.

To accept partial payments with different payment methods, you must [create an order](#create-an-order), [make payments](#make-a-payment), and [complete the order](#complete-an-order) or [cancel the order](#cancel-order).

## Create an order

1. Make a POST [/orders](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders) request, and specify:

   | Parameter                                                                                      | Required                                                                                    | Description                                                                                                                                                                                                                                   |
   | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | [amount](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#request-amount)       | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The [currency](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#request-amount-currency) and full [value](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#request-amount-value) of the order.                  |
   | [reference](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#request-reference) | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Your unique identifier for this order.                                                                                                                                                                                                        |
   | [expiresAt](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#request-expiresAt) |                                                                                             | The automatic expiry time for the order. If not provided, the order expires 24 hours after the creation date. The `expiresAt` field is specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). For example, **2019-01-01T14:21:00**. |

   **POST /orders request**

   #### curl

   ```bash
   curl https://checkout-test.adyen.com/v69/orders \
   -H 'x-api-key: ADYEN_API_KEY' \
   -H 'content-type: application/json' \
   -d '{
     "reference": "YOUR_ORDER_REFERENCE",
     "amount": {
       "value": 2500,
       "currency": "EUR"
     },
     "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
   }'
   ```

   #### Java

   ```java
   // Adyen Java API Library v26.3.0
   import com.adyen.Client;
   import com.adyen.enums.Environment;
   import com.adyen.model.checkout.*;
   import java.time.OffsetDateTime;
   import java.util.*;
   import com.adyen.model.RequestOptions;
   import com.adyen.service.checkout.*;

   // For the live environment, additionally include your liveEndpointUrlPrefix.
   Client client = new Client("ADYEN_API_KEY", Environment.TEST);

   // Create the request object(s)
   Amount amount = new Amount()
     .currency("EUR")
     .value(2500L);

   CreateOrderRequest createOrderRequest = new CreateOrderRequest()
     .reference("YOUR_ORDER_REFERENCE")
     .amount(amount)
     .merchantAccount("YOUR_MERCHANT_ACCOUNT");

   // Send the request
   OrdersApi service = new OrdersApi(client);
   CreateOrderResponse response = service.orders(createOrderRequest, new RequestOptions().idempotencyKey("UUID"));
   ```

   #### PHP

   ```php
   // Adyen PHP API Library v18.2.1
   use Adyen\Client;
   use Adyen\Environment;
   use Adyen\Model\Checkout\Amount;
   use Adyen\Model\Checkout\CreateOrderRequest;
   use Adyen\Service\Checkout\OrdersApi;

   $client = new Client();
   $client->setXApiKey("ADYEN_API_KEY");
   // For the live environment, additionally include your liveEndpointUrlPrefix.
   $client->setEnvironment(Environment::TEST);


   // Create the request object(s)
   $amount = new Amount();
   $amount
     ->setCurrency("EUR")
     ->setValue(2500);

   $createOrderRequest = new CreateOrderRequest();
   $createOrderRequest
     ->setReference("YOUR_ORDER_REFERENCE")
     ->setAmount($amount)
     ->setMerchantAccount("YOUR_MERCHANT_ACCOUNT");

   $requestOptions['idempotencyKey'] = 'UUID';

   // Send the request
   $service = new OrdersApi($client);
   $response = $service->orders($createOrderRequest, $requestOptions);
   ```

   #### C\#

   ```cs
   // Adyen .net API Library v17.0.0
   using Adyen;
   using Environment = Adyen.Model.Environment;
   using Adyen.Model;
   using Adyen.Model.Checkout;
   using Adyen.Service.Checkout;

   // For the live environment, additionally include your liveEndpointUrlPrefix.
   var config = new Config()
   {
       XApiKey = "ADYEN_API_KEY",
       Environment = Environment.Test
   };
   var client = new Client(config);

   // Create the request object(s)
   Amount amount = new Amount
   {
     Currency = "EUR",
     Value = 2500
   };

   CreateOrderRequest createOrderRequest = new CreateOrderRequest
   {
     Reference = "YOUR_ORDER_REFERENCE",
     Amount = amount,
     MerchantAccount = "YOUR_MERCHANT_ACCOUNT"
   };

   // Send the request
   var service = new OrdersService(client);
   var response = service.Orders(createOrderRequest, requestOptions: new RequestOptions { IdempotencyKey = "UUID"});
   ```

   #### NodeJS (JavaScript)

   ```js
   // Adyen Node API Library v17.3.0
   // Require the parts of the module you want to use
   const { Client, CheckoutAPI } = require('@adyen/api-library');
   // Initialize the client object
   // For the live environment, additionally include your liveEndpointUrlPrefix.
   const client = new Client({apiKey: "ADYEN_API_KEY", environment: "TEST"});

   // Create the request object(s)
   const createOrderRequest = {
     reference: "YOUR_ORDER_REFERENCE",
     amount: {
       value: 2500,
       currency: "EUR"
     },
     merchantAccount: "YOUR_MERCHANT_ACCOUNT"
   }

   // Send the request
   const checkoutAPI = new CheckoutAPI(client);
   const response = checkoutAPI.OrdersApi.orders(createOrderRequest, { idempotencyKey: "UUID" });
   ```

   #### Go

   ```go
   // Adyen Go API Library v10.4.0
   import (
     "context"
     "github.com/adyen/adyen-go-api-library/v9/src/common"
     "github.com/adyen/adyen-go-api-library/v9/src/adyen"
     "github.com/adyen/adyen-go-api-library/v9/src/checkout"
   )
   // For the live environment, additionally include your liveEndpointUrlPrefix.
   client := adyen.NewClient(&common.Config{
     ApiKey:      "ADYEN_API_KEY",
     Environment: common.TestEnv,
   })

   // Create the request object(s)
   amount := checkout.Amount{
     Currency: "EUR",
     Value: 2500,
   }

   createOrderRequest := checkout.CreateOrderRequest{
     Reference: "YOUR_ORDER_REFERENCE",
     Amount: amount,
     MerchantAccount: "YOUR_MERCHANT_ACCOUNT",
   }

   // Send the request
   service := client.Checkout()
   req := service.OrdersApi.OrdersInput().IdempotencyKey("UUID").CreateOrderRequest(createOrderRequest)
   res, httpRes, err := service.OrdersApi.Orders(context.Background(), req)
   ```

   #### Python

   ```py
   # Adyen Python API Library v12.5.1
   import Adyen

   adyen = Adyen.Adyen()
   adyen.client.xapikey = "ADYEN_API_KEY"
   # For the live environment, additionally include your liveEndpointUrlPrefix.
   adyen.client.platform = "test" # The environment to use library in.

   # Create the request object(s)
   json_request = {
     "reference": "YOUR_ORDER_REFERENCE",
     "amount": {
       "value": 2500,
       "currency": "EUR"
     },
     "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
   }

   # Send the request
   result = adyen.checkout.orders_api.orders(request=json_request, idempotency_key="UUID")
   ```

   #### Ruby

   ```rb
   # Adyen Ruby API Library v9.5.1
   require "adyen-ruby-api-library"

   adyen = Adyen::Client.new
   adyen.api_key = 'ADYEN_API_KEY'
   # For the live environment, additionally include your liveEndpointUrlPrefix.
   adyen.env = :test # Set to "live" for live environment

   # Create the request object(s)
   request_body = {
     :reference => 'YOUR_ORDER_REFERENCE',
     :amount => {
       :value => 2500,
       :currency => 'EUR'
     },
     :merchantAccount => 'YOUR_MERCHANT_ACCOUNT'
   }

   # Send the request
   result = adyen.checkout.orders_api.orders(request_body, headers: { 'Idempotency-Key' => 'UUID' })
   ```

   #### NodeJS (TypeScript)

   ```ts
   // Adyen Node API Library v17.3.0
   // Require the parts of the module you want to use
   import { Client, CheckoutAPI, Types } from "@adyen/api-library";
   // Initialize the client object
   // For the live environment, additionally include your liveEndpointUrlPrefix.
   const client = new Client({apiKey: "ADYEN_API_KEY", environment: "TEST"});

   // Create the request object(s)
   const amount: Types.checkout.Amount = {
     currency: "EUR",
     value: 2500
   };

   const createOrderRequest: Types.checkout.CreateOrderRequest = {
     reference: "YOUR_ORDER_REFERENCE",
     amount: amount,
     merchantAccount: "YOUR_MERCHANT_ACCOUNT"
   };

   // Send the request
   const checkoutAPI = new CheckoutAPI(client);
   const response = checkoutAPI.OrdersApi.orders(createOrderRequest, { idempotencyKey: "UUID" });
   ```

2. The response contains the following fields that you need to make payments:

   * [pspReference](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#responses-200-pspReference)
   * [orderData](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#responses-200-orderData)
   * [remainingAmount](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#responses-200-remainingAmount)

   **/orders response**

   ```json
   {
     "pspReference": "MLSPNCQ8HXSKGK82",
     "amount": {
       "value": 2500,
       "currency": "EUR"
     },
     "resultCode": "Success",
     "reference": "YOUR_ORDER_REFERENCE",
     "remainingAmount": {
       "value": 2500,
       "currency": "EUR"
     },
     "expiresAt": "2022-01-01T14:21:00",
     "orderData": "823fh892f8f18f4...148f13f9f3f"
   }
   ```

   You also get an [ORDER\_OPENED](https://docs.adyen.com/api-explorer/Webhooks/latest/post/ORDER_OPENED) webhook event when the order has been created.

## Make a payment

1. Make a POST [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) request including:

   | Parameter                                                                                                          | Required                                                                                    | Description                                                                                                                                                                                                                                                                          |
   | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
   | [amount](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-amount)                         | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The payment amount. If this is less than the [remainingAmount](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#responses-200-remainingAmount) from the [/orders](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders) response, it is a partial payment. |
   | [paymentMethod](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-paymentMethod)           | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The payment method.                                                                                                                                                                                                                                                                  |
   | [order.pspReference](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-order-pspReference) | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The [pspReference](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#responses-200-pspReference) from the [/orders](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders) response.                                                                         |
   | [order.orderData](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-order-orderData)       | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The [orderData](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#responses-200-orderData) from the [/orders](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders) response.                                                                               |

   **POST /payments request**

   #### curl

   ```bash
   curl https://checkout-test.adyen.com/v72/payments \
   -H 'x-api-key: ADYEN_API_KEY' \
   -H 'content-type: application/json' \
   -d '{
      "reference": "YOUR_PAYMENT_REFERENCE",
      "amount": {
        "value": 1000,
        "currency": "EUR"
      },
      "paymentMethod": {
      "type": "giftcard",
      "brand": "givex",
      "number": "4126491073027401",
      "cvc": "737"
      },
      "order": {
        "{hint:pspReference from /orders response}pspReference{/hint}": "MLSPNCQ8HXSKGK82",
        "orderData": "823fh892f8f18f4...148f13f9f3f"
      },
      "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
   }'
   ```

   #### Java

   ```java
   // Adyen Java API Library v26.3.0
   import com.adyen.Client;
   import com.adyen.enums.Environment;
   import com.adyen.model.checkout.*;
   import java.time.OffsetDateTime;
   import java.util.*;
   import com.adyen.model.RequestOptions;
   import com.adyen.service.checkout.*;

   // For the live environment, additionally include your liveEndpointUrlPrefix.
   Client client = new Client("ADYEN_API_KEY", Environment.TEST);

   // Create the request object(s)
   Amount amount = new Amount()
     .currency("EUR")
     .value(1000L);

   CardDetails cardDetails = new CardDetails()
     .number("4126491073027401")
     .cvc("737")
     .type(CardDetails.TypeEnum.GIFTCARD)
     .brand("givex");

   EncryptedOrderData encryptedOrderData = new EncryptedOrderData()
     .orderData("823fh892f8f18f4...148f13f9f3f")
     .pspReference("MLSPNCQ8HXSKGK82");

   PaymentRequest paymentRequest = new PaymentRequest()
     .reference("YOUR_PAYMENT_REFERENCE")
     .amount(amount)
     .merchantAccount("YOUR_MERCHANT_ACCOUNT")
     .paymentMethod(new CheckoutPaymentMethod(cardDetails))
     .order(encryptedOrderData);

   // Send the request
   PaymentsApi service = new PaymentsApi(client);
   PaymentResponse response = service.payments(paymentRequest, new RequestOptions().idempotencyKey("UUID"));
   ```

   #### PHP

   ```php
   // Adyen PHP API Library v18.2.1
   use Adyen\Client;
   use Adyen\Environment;
   use Adyen\Model\Checkout\Amount;
   use Adyen\Model\Checkout\CheckoutPaymentMethod;
   use Adyen\Model\Checkout\EncryptedOrderData;
   use Adyen\Model\Checkout\PaymentRequest;
   use Adyen\Service\Checkout\PaymentsApi;

   $client = new Client();
   $client->setXApiKey("ADYEN_API_KEY");
   // For the live environment, additionally include your liveEndpointUrlPrefix.
   $client->setEnvironment(Environment::TEST);


   // Create the request object(s)
   $amount = new Amount();
   $amount
     ->setCurrency("EUR")
     ->setValue(1000);

   $checkoutPaymentMethod = new CheckoutPaymentMethod();
   $checkoutPaymentMethod
     ->setNumber("4126491073027401")
     ->setCvc("737")
     ->setType("giftcard")
     ->setBrand("givex");

   $encryptedOrderData = new EncryptedOrderData();
   $encryptedOrderData
     ->setOrderData("823fh892f8f18f4...148f13f9f3f")
     ->setPspReference("MLSPNCQ8HXSKGK82");

   $paymentRequest = new PaymentRequest();
   $paymentRequest
     ->setReference("YOUR_PAYMENT_REFERENCE")
     ->setAmount($amount)
     ->setMerchantAccount("YOUR_MERCHANT_ACCOUNT")
     ->setPaymentMethod($checkoutPaymentMethod)
     ->setOrder($encryptedOrderData);

   $requestOptions['idempotencyKey'] = 'UUID';

   // Send the request
   $service = new PaymentsApi($client);
   $response = $service->payments($paymentRequest, $requestOptions);
   ```

   #### C\#

   ```cs
   // Adyen .net API Library v17.0.0
   using Adyen;
   using Environment = Adyen.Model.Environment;
   using Adyen.Model;
   using Adyen.Model.Checkout;
   using Adyen.Service.Checkout;

   // For the live environment, additionally include your liveEndpointUrlPrefix.
   var config = new Config()
   {
       XApiKey = "ADYEN_API_KEY",
       Environment = Environment.Test
   };
   var client = new Client(config);

   // Create the request object(s)
   Amount amount = new Amount
   {
     Currency = "EUR",
     Value = 1000
   };

   CardDetails cardDetails = new CardDetails
   {
     Number = "4126491073027401",
     Cvc = "737",
     Type = CardDetails.TypeEnum.Giftcard,
     Brand = "givex"
   };

   EncryptedOrderData encryptedOrderData = new EncryptedOrderData
   {
     OrderData = "823fh892f8f18f4...148f13f9f3f",
     PspReference = "MLSPNCQ8HXSKGK82"
   };

   PaymentRequest paymentRequest = new PaymentRequest
   {
     Reference = "YOUR_PAYMENT_REFERENCE",
     Amount = amount,
     MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
     PaymentMethod = new CheckoutPaymentMethod(cardDetails),
     Order = encryptedOrderData
   };

   // Send the request
   var service = new PaymentsService(client);
   var response = service.Payments(paymentRequest, requestOptions: new RequestOptions { IdempotencyKey = "UUID"});
   ```

   #### NodeJS (JavaScript)

   ```js
   // Adyen Node API Library v17.3.0
   // Require the parts of the module you want to use
   const { Client, CheckoutAPI } = require('@adyen/api-library');
   // Initialize the client object
   // For the live environment, additionally include your liveEndpointUrlPrefix.
   const client = new Client({apiKey: "ADYEN_API_KEY", environment: "TEST"});

   // Create the request object(s)
   const paymentRequest = {
     reference: "YOUR_PAYMENT_REFERENCE",
     amount: {
       value: 1000,
       currency: "EUR"
     },
     paymentMethod: {
       type: "giftcard",
       brand: "givex",
       number: "4126491073027401",
       cvc: "737"
     },
     order: {
       pspReference: "MLSPNCQ8HXSKGK82",
       orderData: "823fh892f8f18f4...148f13f9f3f"
     },
     merchantAccount: "YOUR_MERCHANT_ACCOUNT"
   }

   // Send the request
   const checkoutAPI = new CheckoutAPI(client);
   const response = checkoutAPI.PaymentsApi.payments(paymentRequest, { idempotencyKey: "UUID" });
   ```

   #### Go

   ```go
   // Adyen Go API Library v10.4.0
   import (
     "context"
     "github.com/adyen/adyen-go-api-library/v9/src/common"
     "github.com/adyen/adyen-go-api-library/v9/src/adyen"
     "github.com/adyen/adyen-go-api-library/v9/src/checkout"
   )
   // For the live environment, additionally include your liveEndpointUrlPrefix.
   client := adyen.NewClient(&common.Config{
     ApiKey:      "ADYEN_API_KEY",
     Environment: common.TestEnv,
   })

   // Create the request object(s)
   amount := checkout.Amount{
     Currency: "EUR",
     Value: 1000,
   }

   cardDetails := checkout.CardDetails{
     Number: common.PtrString("4126491073027401"),
     Cvc: common.PtrString("737"),
     Type: common.PtrString("giftcard"),
     Brand: common.PtrString("givex"),
   }

   encryptedOrderData := checkout.EncryptedOrderData{
     OrderData: "823fh892f8f18f4...148f13f9f3f",
     PspReference: "MLSPNCQ8HXSKGK82",
   }

   paymentRequest := checkout.PaymentRequest{
     Reference: "YOUR_PAYMENT_REFERENCE",
     Amount: amount,
     MerchantAccount: "YOUR_MERCHANT_ACCOUNT",
     PaymentMethod: checkout.CardDetailsAsCheckoutPaymentMethod(&cardDetails),
     Order: &encryptedOrderData,
   }

   // Send the request
   service := client.Checkout()
   req := service.PaymentsApi.PaymentsInput().IdempotencyKey("UUID").PaymentRequest(paymentRequest)
   res, httpRes, err := service.PaymentsApi.Payments(context.Background(), req)
   ```

   #### Python

   ```py
   # Adyen Python API Library v12.5.1
   import Adyen

   adyen = Adyen.Adyen()
   adyen.client.xapikey = "ADYEN_API_KEY"
   # For the live environment, additionally include your liveEndpointUrlPrefix.
   adyen.client.platform = "test" # The environment to use library in.

   # Create the request object(s)
   json_request = {
     "reference": "YOUR_PAYMENT_REFERENCE",
     "amount": {
       "value": 1000,
       "currency": "EUR"
     },
     "paymentMethod": {
       "type": "giftcard",
       "brand": "givex",
       "number": "4126491073027401",
       "cvc": "737"
     },
     "order": {
       "pspReference": "MLSPNCQ8HXSKGK82",
       "orderData": "823fh892f8f18f4...148f13f9f3f"
     },
     "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
   }

   # Send the request
   result = adyen.checkout.payments_api.payments(request=json_request, idempotency_key="UUID")
   ```

   #### Ruby

   ```rb
   # Adyen Ruby API Library v9.5.1
   require "adyen-ruby-api-library"

   adyen = Adyen::Client.new
   adyen.api_key = 'ADYEN_API_KEY'
   # For the live environment, additionally include your liveEndpointUrlPrefix.
   adyen.env = :test # Set to "live" for live environment

   # Create the request object(s)
   request_body = {
     :reference => 'YOUR_PAYMENT_REFERENCE',
     :amount => {
       :value => 1000,
       :currency => 'EUR'
     },
     :paymentMethod => {
       :type => 'giftcard',
       :brand => 'givex',
       :number => '4126491073027401',
       :cvc => '737'
     },
     :order => {
       :pspReference => 'MLSPNCQ8HXSKGK82',
       :orderData => '823fh892f8f18f4...148f13f9f3f'
     },
     :merchantAccount => 'YOUR_MERCHANT_ACCOUNT'
   }

   # Send the request
   result = adyen.checkout.payments_api.payments(request_body, headers: { 'Idempotency-Key' => 'UUID' })
   ```

   #### NodeJS (TypeScript)

   ```ts
   // Adyen Node API Library v17.3.0
   // Require the parts of the module you want to use
   import { Client, CheckoutAPI, Types } from "@adyen/api-library";
   // Initialize the client object
   // For the live environment, additionally include your liveEndpointUrlPrefix.
   const client = new Client({apiKey: "ADYEN_API_KEY", environment: "TEST"});

   // Create the request object(s)
   const amount: Types.checkout.Amount = {
     currency: "EUR",
     value: 1000
   };

   const cardDetails: Types.checkout.CardDetails = {
     number: "4126491073027401",
     cvc: "737",
     type: Types.checkout.CardDetails.TypeEnum.Giftcard,
     brand: "givex"
   };

   const encryptedOrderData: Types.checkout.EncryptedOrderData = {
     orderData: "823fh892f8f18f4...148f13f9f3f",
     pspReference: "MLSPNCQ8HXSKGK82"
   };

   const paymentRequest: Types.checkout.PaymentRequest = {
     reference: "YOUR_PAYMENT_REFERENCE",
     amount: amount,
     merchantAccount: "YOUR_MERCHANT_ACCOUNT",
     paymentMethod: cardDetails,
     order: encryptedOrderData
   };

   // Send the request
   const checkoutAPI = new CheckoutAPI(client);
   const response = checkoutAPI.PaymentsApi.payments(paymentRequest, { idempotencyKey: "UUID" });
   ```

   In case of a redirect payment method such as [iDEAL](/payment-methods/ideal), you need to [handle the redirect](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only#handle-the-redirect)

2. The response contains an `order` object that shows the remaining amount required on the order. You also get a new `orderData` value that you must include in your next payment request.

   **/payments or /payments/details response**

   ```json
   {
     "pspReference": "Z58FGTKBRCQ2WN27",
     "resultCode": "Authorised",
     "order": {
       "pspReference": "8815517812932012",
       "reference": "YOUR_PAYMENT_REFERENCE",
       "remainingAmount": {
         "value": 1500,
         "currency": "EUR"
       },
       "expiresAt": "2022-01-01T14:21:00",
       "orderData": "111aa111a1a11a1...123a11a1a1a"
     }
   }
   ```

## Completing an order

After making enough partial payments to pay the full order amount, you get a response with the `remainingAmount.value` of **0**.

**/payments or /payments/details response with the remaining amount 0**

```json
{
  "pspReference": "ZC4R4RBFJGXXGN82",
  "resultCode": "Authorised",
  "order": {
    "pspReference": "MLSPNCQ8HXSKGK82",
    "reference": "YOUR_PAYMENT_REFERENCE",
    "remainingAmount": {
      "value": 0,
      "currency": "EUR"
    },
    "expiresAt": "2022-01-01T14:21:00"
  }
}
```

A remaining amount of **0** does not indicate that the order has been completed. The order has been completed when all payments in the order have reached a final payment status, and we send an [ORDER\_CLOSED](https://docs.adyen.com/api-explorer/Webhooks/latest/post/ORDER_CLOSED) webhook with the `success` value **true**.

## Cancel an order

We automatically cancel an order that has not been [completed](#complete-an-order) and has a remaining amount greater than **0** when it reaches the expiry time.

You can also manually cancel an incomplete order. When you manually cancel an order, all the previous payments for that order are either canceled or refunded, depending on the type of payment method.

Make a [/orders/cancel](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders/cancel) request including:

| Parameter                                                                                                               | Required                                                                                    | Description                                                                                                                                                                                                        |
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [order.pspReference](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders/cancel#request-order-pspReference) | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The [pspReference](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#responses-200-pspReference) from the [/orders](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders) response.       |
| [order.orderData](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders/cancel#request-order-orderData)       | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The [orderData](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders#responses-200-orderData) from the most recent [/orders](https://docs.adyen.com/api-explorer/Checkout/latest/post/orders) response. |

**POST /orders/cancel request**

#### curl

```bash
curl https://checkout-test.adyen.com/v69/orders/cancel \
-H 'x-api-key: ADYEN_API_KEY' \
-H 'content-type: application/json' \
-d '{
  "order": {
    "pspReference": "MLSPNCQ8HXSKGK82",
    "orderData": "823fh892f8f18f4...148f13f9f3f"
  },
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
}'
```

#### Java

```java
// Adyen Java API Library v26.3.0
import com.adyen.Client;
import com.adyen.enums.Environment;
import com.adyen.model.checkout.*;
import java.time.OffsetDateTime;
import java.util.*;
import com.adyen.model.RequestOptions;
import com.adyen.service.checkout.*;

// For the live environment, additionally include your liveEndpointUrlPrefix.
Client client = new Client("ADYEN_API_KEY", Environment.TEST);

// Create the request object(s)
EncryptedOrderData encryptedOrderData = new EncryptedOrderData()
  .orderData("823fh892f8f18f4...148f13f9f3f")
  .pspReference("MLSPNCQ8HXSKGK82");

CancelOrderRequest cancelOrderRequest = new CancelOrderRequest()
  .merchantAccount("YOUR_MERCHANT_ACCOUNT")
  .order(encryptedOrderData);

// Send the request
OrdersApi service = new OrdersApi(client);
CancelOrderResponse response = service.cancelOrder(cancelOrderRequest, new RequestOptions().idempotencyKey("UUID"));
```

#### PHP

```php
// Adyen PHP API Library v18.2.1
use Adyen\Client;
use Adyen\Environment;
use Adyen\Model\Checkout\EncryptedOrderData;
use Adyen\Model\Checkout\CancelOrderRequest;
use Adyen\Service\Checkout\OrdersApi;

$client = new Client();
$client->setXApiKey("ADYEN_API_KEY");
// For the live environment, additionally include your liveEndpointUrlPrefix.
$client->setEnvironment(Environment::TEST);


// Create the request object(s)
$encryptedOrderData = new EncryptedOrderData();
$encryptedOrderData
  ->setOrderData("823fh892f8f18f4...148f13f9f3f")
  ->setPspReference("MLSPNCQ8HXSKGK82");

$cancelOrderRequest = new CancelOrderRequest();
$cancelOrderRequest
  ->setMerchantAccount("YOUR_MERCHANT_ACCOUNT")
  ->setOrder($encryptedOrderData);

$requestOptions['idempotencyKey'] = 'UUID';

// Send the request
$service = new OrdersApi($client);
$response = $service->cancelOrder($cancelOrderRequest, $requestOptions);
```

#### C\#

```cs
// Adyen .net API Library v17.0.0
using Adyen;
using Environment = Adyen.Model.Environment;
using Adyen.Model;
using Adyen.Model.Checkout;
using Adyen.Service.Checkout;

// For the live environment, additionally include your liveEndpointUrlPrefix.
var config = new Config()
{
    XApiKey = "ADYEN_API_KEY",
    Environment = Environment.Test
};
var client = new Client(config);

// Create the request object(s)
EncryptedOrderData encryptedOrderData = new EncryptedOrderData
{
  OrderData = "823fh892f8f18f4...148f13f9f3f",
  PspReference = "MLSPNCQ8HXSKGK82"
};

CancelOrderRequest cancelOrderRequest = new CancelOrderRequest
{
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  Order = encryptedOrderData
};

// Send the request
var service = new OrdersService(client);
var response = service.CancelOrder(cancelOrderRequest, requestOptions: new RequestOptions { IdempotencyKey = "UUID"});
```

#### NodeJS (JavaScript)

```js
// Adyen Node API Library v17.3.0
// Require the parts of the module you want to use
const { Client, CheckoutAPI } = require('@adyen/api-library');
// Initialize the client object
// For the live environment, additionally include your liveEndpointUrlPrefix.
const client = new Client({apiKey: "ADYEN_API_KEY", environment: "TEST"});

// Create the request object(s)
const cancelOrderRequest = {
  order: {
    pspReference: "MLSPNCQ8HXSKGK82",
    orderData: "823fh892f8f18f4...148f13f9f3f"
  },
  merchantAccount: "YOUR_MERCHANT_ACCOUNT"
}

// Send the request
const checkoutAPI = new CheckoutAPI(client);
const response = checkoutAPI.OrdersApi.cancelOrder(cancelOrderRequest, { idempotencyKey: "UUID" });
```

#### Go

```go
// Adyen Go API Library v10.4.0
import (
  "context"
  "github.com/adyen/adyen-go-api-library/v9/src/common"
  "github.com/adyen/adyen-go-api-library/v9/src/adyen"
  "github.com/adyen/adyen-go-api-library/v9/src/checkout"
)
// For the live environment, additionally include your liveEndpointUrlPrefix.
client := adyen.NewClient(&common.Config{
  ApiKey:      "ADYEN_API_KEY",
  Environment: common.TestEnv,
})

// Create the request object(s)
encryptedOrderData := checkout.EncryptedOrderData{
  OrderData: "823fh892f8f18f4...148f13f9f3f",
  PspReference: "MLSPNCQ8HXSKGK82",
}

cancelOrderRequest := checkout.CancelOrderRequest{
  MerchantAccount: "YOUR_MERCHANT_ACCOUNT",
  Order: encryptedOrderData,
}

// Send the request
service := client.Checkout()
req := service.OrdersApi.CancelOrderInput().IdempotencyKey("UUID").CancelOrderRequest(cancelOrderRequest)
res, httpRes, err := service.OrdersApi.CancelOrder(context.Background(), req)
```

#### Python

```py
# Adyen Python API Library v12.5.1
import Adyen

adyen = Adyen.Adyen()
adyen.client.xapikey = "ADYEN_API_KEY"
# For the live environment, additionally include your liveEndpointUrlPrefix.
adyen.client.platform = "test" # The environment to use library in.

# Create the request object(s)
json_request = {
  "order": {
    "pspReference": "MLSPNCQ8HXSKGK82",
    "orderData": "823fh892f8f18f4...148f13f9f3f"
  },
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
}

# Send the request
result = adyen.checkout.orders_api.cancel_order(request=json_request, idempotency_key="UUID")
```

#### Ruby

```rb
# Adyen Ruby API Library v9.5.1
require "adyen-ruby-api-library"

adyen = Adyen::Client.new
adyen.api_key = 'ADYEN_API_KEY'
# For the live environment, additionally include your liveEndpointUrlPrefix.
adyen.env = :test # Set to "live" for live environment

# Create the request object(s)
request_body = {
  :order => {
    :pspReference => 'MLSPNCQ8HXSKGK82',
    :orderData => '823fh892f8f18f4...148f13f9f3f'
  },
  :merchantAccount => 'YOUR_MERCHANT_ACCOUNT'
}

# Send the request
result = adyen.checkout.orders_api.cancel_order(request_body, headers: { 'Idempotency-Key' => 'UUID' })
```

#### NodeJS (TypeScript)

```ts
// Adyen Node API Library v17.3.0
// Require the parts of the module you want to use
import { Client, CheckoutAPI, Types } from "@adyen/api-library";
// Initialize the client object
// For the live environment, additionally include your liveEndpointUrlPrefix.
const client = new Client({apiKey: "ADYEN_API_KEY", environment: "TEST"});

// Create the request object(s)
const encryptedOrderData: Types.checkout.EncryptedOrderData = {
  orderData: "823fh892f8f18f4...148f13f9f3f",
  pspReference: "MLSPNCQ8HXSKGK82"
};

const cancelOrderRequest: Types.checkout.CancelOrderRequest = {
  merchantAccount: "YOUR_MERCHANT_ACCOUNT",
  order: encryptedOrderData
};

// Send the request
const checkoutAPI = new CheckoutAPI(client);
const response = checkoutAPI.OrdersApi.cancelOrder(cancelOrderRequest, { idempotencyKey: "UUID" });
```

**/orders/cancel response**

```json
{
  "pspReference": "FKSPNCQ8HXSKGK82",
  "resultCode": "Received"
}
```

When an order has been canceled, we send an [ORDER\_CLOSED](https://docs.adyen.com/api-explorer/Webhooks/latest/post/ORDER_CLOSED) webhook event with the `success` value **false**.

### Cancel a completed order

If you want to cancel an order that has the remaining amount of **0**, how you can cancel the order depends on the situation:

* If you need to manage payment balances separately, such as a partial refund, modify the partial payments individually. You can either:

  * make a [/cancels](https://docs.adyen.com/api-explorer/Checkout/latest/post/cancels) request to [cancel payments](/online-payments/cancel) for the partial payment.
  * make a [/payments/{paymentPspReference}/refunds](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments/\(paymentPspReference\)/refunds) request to [refund payments](/online-payments/refund) for the partial payment.

* If you need to cancel the order entirely, make a [/payments/{paymentPspReference}/reversals](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments/\(paymentPspReference\)/reversals) request. [The reversal request](/online-payments/reversal) dynamically cancels or refunds the full order amount, depending on the current payment state.

## See also

* [Gift cards](/payment-methods/gift-cards)
* [Understand webhooks](/development-resources/webhooks/webhook-types)