---
title: "Scalapay for API only"
description: "Add Scalapay to an existing API-only integration."
url: "https://docs.adyen.com/payment-methods/scalapay/api-only"
source_url: "https://docs.adyen.com/payment-methods/scalapay/api-only.md"
canonical: "https://docs.adyen.com/payment-methods/scalapay/api-only"
last_modified: "2019-09-06T17:19:00+02:00"
language: "en"
---

# Scalapay for API only

Add Scalapay to an existing API-only integration.

[View source](/payment-methods/scalapay/api-only.md)

Accept Scalapay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

## Requirements

| Requirement          | Description                                                                                                                                          |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Integration type** | Make sure that you have built an [API-only integration](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=API%20only). |
| **Setup steps**      | Before you begin, [add Scalapay in your test Customer Area](/payment-methods/add-payment-methods).                                                   |

Activating Scalapay defaults the pricing to our standard pricing. Adyen offers Enterprise pricing for merchants with sufficient volume. Before activating Scalapay, contact your account manager to verify if you are eligible.

## Build your payment form for Scalapay

Include Scalapay in the list of available payment methods.

In your [/paymentMethods](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods) request, specify:

* [countryCode](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods): **IT**, **FR**, **PT** or **ES**
* [amount.currency](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods#request-amount): **EUR**

## Make a payment

In your [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) request, specify:

| Parameter name                                                                                                                                             | Required                                                                                    | Description                                                                                                                                                                                                                                         |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `paymentMethod.type`                                                                                                                                       | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | **scalapay\_3x**                                                                                                                                                                                                                                    |
| [countryCode](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-countryCode)                                                       | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The shopper's two-letter country code: **IT**, **FR**, **PT** or **ES**.                                                                                                                                                                            |
| [returnUrl](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-returnUrl)                                                           | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The URL the shopper is redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.                                                                                                                          |
| [shopperEmail](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperEmail)                                                     | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The shopper's email address.                                                                                                                                                                                                                        |
| [shopperName](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperName)                                                       | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The shopper's name.                                                                                                                                                                                                                                 |
| [billingAddress](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-billingAddress)                                                 |                                                                                             | The shopper's billing address.                                                                                                                                                                                                                      |
| [deliveryAddress](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-deliveryAddress)                                               |                                                                                             | The delivery address for the goods purchased.                                                                                                                                                                                                       |
| [lineItems](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-lineItems)                                                           |                                                                                             | Price and product information about the purchased items.                                                                                                                                                                                            |
| [airline.flight\_date](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-additionalData-AdditionalDataAirline-airline-flight_date) |                                                                                             | Optional for flights: provide the outbound flight date and time. Format: `YYYY-MM-DD hh:mm`. For example **2025-03-11 22:14**. Provide either `additionalData.airline.flight_date` or `additionalData.lodging.checkInDate` in the same transaction. |
| [lodging.checkInDate](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-additionalData-AdditionalDataLodging-lodging-checkInDate)  |                                                                                             | Optional for lodging: provide the check in date for lodging Format: `YYYYMMDD`. For example **20251101**. Provide either `additionalData.airline.flight_date` or `additionalData.lodging.checkInDate` in the same transaction.                      |

**Sample /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 '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "countryCode":"IT",
  "paymentMethod": {
    "type":"scalapay_3x"
  },
  "amount":{
    "currency":"EUR",
    "value":1000
  },
  "shopperName": {
     "firstName":"Simone",
     "lastName":"Hopper"
  },
  "returnUrl":"https://your-company.example.com/checkout?shopperOrder=12xy.."
}'
```

#### Java

```java
// Adyen Java API Library v28.2.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);

Name name = new Name()
  .firstName("Simone")
  .lastName("Hopper");

PaymentDetails paymentDetails = new PaymentDetails()
  .type(PaymentDetails.TypeEnum.SCALAPAY_3X);

PaymentRequest paymentRequest = new PaymentRequest()
  .reference("YOUR_ORDER_NUMBER")
    .countryCode("IT")
  .amount(amount)
  .shopperName(name)
  .merchantAccount("YOUR_MERCHANT_ACCOUNT")
  .paymentMethod(new CheckoutPaymentMethod(paymentDetails))
  .returnUrl("https://your-company.example.com/checkout?shopperOrder=12xy..");

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

#### PHP

```php
// Adyen PHP API Library v20.1.0
use Adyen\Client;
use Adyen\Environment;
use Adyen\Model\Checkout\Amount;
use Adyen\Model\Checkout\Name;
use Adyen\Model\Checkout\CheckoutPaymentMethod;
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);

$name = new Name();
$name
  ->setFirstName("Simone")
  ->setLastName("Hopper");

$checkoutPaymentMethod = new CheckoutPaymentMethod();
$checkoutPaymentMethod
  ->setType("scalapay_3x");

$paymentRequest = new PaymentRequest();
$paymentRequest
  ->setReference("YOUR_ORDER_NUMBER")
  ->setCountryCode("IT")
  ->setAmount($amount)
  ->setShopperName($name)
  ->setMerchantAccount("YOUR_MERCHANT_ACCOUNT")
  ->setPaymentMethod($checkoutPaymentMethod)
  ->setReturnUrl("https://your-company.example.com/checkout?shopperOrder=12xy..");

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

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

#### C\#

```cs
// Adyen .net API Library v19.1.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
};

