openapi: 3.1.0
info:
version: '6'
x-publicVersion: true
title: Adyen Account acceptDispute Session API
description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```"
x-timestamp: '2023-05-30T15:27:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://cal-test.adyen.com/cal/services/Account/v6
tags:
- name: Session
paths:
/paymentSession:
post:
tags:
- Session
summary: Adyen Create a Payment Session
description: 'Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.
For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).'
deprecated: true
x-deprecatedInVersion: '37'
operationId: post-paymentSession
x-sortIndex: 1
x-methodName: paymentSession
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
android:
$ref: '#/components/examples/post-paymentSession-android'
enableOneClick:
$ref: '#/components/examples/post-paymentSession-enableOneClick'
ios:
$ref: '#/components/examples/post-paymentSession-ios'
split:
$ref: '#/components/examples/post-paymentSession-split'
web:
$ref: '#/components/examples/post-paymentSession-web'
schema:
$ref: '#/components/schemas/PaymentSetupRequest'
parameters:
- $ref: '#/components/parameters/Idempotency-Key'
responses:
'200':
content:
application/json:
examples:
enableOneClick:
$ref: '#/components/examples/post-paymentSession-enableOneClick-200'
web:
$ref: '#/components/examples/post-paymentSession-web-200'
schema:
$ref: '#/components/schemas/PaymentSetupResponse'
description: OK - the request has succeeded.
headers:
Idempotency-Key:
$ref: '#/components/headers/Idempotency-Key'
'400':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-400'
schema:
$ref: '#/components/schemas/ServiceError'
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-401'
schema:
$ref: '#/components/schemas/ServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-403'
schema:
$ref: '#/components/schemas/ServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-422'
schema:
$ref: '#/components/schemas/ServiceError'
description: Unprocessable Entity - a request validation error.
headers:
Idempotency-Key:
$ref: '#/components/headers/Idempotency-Key'
'500':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-500'
schema:
$ref: '#/components/schemas/ServiceError'
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/sessions/{sessionId}:
get:
tags:
- Session
summary: Adyen Get the Result of a Payment Session
description: Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.
x-addedInVersion: '68'
operationId: get-sessions-sessionId
x-sortIndex: 2
x-methodName: getResultOfPaymentSession
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: A unique identifier of the session.
name: sessionId
in: path
required: true
schema:
type: string
- description: The `sessionResult` value from the Drop-in or Component.
name: sessionResult
in: query
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
success:
$ref: '#/components/examples/get-sessions-sessionId-success-200'
schema:
$ref: '#/components/schemas/SessionResultResponse'
description: OK - the request has succeeded.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
RecurringDetail:
properties:
brand:
x-addedInVersion: '65'
description: 'Brand for the selected gift card. For example: plastix, hmclub.'
type: string
brands:
x-addedInVersion: '49'
description: 'List of possible brands. For example: visa, mc.'
items:
type: string
type: array
configuration:
additionalProperties:
type: string
description: The configuration of the payment method.
type: object
fundingSource:
x-addedInVersion: '53'
description: The funding source of the payment method.
enum:
- credit
- debit
type: string
group:
description: The group where this payment method belongs to.
$ref: '#/components/schemas/PaymentMethodGroup'
inputDetails:
deprecated: true
description: All input details to be provided to complete the payment with this payment method.
items:
$ref: '#/components/schemas/InputDetail'
type: array
issuers:
x-addedInVersion: '68'
description: A list of issuers for this payment method.
items:
$ref: '#/components/schemas/PaymentMethodIssuer'
type: array
name:
description: The displayable name of this payment method.
type: string
recurringDetailReference:
description: The reference that uniquely identifies the recurring detail.
type: string
storedDetails:
description: Contains information on previously stored payment details.
$ref: '#/components/schemas/StoredDetails'
type:
description: The unique payment method code.
type: string
type: object
PaymentMethodGroup:
properties:
name:
description: The name of the group.
type: string
paymentMethodData:
description: Echo data to be used if the payment method is displayed as part of this group.
type: string
type:
description: The unique code of the group.
type: string
type: object
LineItem:
properties:
amountExcludingTax:
description: Item amount excluding the tax, in minor units.
format: int64
type: integer
amountIncludingTax:
description: Item amount including the tax, in minor units.
format: int64
type: integer
brand:
x-addedInVersion: '70'
description: Brand of the item.
type: string
color:
x-addedInVersion: '70'
description: Color of the item.
type: string
description:
description: Description of the line item.
type: string
id:
description: ID of the line item.
type: string
imageUrl:
description: Link to the picture of the purchased item.
type: string
itemCategory:
description: Item category, used by the payment methods PayPal and Ratepay.
type: string
manufacturer:
x-addedInVersion: '70'
description: Manufacturer of the item.
type: string
productUrl:
description: Link to the purchased item.
type: string
quantity:
description: Number of items.
format: int64
type: integer
receiverEmail:
x-addedInVersion: '70'
description: Email associated with the given product in the basket (usually in electronic gift cards).
type: string
size:
x-addedInVersion: '70'
description: Size of the item.
type: string
sku:
x-addedInVersion: '70'
description: Stock keeping unit.
type: string
taxAmount:
description: Tax amount, in minor units.
format: int64
type: integer
taxPercentage:
description: Tax percentage, in minor units.
format: int64
type: integer
upc:
x-addedInVersion: '70'
description: Universal Product Code.
type: string
type: object
ForexQuote:
properties:
account:
description: The account name.
type: string
accountType:
description: The account type.
type: string
baseAmount:
description: The base amount.
$ref: '#/components/schemas/Amount'
basePoints:
description: The base points.
format: int32
type: integer
buy:
description: The buy rate.
$ref: '#/components/schemas/Amount'
interbank:
description: The interbank amount.
$ref: '#/components/schemas/Amount'
reference:
description: The reference assigned to the forex quote request.
type: string
sell:
description: The sell rate.
$ref: '#/components/schemas/Amount'
signature:
description: The signature to validate the integrity.
type: string
source:
description: The source of the forex quote.
type: string
type:
description: The type of forex.
type: string
validTill:
description: The date until which the forex quote is valid.
format: date-time
type: string
required:
- validTill
- basePoints
type: object
Installments:
properties:
plan:
x-addedInVersion: '64'
description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values:
* **regular**
* **revolving**
'
enum:
- regular
- revolving
type: string
value:
description: 'Defines the number of installments. Its value needs to be greater than zero.
Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.'
format: int32
type: integer
required:
- value
type: object
AdditionalDataRiskStandalone:
properties:
PayPal.CountryCode:
description: Shopper's country of residence in the form of ISO standard 3166 2-character country codes.
type: string
PayPal.EmailId:
description: Shopper's email.
type: string
PayPal.FirstName:
description: Shopper's first name.
type: string
PayPal.LastName:
description: Shopper's last name.
type: string
PayPal.PayerId:
description: 'Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.'
type: string
PayPal.Phone:
description: Shopper's phone number.
type: string
PayPal.ProtectionEligibility:
description: 'Allowed values:
* **Eligible** Merchant is protected by PayPal''s Seller Protection Policy for Unauthorized Payments and Item Not Received.
* **PartiallyEligible** Merchant is protected by PayPal''s Seller Protection Policy for Item Not Received.
* **Ineligible** Merchant is not protected under the Seller Protection Policy.'
type: string
PayPal.TransactionId:
description: Unique transaction ID of the payment.
type: string
avsResultRaw:
description: 'Raw AVS result received from the acquirer, where available. Example: D'
type: string
bin:
description: The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).
type: string
cvcResultRaw:
description: 'Raw CVC result received from the acquirer, where available. Example: 1'
type: string
riskToken:
description: Unique identifier or token for the shopper's card details.
type: string
threeDAuthenticated:
description: 'A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true'
type: string
threeDOffered:
description: 'A Boolean value indicating whether 3DS was offered for this payment. Example: true'
type: string
tokenDataType:
description: 'Required for PayPal payments only. The only supported value is: **paypal**.'
type: string
type: object
PaymentSetupRequest:
properties:
additionalAmount:
description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while the amount must be still set to 0 to trigger BIN or card verification).
Required to be in the same currency as the `amount`. '
$ref: '#/components/schemas/Amount'
additionalData:
additionalProperties:
type: string
x-anyOf:
- $ref: '#/components/schemas/AdditionalData3DSecure'
- $ref: '#/components/schemas/AdditionalDataAirline'
- $ref: '#/components/schemas/AdditionalDataCarRental'
- $ref: '#/components/schemas/AdditionalDataCommon'
- $ref: '#/components/schemas/AdditionalDataLevel23'
- $ref: '#/components/schemas/AdditionalDataLodging'
- $ref: '#/components/schemas/AdditionalDataOpenInvoice'
- $ref: '#/components/schemas/AdditionalDataOpi'
- $ref: '#/components/schemas/AdditionalDataRatepay'
- $ref: '#/components/schemas/AdditionalDataRetry'
- $ref: '#/components/schemas/AdditionalDataRisk'
- $ref: '#/components/schemas/AdditionalDataRiskStandalone'
- $ref: '#/components/schemas/AdditionalDataSubMerchant'
- $ref: '#/components/schemas/AdditionalDataTemporaryServices'
- $ref: '#/components/schemas/AdditionalDataWallets'
description: 'This field contains additional data, which may be required for a particular payment request.
The `additionalData` object consists of entries, each of which includes the key and value.'
type: object
allowedPaymentMethods:
x-addedInVersion: '33'
description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"allowedPaymentMethods":["ideal","giropay"]`'
items:
type: string
type: array
amount:
description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).
$ref: '#/components/schemas/Amount'
applicationInfo:
x-addedInVersion: '40'
description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
$ref: '#/components/schemas/ApplicationInfo'
billingAddress:
x-addedInVersion: '4'
description: 'The address where to send the invoice.
> The `billingAddress` object is required in the following scenarios. Include all of the fields within this object.
>* For 3D Secure 2 transactions in all browser-based and mobile implementations.
>* For cross-border payouts to and from Canada.'
$ref: '#/components/schemas/Address'
blockedPaymentMethods:
x-addedInVersion: '33'
description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"blockedPaymentMethods":["ideal","giropay"]`'
items:
type: string
type: array
captureDelayHours:
x-addedInVersion: '2'
description: The delay between the authorisation and scheduled auto-capture, specified in hours.
format: int32
type: integer
channel:
description: 'The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`.
Possible values:
* iOS
* Android
* Web'
enum:
- iOS
- Android
- Web
type: string
checkoutAttemptId:
x-addedInVersion: '68'
description: Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
type: string
company:
x-addedInVersion: '32'
description: Information regarding the company.
$ref: '#/components/schemas/Company'
configuration:
description: Specify configurations to enable additional features.
$ref: '#/components/schemas/Configuration'
conversionId:
x-addedInVersion: '49'
deprecated: true
x-deprecatedInVersion: '68'
x-deprecatedMessage: Use `checkoutAttemptId` instead
description: Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
type: string
countryCode:
description: 'The shopper country.
Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
Example: NL or DE'
type: string
dateOfBirth:
x-addedInVersion: '7'
description: 'The shopper''s date of birth.
Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
format: date
type: string
dccQuote:
description: The forex quote as returned in the response of the forex service.
$ref: '#/components/schemas/ForexQuote'
deliveryAddress:
description: The address where the purchased goods should be delivered.
$ref: '#/components/schemas/Address'
deliveryDate:
x-addedInVersion: '8'
description: 'The date and time the purchased goods should be delivered.
Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
Example: 2017-07-17T13:42:40.428+01:00'
format: date-time
type: string
enableOneClick:
x-addedInVersion: '32'
description: When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
type: boolean
enablePayOut:
x-addedInVersion: '32'
description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
type: boolean
enableRecurring:
x-addedInVersion: '32'
description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
type: boolean
entityType:
x-addedInVersion: '24'
description: The type of the entity the payment is processed for.
enum:
- NaturalPerson
- CompanyName
type: string
fraudOffset:
description: An integer value that is added to the normal fraud score. The value can be either positive or negative.
format: int32
type: integer
installments:
x-addedInVersion: '4'
description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
$ref: '#/components/schemas/Installments'
lineItems:
x-addedInVersion: '32'
description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
> This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
items:
$ref: '#/components/schemas/LineItem'
type: array
localizedShopperStatement:
x-addedInVersion: '68'
additionalProperties:
type: string
description: "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters."
type: object
mandate:
description: The mandate details to initiate recurring transaction.
$ref: '#/components/schemas/Mandate'
mcc:
x-addedInVersion: '12'
description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
type: string
merchantAccount:
description: The merchant account identifier, with which you want to process the transaction.
type: string
merchantOrderReference:
x-addedInVersion: '9'
description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.
The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.
> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
type: string
metadata:
x-addedInVersion: '17'
additionalProperties:
type: string
description: 'Metadata consists of entries, each of which includes a key and a value.
Limits:
* Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit".
* Maximum 20 characters per key.
* Maximum 80 characters per value. '
type: object
orderReference:
description: When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.
type: string
origin:
description: 'Required for the Web integration.
Set this parameter to the origin URL of the page that you are loading the SDK from.'
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
recurringExpiry:
description: Date after which no further authorisations shall be performed. Only for 3D Secure 2.
type: string
recurringFrequency:
description: Minimum number of days between authorisations. Only for 3D Secure 2.
type: string
reference:
description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.
If you need to provide multiple references for a transaction, separate them with hyphens ("-").
Maximum length: 80 characters.'
type: string
returnUrl:
description: 'The URL to return to in case of a redirection.
The format depends on the channel. This URL can have a maximum of 1024 characters.
* For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.
Example: `https://your-company.com/checkout?shopperOrder=12xy`
* For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).
Example: `my-app://`
* For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).
Example: `my-app://your.package.name`'
maxLength: 8000
type: string
riskData:
description: Contains risk data, such as client-side data, used to identify risk for a transaction.
$ref: '#/components/schemas/RiskData'
sdkVersion:
x-addedInVersion: '32'
description: The version of the SDK you are using (for Web SDK integrations only).
type: string
sessionValidity:
description: 'The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
For example: 2020-07-18T15:42:40.428+01:00'
type: string
shopperEmail:
description: 'The shopper''s email address. We recommend that you provide this data, as it is used in velocity fraud checks.
> For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.'
type: string
shopperIP:
description: 'The shopper''s IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).
> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.
This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
type: string
shopperInteraction:
description: 'Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
For the web service API, Adyen assumes Ecommerce shopper interaction by default.
This field has the following possible values:
* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.
* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).
* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.
* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.'
enum:
- Ecommerce
- ContAuth
- Moto
- POS
type: string
shopperLocale:
x-addedInVersion: '7'
description: The combination of a language code and a country code to specify the language to be used in the payment.
type: string
shopperName:
x-addedInVersion: '7'
description: The shopper's full name.
$ref: '#/components/schemas/Name'
shopperReference:
description: "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your refere
# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-session-api-openapi.yml