openapi: 3.1.0
info:
version: '6'
x-publicVersion: true
title: Adyen Account acceptDispute Methods 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: Methods
paths:
/deletePayoutMethods:
post:
tags:
- Methods
summary: Adyen Delete Payout Methods
description: Deletes payout methods associated with an account holder.
x-addedInVersion: '5'
operationId: post-deletePayoutMethods
x-groupName: Verification
x-sortIndex: 5
x-methodName: deletePayoutMethods
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: '#/components/examples/post-deletePayoutMethods-basic'
schema:
$ref: '#/components/schemas/DeletePayoutMethodRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
examples:
post-deletePayoutMethods200Example:
summary: Default post-deletePayoutMethods 200 response
x-microcks-default: true
value:
invalidFields:
- example_value
pspReference: REF-001
resultCode: CODE123
description: OK - the request has succeeded.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
examples:
post-deletePayoutMethods202Example:
summary: Default post-deletePayoutMethods 202 response
x-microcks-default: true
value:
invalidFields:
- example_value
pspReference: REF-001
resultCode: CODE123
description: Accepted - the request has been accepted for processing, but the processing has not been completed.
'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:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-deletePayoutMethods401Example:
summary: Default post-deletePayoutMethods 401 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
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:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-deletePayoutMethods422Example:
summary: Default post-deletePayoutMethods 422 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-deletePayoutMethods500Example:
summary: Default post-deletePayoutMethods 500 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/paymentMethods:
post:
tags:
- Methods
summary: Adyen Get a List of Available Payment Methods
description: 'Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).
Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.'
operationId: post-paymentMethods
x-sortIndex: 2
x-methodName: paymentMethods
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: '#/components/examples/post-paymentMethods-basic'
filtered:
$ref: '#/components/examples/post-paymentMethods-filtered'
include-stored:
$ref: '#/components/examples/post-paymentMethods-include-stored'
schema:
$ref: '#/components/schemas/PaymentMethodsRequest'
parameters:
- $ref: '#/components/parameters/Idempotency-Key'
responses:
'200':
content:
application/json:
examples:
basic:
$ref: '#/components/examples/post-paymentMethods-basic-200'
filtered:
$ref: '#/components/examples/post-paymentMethods-filtered-200'
include-stored:
$ref: '#/components/examples/post-paymentMethods-include-stored-200'
schema:
$ref: '#/components/schemas/PaymentMethodsResponse'
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_2'
schema:
$ref: '#/components/schemas/ServiceError_2'
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_2'
description: Unauthorized - authentication required.
'403':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-403_2'
schema:
$ref: '#/components/schemas/ServiceError_2'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-422'
schema:
$ref: '#/components/schemas/ServiceError_2'
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_2'
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/paymentMethods/balance:
post:
tags:
- Methods
summary: Adyen Get the Balance of a Gift Card
description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.
operationId: post-paymentMethods-balance
x-sortIndex: 1
x-methodName: getBalanceOfGiftCard
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: '#/components/examples/post-paymentMethods-balance-basic'
not-enough:
$ref: '#/components/examples/post-paymentMethods-balance-not-enough'
schema:
$ref: '#/components/schemas/BalanceCheckRequest'
parameters:
- $ref: '#/components/parameters/Idempotency-Key'
responses:
'200':
content:
application/json:
examples:
basic:
$ref: '#/components/examples/post-paymentMethods-balance-basic-200'
not-enough:
$ref: '#/components/examples/post-paymentMethods-balance-not-enough-200'
schema:
$ref: '#/components/schemas/BalanceCheckResponse'
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_2'
schema:
$ref: '#/components/schemas/ServiceError_2'
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_2'
description: Unauthorized - authentication required.
'403':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-403_2'
schema:
$ref: '#/components/schemas/ServiceError_2'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-422'
schema:
$ref: '#/components/schemas/ServiceError_2'
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_2'
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/storedPaymentMethods:
get:
tags:
- Methods
summary: Adyen Get Tokens for Stored Payment Details
description: 'Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper''s payment. A summary of the stored details is included.
'
x-addedInVersion: '70'
operationId: get-storedPaymentMethods
x-sortIndex: 2
x-methodName: getTokensForStoredPaymentDetails
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.
> Your reference must not include personally identifiable information (PII), for example name or email address.'
name: shopperReference
in: query
required: false
schema:
type: string
- description: Your merchant account.
name: merchantAccount
in: query
required: false
schema:
type: string
responses:
'200':
content:
application/json:
examples:
success:
$ref: '#/components/examples/get-storedPaymentMethods-success-200'
schema:
$ref: '#/components/schemas/ListStoredPaymentMethodsResponse'
description: OK - the request has succeeded.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/storedPaymentMethods/{storedPaymentMethodId}:
delete:
tags:
- Methods
summary: Adyen Delete a Token for Stored Payment Details
description: Deletes the token identified in the path. The token can no longer be used with payment requests.
x-addedInVersion: '70'
operationId: delete-storedPaymentMethods-storedPaymentMethodId
x-sortIndex: 4
x-methodName: deleteTokenForStoredPaymentDetails
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The unique identifier of the token.
name: storedPaymentMethodId
in: path
required: true
schema:
type: string
- description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.
> Your reference must not include personally identifiable information (PII), for example name or email address.'
name: shopperReference
in: query
required: true
schema:
type: string
- description: Your merchant account.
name: merchantAccount
in: query
required: true
schema:
type: string
responses:
'204':
description: 'No Content - look at the actual response code for the status of the request. '
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
ThreeDSRequestorPriorAuthenticationInfo:
properties:
threeDSReqPriorAuthData:
description: 'Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.'
type: string
threeDSReqPriorAuthMethod:
description: 'Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Allowed values:
* **01** Frictionless authentication occurred by ACS.
* **02** Cardholder challenge occurred by ACS.
* **03** AVS verified.
* **04** Other issuer methods.'
enum:
- '01'
- '02'
- '03'
- '04'
maxLength: 2
minLength: 2
type: string
threeDSReqPriorAuthTimestamp:
description: 'Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM'
maxLength: 12
minLength: 12
type: string
threeDSReqPriorRef:
description: 'This data element provides additional information to the ACS to determine the best approach for handing a request. This data element contains an ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder. Length: 30 characters.'
maxLength: 36
minLength: 36
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
PaymentMethodsResponse:
properties:
paymentMethods:
description: Detailed list of payment methods required to generate payment forms.
items:
$ref: '#/components/schemas/PaymentMethod'
type: array
storedPaymentMethods:
x-addedInVersion: '49'
description: List of all stored payment methods.
items:
$ref: '#/components/schemas/StoredPaymentMethod'
type: array
type: object
PaymentMethod:
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
type:
description: The unique payment method code.
type: string
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
ResponseAdditionalDataNetworkTokens:
properties:
networkToken.available:
description: Indicates whether a network token is available for the specified card.
type: string
networkToken.bin:
description: The Bank Identification Number of a tokenized card, which is the first six digits of a card number.
type: string
networkToken.tokenSummary:
description: The last four digits of a network token.
type: string
type: object
BalanceCheckRequest:
properties:
accountInfo:
x-addedInVersion: '40'
description: 'Shopper account information for 3D Secure 2.
> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.'
$ref: '#/components/schemas/AccountInfo'
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
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'
browserInfo:
description: 'The shopper''s browser information.
> For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the `userAgent` and `acceptHeader` fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 1.'
$ref: '#/components/schemas/BrowserInfo'
captureDelayHours:
x-addedInVersion: '2'
description: The delay between the authorisation and scheduled auto-capture, specified in hours.
format: int32
type: integer
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
deviceFingerprint:
x-addedInVersion: '2'
description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
maxLength: 5000
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'
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
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
merchantRiskIndicator:
x-addedInVersion: '40'
description: 'Additional risk fields for 3D Secure 2.
> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.'
$ref: '#/components/schemas/MerchantRiskIndicator'
metadata:
x-addedInVersion: '17'
additionalProperties:
type: string
description: 'Metadata consists of entries, each
# --- truncated at 32 KB (212 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-methods-api-openapi.yml