Name name = new Name
{
  FirstName = "Simone",
  LastName = "Hopper"
};

PaymentDetails paymentDetails = new PaymentDetails
{
  Type = PaymentDetails.TypeEnum.Scalapay3x
};

PaymentRequest paymentRequest = new PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  countryCode = "IT",
  Amount = amount,
  ShopperName = name,
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = new CheckoutPaymentMethod(paymentDetails),
  ReturnUrl = "https://your-company.example.com/checkout?shopperOrder=12xy.."
};

// 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 v19.2.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 = {
  merchantAccount: "YOUR_MERCHANT_ACCOUNT",
  reference: "YOUR_ORDER_NUMBER",
  countryCode: "IT",
  paymentMethod: {
    type: "scalapay_3x"
  },
  amount: {
    currency: "EUR",
    value: 1000
  },
  shopperName: {
    firstName: "Simone",
    lastName: "Hopper"
  },
  returnUrl: "https://your-company.example.com/checkout?shopperOrder=12xy.."
}

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

#### Go

```go
// Adyen Go API Library v12.1.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,
}

name := checkout.Name{
  FirstName: "Simone",
  LastName: "Hopper",
}

paymentDetails := checkout.PaymentDetails{
  Type: common.PtrString("scalapay_3x"),
}

paymentRequest := checkout.PaymentRequest{
  countryCode: "IT",
  Reference: "YOUR_ORDER_NUMBER",
  Amount: amount,
  ShopperName: &name,
  MerchantAccount: "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod: checkout.PaymentDetailsAsCheckoutPaymentMethod(&paymentDetails),
  ReturnUrl: "https://your-company.example.com/checkout?shopperOrder=12xy..",
}

// 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.7.0
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 = {
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "reference": "YOUR_ORDER_NUMBER",
  "countryCode": "IT",
  "paymentMethod": {
    "type": "scalapay_3x"
  },
  "amount": {
    "currency": "EUR",
    "value": 1000
  },
  "shopperName": {
    "firstName": "Simone",
    "lastName": "Hopper"
  },
  "returnUrl": "https://your-company.example.com/checkout?shopperOrder=12xy.."
}

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

#### Ruby

```rb
# Adyen Ruby API Library v9.7.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 = {
  :merchantAccount => 'YOUR_MERCHANT_ACCOUNT',
  :reference => 'YOUR_ORDER_NUMBER',
  :countryCode => 'IT',
  :paymentMethod => {
    :type => 'scalapay_3x'
  },
  :amount => {
    :currency => 'EUR',
    :value => 1000
  },
  :shopperName => {
    :firstName => 'Simone',
    :lastName => 'Hopper'
  },
  :returnUrl => 'https://your-company.example.com/checkout?shopperOrder=12xy..'
}

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

#### NodeJS (TypeScript)

