sdksio.AdyenPaymentsSDK 1.0.0

Getting Started with Adyen Merged API

Introduction

A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.

To learn more about the API, visit Classic integration.

Authentication

You need an API credential to authenticate to the API.

If using an API key, add an X-API-Key header with the API key as the value, for example:

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

Alternatively, you can use the username and password to connect to the API using basic authentication, for example:

curl
-U "ws@Company.YOUR_COMPANY_ACCOUNT":"YOUR_BASIC_AUTHENTICATION_PASSWORD" \
-H "Content-Type: application/json" \
...

Versioning

Payments 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://pal-test.adyen.com/pal/servlet/Payment/v68/authorise

Going live

To authenticate to the live endpoints, you need an API credential from your live Customer Area.

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

https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise

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

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.0

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

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.Production)
    .Build();

Authorization

This API uses Basic Authentication.

List of APIs

• Instantpayouts
• Payments
• Modifications
• Initialization
• Reviewing

Classes Documentation

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