No momento, esta página não está disponível em português
Payment-method icon

Scalapay for API only

Add Scalapay to an existing API-only integration.

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 an existing API-only integration.
Setup steps Before you begin, add Scalapay in your test Customer Area.

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 request, specify:

Make a payment

In your /payments request, specify:

Parameter name Required Description
paymentMethod.type -white_check_mark- scalapay_3x
countryCode -white_check_mark- The shopper's two-letter country code: IT.
returnUrl -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 -white_check_mark- The shopper's email address.
shopperName -white_check_mark- The shopper's name.
billingAddress The shopper's billing address.
deliveryAddress The delivery address for the goods purchased.
lineItems Price and product information about the purchased items.

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /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 for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices 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 request, specifying:

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

  3. In the response note the following:

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

    If the payment was authorized, the payment method type that you specified in the /payments request will be appended with the country code in the /payments/details response. For example scalapay_3x_IT.

Show the payment result

Use the resultCode that you received in the /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 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.
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 settings, Scalapay payments are captured manually or automatically, with or without a delay.

If you use manual capture, or delayed automatic capture, make sure to capture authorized Scalapay transactions within 24 hours. After this timeframe, the authorization expires.

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

Test and go live

Use the test cards for the test scenarios that are specified on the Scalapay website.

Check the status of Scalapay test payments in your Customer Area > Transactions > Payments.

Before you can accept live Scalapay payments, submit a request for Scalapay in your live Customer Area.

See also