```ts
// Adyen Node API Library v19.2.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 name: Types.checkout.Name = {
  firstName: "Simone",
  lastName: "Hopper"
};

const paymentDetails: Types.checkout.PaymentDetails = {
  type: Types.checkout.PaymentDetails.TypeEnum.Scalapay3x
};

const paymentRequest: Types.checkout.PaymentRequest = {
  reference: "YOUR_ORDER_NUMBER",
  countryCode: "IT",
  amount: amount,
  shopperName: name,
  merchantAccount: "YOUR_MERCHANT_ACCOUNT",
  paymentMethod: paymentDetails,
  returnUrl: "https://your-company.example.com/checkout?shopperOrder=12xy.."
};

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

In the [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) response, check the `action` object for the information that you must use to redirect the shopper.

**/payments response**

```json
{
  "resultCode":"RedirectShopper",
  "action":{
    "paymentMethodType":"scalapay_3x",
    "method":"GET",
    "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
    "type":"redirect"
  }
}
```

## Handle the redirect

1. To complete the payment, redirect the shopper to the `action.url` returned in the [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) response, taking into account the following recommendations:

   * **When using the HTTP GET method:**\
     For security reasons, when showing the redirect in the app, we recommend that you use [SFSafariViewController](https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller) for iOS or [Chrome Custom Tabs](https://developer.chrome.com/multidevice/android/customtabs) for Android, instead of WebView objects. Also refer to the [security best practices](https://developer.android.com/topic/security/best-practices#webview) for WebView.

   * **Redirection for mobile integrations:**\
     For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.

2. After the shopper is redirected back to your website, check the payment result by making a POST [/payments/details](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments/details) request, specifying:

   * `details`: object that contains the URL-decoded `redirectResult` returned when the shopper was redirected back to your site.

   **/payments/details request**

   ```bash
   curl https://checkout-test.adyen.com/v72/payments/details \
   -H 'x-api-key: ADYEN_API_KEY' \
   -H 'content-type: application/json' \
   -d '{
      "details": {
         "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
      }
   }'
   ```

3. In the response note the following:

   * `resultCode`: use this to present the result to your shopper.
   * `pspReference`: our unique identifier for the transaction.

   **/payments/details response**

   ```json
   {
      "resultCode": "Authorised",
      "pspReference": "V4HZ4RBFJGXXGN82"
   }
   ```

   If the payment was authorized, the payment method type that you specified in the [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) request will be appended with the country code in the [/payments/details](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments/details) response. For example `scalapay_3x_IT`.

   **/payments/details response including payment method type**

   ```json
   {
       "resultCode": "Authorised",
       "pspReference": "V4HZ4RBFJGXXGN82",
       "paymentMethod": {
           "type": "scalapay_3x_IT"
       }
   }
   ```

## Show the payment result

Use the [resultCode](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments/details#responses-200-resultCode) that you received in the [/payments/details](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments/details) response to show your shopper the payment result.

The `resultCode` values you can receive for Scalapay are:

| resultCode                  | Description                                                                  | Action to take                                                                                                                                                                                                                         |
| --------------------------- | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Authorised**              | The payment was successful.                                                  | Inform the shopper that the payment has been successful. Ship the goods after you successfully [capture](#capture) the payment.                                                                                                        |
| **Cancelled**               | The shopper cancelled the payment while on their bank's website.             | Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.                                                                                                                        |
| **Error**                   | There was an error when the payment was being processed.                     | Inform the shopper that there was an error processing their payment. You'll receive a `refusalReason` in the same response, indicating the cause of the error.                                                                         |
| **Pending** or **Received** | The shopper has completed the payment but the final result is not yet known. | Inform the shopper that you have received their order, and are waiting for the payment to be completed. You will receive the final result of the payment in an [AUTHORISATION webhook](/development-resources/webhooks/webhook-types). |
| **Refused**                 | The payment was refused by the shopper's bank.                               | Ask the shopper to try the payment again using a different payment method.                                                                                                                                                             |

[]()If the shopper fails to return to your website or app, wait for webhooks to know the outcome of the payment:

| eventCode         | success field | Description                                     | Action to take                                                                |
| ----------------- | ------------- | ----------------------------------------------- | ----------------------------------------------------------------------------- |
| **AUTHORISATION** | **false**     | The transaction failed.                         | Cancel the order and inform the shopper that the payment failed.              |
| **AUTHORISATION** | **true**      | The shopper successfully completed the payment. | Inform the shopper that the payment is successful and proceed with the order. |

## Capture the payment

Depending on your [capture](/online-payments/capture) settings, Scalapay payments are captured manually or automatically, with or without a delay.

If you use [manual capture](/online-payments/capture/#manual-capture), or [delayed automatic capture](/online-payments/capture/#delayed-automatic-capture), make sure to capture authorized Scalapay transactions within **7 days**. After this timeframe, the authorization expires.

Before you ship the goods, make sure that the payment is captured successfully.

If you do not intend to capture the payment, [make a request to cancel the payment](/online-payments/cancel/#cancel-api) and release the authorized balance amount. This returns the receivable credit back to the shopper.

## Multiple partial captures

You can multiple partial captures for Scalapay payments.

To enable multiple partial captures, contact our [Support Team](https://ca-test.adyen.com/ca/ca/contactUs/support.shtml?form=other) and ask to enable it on your account.

After your account is enabled for multiple partial captures, you can perform [multiple partial captures](/online-payments/capture), providing any amount up to the authorized amount.

If you have authorized balance amount left that you do not intend to capture, you must [make a request to cancel the payment](/online-payments/cancel/#cancel-api) and release the remaining authorized balance amount. If you do not cancel the payment, this transaction will not settle until the remaining authorized balance amount is released by Scalapay, which can take up to 7 days.

If multiple partial captures are enabled, Scalapay refunds require the `capturePspReference`. To avoid failed requests, make sure to confirm that your integration can send this reference when issuing refunds.

## Test and go live

Use the test cards for the test scenarios that are specified on the [Scalapay website](https://developers.scalapay.com/docs/test-the-order-flow).

Check the status of Scalapay test payments in your [Customer Area](https://ca-test.adyen.com/) > **Transactions** > **Payments**.

Before you can accept live Scalapay payments, [submit a request for Scalapay](/payment-methods/add-payment-methods) in your [live Customer Area](https://ca-live.adyen.com/).

## See also

* [API-only integration guide](/online-payments/api-only)
* [Webhooks](/development-resources/webhooks)
* [Tokenization for recurring payments](/online-payments/tokenization)
* [API Explorer](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/overview)
