sdksio.AdyenPaymentsSDK 1.0.1

Getting Started with Adyen Merged API

Introduction

Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).

This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit online payments documentation.

Authentication

Each request to Checkout API must be signed with an API key. For this, get your API key from your Customer Area, and set this key to the X-API-Key header value, for example:

curl
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
...

Versioning

Checkout API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://checkout-test.adyen.com/v71/payments

Going live

To access the live endpoints, you need an API key from your live Customer Area.

The live endpoint URLs contain a prefix which is unique to your company account, for example:

https://{PREFIX}-checkout-live.adyenpayments.com/checkout/v71/payments

Get your {PREFIX} from your live Customer Area under Developers > API URLs > Prefix.

When preparing to do live transactions with Checkout API, follow the go-live checklist to make sure you've got all the required configuration in place.

Release notes

Have a look at the release notes to find out what changed in this version!

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package sdksio.AdyenPaymentsSDK --version 1.0.1

You can also view the package at: https://www.nuget.org/packages/sdksio.AdyenPaymentsSDK/1.0.1

Test the SDK

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

AdyenMergedAPI.Standard.AdyenMergedAPIClient client = new AdyenMergedAPI.Standard.AdyenMergedAPIClient.Builder()
    .BasicAuthCredentials("BasicAuthUserName", "BasicAuthPassword")
    .XAPIKey("X-API-Key")
    .Environment(AdyenMergedAPI.Standard.Environment.Live)
    .Build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses Basic Authentication.

List of APIs

• Paymentlinks
• Classic Checkout SDK
• Instantpayouts
• Payments
• Modifications
• Recurring
• Orders
• Utility
• Initialization
• Reviewing

Classes Documentation

• Utility Classes
• HttpRequest
• HttpResponse
• HttpStringResponse
• HttpContext
• HttpClientConfiguration
• HttpClientConfiguration Builder
• IAuthManager
• ApiException