openapi-generator-original/samples/client/jetbrains/adyen/adyen/http/client

Adyen Checkout API - Jetbrains API Client

General API description

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!

• API basepath : https://checkout-test.adyen.com/v71
• Version : 71

Documentation for API Endpoints

All URIs are relative to https://checkout-test.adyen.com/v71, but will link to the .http file that contains the endpoint definition. There may be multiple requests for a single endpoint, one for each example described in the OpenAPI specification.

Class	Method	HTTP request	Description
ClassicCheckoutSDKApi	postPaymentSession	POST /paymentSession	Create a payment session
ClassicCheckoutSDKApi	postPaymentsResult	POST /payments/result	Verify a payment result
DonationsApi	postDonations	POST /donations	Start a transaction for donations
ModificationsApi	postCancels	POST /cancels	Cancel an authorised payment
ModificationsApi	postPaymentsPaymentPspReferenceAmountUpdates	POST /payments/{paymentPspReference}/amountUpdates	Update an authorised amount
ModificationsApi	postPaymentsPaymentPspReferenceCancels	POST /payments/{paymentPspReference}/cancels	Cancel an authorised payment
ModificationsApi	postPaymentsPaymentPspReferenceCaptures	POST /payments/{paymentPspReference}/captures	Capture an authorised payment
ModificationsApi	postPaymentsPaymentPspReferenceRefunds	POST /payments/{paymentPspReference}/refunds	Refund a captured payment
ModificationsApi	postPaymentsPaymentPspReferenceReversals	POST /payments/{paymentPspReference}/reversals	Refund or cancel a payment
OrdersApi	postOrders	POST /orders	Create an order
OrdersApi	postOrdersCancel	POST /orders/cancel	Cancel an order
OrdersApi	postPaymentMethodsBalance	POST /paymentMethods/balance	Get the balance of a gift card
PaymentLinksApi	getPaymentLinksLinkId	GET /paymentLinks/{linkId}	Get a payment link
PaymentLinksApi	patchPaymentLinksLinkId	PATCH /paymentLinks/{linkId}	Update the status of a payment link
PaymentLinksApi	postPaymentLinks	POST /paymentLinks	Create a payment link
PaymentsApi	getSessionsSessionId	GET /sessions/{sessionId}	Get the result of a payment session
PaymentsApi	postCardDetails	POST /cardDetails	Get the list of brands on the card
PaymentsApi	postPaymentMethods	POST /paymentMethods	Get a list of available payment methods
PaymentsApi	postPayments	POST /payments	Start a transaction
PaymentsApi	postPaymentsDetails	POST /payments/details	Submit details for a payment
PaymentsApi	postSessions	POST /sessions	Create a payment session
RecurringApi	deleteStoredPaymentMethodsStoredPaymentMethodId	DELETE /storedPaymentMethods/{storedPaymentMethodId}	Delete a token for stored payment details
RecurringApi	getStoredPaymentMethods	GET /storedPaymentMethods	Get tokens for stored payment details
UtilityApi	postApplePaySessions	POST /applePay/sessions	Get an Apple Pay session
UtilityApi	postOriginKeys	POST /originKeys	Create originKey values for domains

Usage

Prerequisites

You need IntelliJ to be able to run those queries. More information can be found here. You may have some luck running queries using the Code REST Client as well, but your mileage may vary.

Variables and Environment files

• Generally speaking, you want queries to be specific using custom variables. All variables in the .http files have the `` format.
• You can create public or private environment files to dynamically replace the variables at runtime.

Note: don't commit private environment files! They typically will contain sensitive information like API Keys.

Customizations

If you have control over the generation of the files here, there are two main things you can do

• Select elements to replace as variables during generation. The process is case-sensitive. For example, API_KEY ->
  • For this, run the generation with the bodyVariables property, followed by a "-" separated list of variables
  • Example: --additional-properties bodyVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM
• Add custom headers to all requests. This can be useful for example if your specifications are missing security schemes.
  • For this, run the generation with the customHeaders property, followed by a "&" separated list of variables
  • Example : --additional-properties=customHeaders="Cookie:X-API-KEY="&"Accept-Encoding=gzip"

This client was generated by the jetbrains-http-client generator of OpenAPI Generator