jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

yaml files

Browse Source
This commit is contained in:
aleksei
2019-11-19 16:57:12 +01:00
parent 816e9b347d
commit 07ae4c6bfc
15 changed files with 22515 additions and 939 deletions
Download Patch File Download Diff File Expand all files Collapse all files

753
specs/yaml/AccountService-v3.yaml
View File

File diff suppressed because it is too large Load Diff

143
specs/yaml/AccountService-v4.yaml
View File

@@ -3,21 +3,21 @@ servers:
- url: 'https://cal-test.adyen.com/cal/services/Account/v4'
info:
version: '4'
title: Adyen MarketPay Account Service
title: Adyen MarketPay Account API
description: |-
The MarketPay Account API provides endpoints for managing MarketPay account-related entities. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.
For further information on MarketPay API, visit the [MarketPay documentation](https://docs.adyen.com/developers/marketpay).
For further information on MarketPay API, visit the [MarketPay documentation](https://docs.adyen.com/marketpay).
## Authentication
To connect to the MarketPay API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:
```
curl
-U "ws@Company.YourCompany":"YourWsPassword" \
-U "ws@MarketPlace.YourMarketPlace":"YourWsPassword" \
-H "Content-Type: application/json" \
...
```
Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/developers/development-resources/live-endpoints).
Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).
## Versioning
MarketPay API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
@@ -238,7 +238,7 @@ paths:
description: |-
This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder.
For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).
For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
x-groupName: Verification
x-sortIndex: 2
requestBody:
@@ -355,7 +355,7 @@ paths:
If updating the `accountHolderDetails`, only the details which have been provided will be updated. Other details will be left as-is with the exception of the following fields:
* `accountHolderDetails.address`
* `accountHolderDetails.phoneNumber`
* `accountHolderDetails.fullPhoneNumber`
* `accountHolderDetails.bankAccountDetails.BankAccountDetail`
* `accountHolderDetails.businessDetails.shareholders.ShareholderContact`, which requires all fields necessary for validation (i.e. in order to update only the `accountHolderDetails.address.postalCode`, the fields `accountHolderDetails.address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` must be provided as well, so that the address can be properly validated).
@@ -393,7 +393,7 @@ paths:
description: |-
This endpoint is used to disable or enable the processing or payout state of an account holder. It cannot be used to enable an account holder whose processing or payout state has not been disabled through this endpoint.
For further information regarding processing and payout states of an account holder, please refer to the [MarketPay documentation](https://docs.adyen.com/developers/marketpay).
For further information regarding processing and payout states of an account holder, please refer to the [MarketPay documentation](https://docs.adyen.com/marketpay).
x-groupName: Account holders
x-sortIndex: 4
requestBody:
@@ -424,7 +424,7 @@ paths:
description: |-
This endpoint is used to upload a document for use in the KYC verification of an account holder.
For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).
For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
x-groupName: Verification
x-sortIndex: 1
requestBody:
@@ -477,7 +477,7 @@ components:
description: |-
The event.
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).
For more information, refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -502,7 +502,7 @@ components:
description: |-
Each of the bank accounts associated with the account holder.
> Each array entry should represent one bank account.
> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).
> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -544,6 +544,7 @@ components:
required:
- fullPhoneNumber
- email
- webAddress
AccountHolderStatus:
properties:
events:
@@ -627,7 +628,7 @@ components:
Amount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes).'
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).'
maxLength: 3
minLength: 3
type: string
@@ -635,7 +636,7 @@ components:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/developers/development-resources/currency-codes).
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
@@ -646,7 +647,7 @@ components:
accountNumber:
description: |-
The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
accountType:
description: |-
@@ -654,7 +655,7 @@ components:
Only applicable to bank accounts held in the USA.
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
bankAccountName:
description: The name of the bank account.
@@ -673,25 +674,25 @@ components:
bankBicSwift:
description: |-
The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
bankCity:
description: |-
The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
bankCode:
description: |-
The bank code of the banking institution with which the bank account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
bankName:
description: |-
The name of the banking institution with which the bank account is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
branchCode:
description: |-
@@ -699,46 +700,46 @@ components:
* United States - Routing number
* United Kingdom - Sort code
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
checkCode:
description: |-
The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
countryCode:
description: |-
The two-letter country code in which the bank account is registered.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
currencyCode:
description: |-
The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
iban:
description: |-
The international bank account number.
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerCity:
description: |-
The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerCountryCode:
description: |-
The country code of the country of residence of the bank account owner.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerDateOfBirth:
description: |
@@ -747,34 +748,34 @@ components:
ownerHouseNumberOrName:
description: |-
The house name or number of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerName:
description: |-
The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerNationality:
description: |-
The country code of the country of nationality of the bank account owner.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerPostalCode:
description: |-
The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerState:
description: |-
The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerStreet:
description: |-
The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
primaryAccount:
description: 'If set to true, the bank account is a primary account.'
@@ -783,20 +784,25 @@ components:
description: |-
The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
urlForVerification:
description: |-
The URL to be used for bank account verification.
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
BusinessDetails:
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the legal name of the company).
type: string
incorporatedAt:
description: |-
The jurisdiction of incorporation of the company.
>Two (2) characters for a business in the USA or Canada, or a maximum of three (3) characters for an address in all other countries, or 'FEDERAL'
type: string
legalBusinessName:
description: The legal name of the company.
type: string
@@ -911,10 +917,10 @@ components:
- PublicCompany
type: string
primaryCurrency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes), with which the prospective account holder primarily deals.'
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.'
type: string
processingTier:
description: 'The starting [processing tier](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks#tiers) for the prospective account holder.'
description: 'The starting [processing tier](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks#tiers) for the prospective account holder.'
format: int32
type: integer
required:
@@ -992,6 +998,7 @@ components:
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
- DAILY
- DAILY_6PM
- DAILY_US
- DEFAULT
- EVERY_6_HOURS_FROM_MIDNIGHT
- HOLD
@@ -1089,7 +1096,7 @@ components:
The unique ID of the Bank Account to which the document applies.
>Required if the documentType is `BANK_STATEMENT` (i.e., a document is being submitted in order to verify a bank account).
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account.
type: string
description:
description: Description of the document.
@@ -1099,16 +1106,16 @@ components:
The type of a document. Permitted values:
* `BANK_STATEMENT` denotes an image containing a bank statement or other document proving ownership of a specific bank account.
* `PASSPORT` denotes an image containing the identity page(s) of a passport.
* `ID_CARD` denotes an image containing both the front and back of the ID card.
* `ID_CARD_FRONT` denotes an image containing only the front of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted.
* `ID_CARD_BACK` denotes an image containing only the back of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted.
* `DRIVING_LICENCE_FRONT` denotes an image containing only the front of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_BACK` must be submitted.
* `DRIVING_LICENCE_BACK` denotes an image containing only the back of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_FRONT` must be submitted.
>Please refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks) for details on when each document type should be submitted.
>Please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks) for details on when each document type should be submitted.
enum:
- BANK_STATEMENT
- BSN
- COMPANY_REGISTRATION_SCREENING
- DRIVING_LICENCE
- DRIVING_LICENCE_BACK
- DRIVING_LICENCE_FRONT
@@ -1118,6 +1125,7 @@ components:
- NHIS
- PASSPORT
- SSN
- SUPPORTING_DOCUMENTS
type: string
filename:
description: Filename of the document.
@@ -1125,9 +1133,9 @@ components:
shareholderCode:
description: |-
The code of the shareholder, to which the document applies.
>Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type `Business` and the `documentType` is either `PASSPORT`, `ID_CARD`, `ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder).
>Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type `Business` and the `documentType` is either `PASSPORT`, `ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder).
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder.
type: string
required:
- accountHolderCode
@@ -1164,6 +1172,7 @@ components:
- bankAccount
- bankAccountCode
- bankAccountName
- bankAccountUUID
- bankBicSwift
- bankCity
- bankCode
@@ -1196,6 +1205,7 @@ components:
- firstName
- fullPhoneNumber
- gender
- hopWebserviceUser
- houseNumberOrName
- iban
- idCard
@@ -1203,16 +1213,19 @@ components:
- idCardFront
- idNumber
- identityDocument
- incorporatedAt
- individualDetails
- lastName
- legalBusinessName
- legalEntity
- legalEntityType
- merchantAccount
- merchantCategoryCode
- merchantReference
- microDeposit
- name
- nationality
- originalReference
- ownerCity
- ownerCountryCode
- ownerHouseNumberOrName
@@ -1222,6 +1235,7 @@ components:
- ownerStreet
- passport
- passportNumber
- payoutMethodCode
- personalData
- phoneCountryCode
- phoneNumber
@@ -1229,14 +1243,20 @@ components:
- primaryCurrency
- reason
- registrationNumber
- returnUrl
- schedule
- shareholder
- shareholderCode
- socialSecurityNumber
- sourceAccountCode
- stateOrProvince
- status
- store
- storeDetail
- storeReference
- street
- taxId
- tier
- tierNumber
- transferCode
- unknown
@@ -1309,7 +1329,7 @@ components:
- PublicCompany
type: string
primaryCurrency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes), with which the prospective account holder primarily deals.'
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.'
type: string
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
@@ -1528,6 +1548,7 @@ components:
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
- DAILY
- DAILY_6PM
- DAILY_US
- DEFAULT
- EVERY_6_HOURS_FROM_MIDNIGHT
- HOLD
@@ -1604,7 +1625,7 @@ components:
>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Bank Account will be updated.**
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**
type: string
webAddress:
description: The URL of the website of the contact.
@@ -1682,7 +1703,7 @@ components:
description: The description to which the Account Holder should be updated.
type: string
primaryCurrency:
description: 'The primary three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes), to which the account holder should be updated.'
description: 'The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated.'
type: string
processingTier:
description: |-
@@ -1848,6 +1869,7 @@ components:
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
- DAILY
- DAILY_6PM
- DAILY_US
- DEFAULT
- EVERY_6_HOURS_FROM_MIDNIGHT
- HOLD
@@ -1860,17 +1882,34 @@ components:
- schedule
UploadDocumentRequest:
properties:
accountHolderCode:
deprecated: true
description: 'The code of the account holder, for which the document is submitted.'
type: string
bankAccountUUID:
deprecated: true
description: |-
The unique ID of the bank account, for which the document is submitted.
>Required if the document is being submitted in order to verify a bank account.
type: string
documentContent:
description: |-
The content of the document as represented by a Base64-encoded string.
To learn about requirements, see [Bank account check](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks/bank-account-check#requirements) and [Photo ID check](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks/photo-id-check#requirements).
To learn about requirements, see [Bank account check](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks/bank-account-check#requirements) and [Photo ID check](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks/photo-id-check#requirements).
format: byte
type: string
documentDetail:
description: Details of the document being submitted.
$ref: '#/components/schemas/DocumentDetail'
shareholderCode:
deprecated: true
description: |-
The code of the shareholder, for which the document is submitted.
>Required if the document is being submitted in order to verify a shareholder.
type: string
required:
- accountHolderCode
- documentDetail
- documentContent
ViasAddress:
@@ -1878,12 +1917,12 @@ components:
city:
description: |-
The name of the city.
>Required if either houseNumberOrName, street, postalCode, or stateOrProvince are provided.
>Required if either `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.
type: string
country:
description: |-
The two-character country code of the address
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
type: string
houseNumberOrName:
description: The number or name of the house.
@@ -1892,19 +1931,19 @@ components:
description: |-
The postal code.
>A maximum of five (5) digits for an address in the USA, or a maximum of ten (10) characters for an address in all other countries.
>Required if either houseNumberOrName, street, city, or stateOrProvince are provided.
>Required if either `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided.
type: string
stateOrProvince:
description: |-
The abbreviation of the state or province.
>Two (2) characters for an address in the USA or Canada, or a maximum of three (3) characters for an address in all other countries.
>Required for an address in the USA or Canada if either houseNumberOrName, street, city, or postalCode are provided.
>Required for an address in the USA or Canada if either `houseNumberOrName`, `street`, `city`, or `postalCode` are provided.
type: string
street:
description: |-
The name of the street.
>The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
>Required if either houseNumberOrName, city, postalCode, or stateOrProvince are provided.
>Required if either `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided.
type: string
required:
- country
@@ -1948,6 +1987,10 @@ components:
items:
$ref: '#/components/schemas/PersonalDocumentData'
type: array
idNumber:
deprecated: true
description: An ID number of the person.
type: string
nationality:
description: |-
The nationality of the person represented by a two-character country code.

218
specs/yaml/AccountService-v5.yaml
View File

@@ -3,21 +3,21 @@ servers:
- url: 'https://cal-test.adyen.com/cal/services/Account/v5'
info:
version: '5'
title: Adyen MarketPay Account Service
title: Adyen MarketPay Account API
description: |-
The MarketPay Account API provides endpoints for managing MarketPay account-related entities. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.
For further information on MarketPay API, visit the [MarketPay documentation](https://docs.adyen.com/developers/marketpay).
For further information on MarketPay API, visit the [MarketPay documentation](https://docs.adyen.com/marketpay).
## Authentication
To connect to the MarketPay API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:
```
curl
-U "ws@Company.YourCompany":"YourWsPassword" \
-U "ws@MarketPlace.YourMarketPlace":"YourWsPassword" \
-H "Content-Type: application/json" \
...
```
Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/developers/development-resources/live-endpoints).
Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).
## Versioning
MarketPay API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
@@ -36,6 +36,34 @@ x-groups:
- Accounts
- Verification
paths:
/checkAccountHolder:
post:
summary: Request to perform verification for an account holder.
description: This endpoint allows to trigger the verification of the account holder earlier than it's required by the currently processed volume.
x-groupName: Verification
x-sortIndex: 5
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PerformVerificationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
description: OK - the request has succeeded.
'400':
description: Bad Request - a problem reading or understanding the request.
'401':
description: Unauthorized - authentication required.
'403':
description: Forbidden - insufficient permissions to process the request.
'422':
description: Unprocessable Entity - a request validation error.
'500':
description: Internal Server Error - the server could not process the request.
/closeAccount:
post:
summary: Close an existing account under an account holder.
@@ -176,17 +204,17 @@ paths:
description: Unprocessable Entity - a request validation error.
'500':
description: Internal Server Error - the server could not process the request.
/deletePayoutInstrumentTokens:
/deletePayoutMethods:
post:
summary: Delete payout instrument tokens of an existing account holder.
description: 'This endpoint is used to delete existing payout instrument tokens from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `payoutInstrumentTokenCodes` specifying payout instrument tokens to delete.'
summary: Delete payout methods of an existing account holder.
description: 'This endpoint is used to delete existing payout method from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `payoutMethodCodes` specifying payout methods to delete.'
x-groupName: Verification
x-sortIndex: 3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePayoutInstrumentTokenRequest'
$ref: '#/components/schemas/DeletePayoutMethodRequest'
responses:
'200':
content:
@@ -266,7 +294,7 @@ paths:
description: |-
This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder.
For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).
For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
x-groupName: Verification
x-sortIndex: 2
requestBody:
@@ -383,7 +411,7 @@ paths:
If updating the `accountHolderDetails`, only the details which have been provided will be updated. Other details will be left as-is with the exception of the following fields:
* `accountHolderDetails.address`
* `accountHolderDetails.phoneNumber`
* `accountHolderDetails.fullPhoneNumber`
* `accountHolderDetails.bankAccountDetails.BankAccountDetail`
* `accountHolderDetails.businessDetails.shareholders.ShareholderContact`, which requires all fields necessary for validation (i.e. in order to update only the `accountHolderDetails.address.postalCode`, the fields `accountHolderDetails.address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` must be provided as well, so that the address can be properly validated).
@@ -421,7 +449,7 @@ paths:
description: |-
This endpoint is used to disable or enable the processing or payout state of an account holder. It cannot be used to enable an account holder whose processing or payout state has not been disabled through this endpoint.
For further information regarding processing and payout states of an account holder, please refer to the [MarketPay documentation](https://docs.adyen.com/developers/marketpay).
For further information regarding processing and payout states of an account holder, please refer to the [MarketPay documentation](https://docs.adyen.com/marketpay).
x-groupName: Account holders
x-sortIndex: 4
requestBody:
@@ -452,7 +480,7 @@ paths:
description: |-
This endpoint is used to upload a document for use in the KYC verification of an account holder.
For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).
For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
x-groupName: Verification
x-sortIndex: 1
requestBody:
@@ -477,34 +505,6 @@ paths:
description: Unprocessable Entity - a request validation error.
'500':
description: Internal Server Error - the server could not process the request.
/verification:
post:
summary: Request to perform verification for an account holder.
description: This endpoint allows to trigger the verification of the account holder earlier than it's required by the currently processed volume.
x-groupName: Verification
x-sortIndex: 5
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PerformVerificationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
description: OK - the request has succeeded.
'400':
description: Bad Request - a problem reading or understanding the request.
'401':
description: Unauthorized - authentication required.
'403':
description: Forbidden - insufficient permissions to process the request.
'422':
description: Unprocessable Entity - a request validation error.
'500':
description: Internal Server Error - the server could not process the request.
components:
schemas:
Account:
@@ -539,7 +539,7 @@ components:
description: |-
The event.
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).
For more information, refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -564,7 +564,7 @@ components:
description: |-
Each of the bank accounts associated with the account holder.
> Each array entry should represent one bank account.
> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).
> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -600,13 +600,13 @@ components:
> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.
> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
type: object
payoutInstrumentTokens:
payoutMethods:
description: |-
Each of the card tokens associated with the account holder.
> Each array entry should represent one card token.
> For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).
> For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
items:
$ref: '#/components/schemas/PayoutInstrumentToken'
$ref: '#/components/schemas/PayoutMethod'
type: array
webAddress:
description: The URL of the website of the account holder.
@@ -614,6 +614,7 @@ components:
required:
- fullPhoneNumber
- email
- webAddress
AccountHolderStatus:
properties:
events:
@@ -701,7 +702,7 @@ components:
Amount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes).'
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).'
maxLength: 3
minLength: 3
type: string
@@ -709,7 +710,7 @@ components:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/developers/development-resources/currency-codes).
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
@@ -720,7 +721,7 @@ components:
accountNumber:
description: |-
The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
accountType:
description: |-
@@ -728,7 +729,7 @@ components:
Only applicable to bank accounts held in the USA.
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
bankAccountName:
description: The name of the bank account.
@@ -750,25 +751,25 @@ components:
bankBicSwift:
description: |-
The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
bankCity:
description: |-
The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
bankCode:
description: |-
The bank code of the banking institution with which the bank account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
bankName:
description: |-
The name of the banking institution with which the bank account is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
branchCode:
description: |-
@@ -776,46 +777,46 @@ components:
* United States - Routing number
* United Kingdom - Sort code
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
checkCode:
description: |-
The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
countryCode:
description: |-
The two-letter country code in which the bank account is registered.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
currencyCode:
description: |-
The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
iban:
description: |-
The international bank account number.
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerCity:
description: |-
The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerCountryCode:
description: |-
The country code of the country of residence of the bank account owner.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerDateOfBirth:
description: |
@@ -824,34 +825,34 @@ components:
ownerHouseNumberOrName:
description: |-
The house name or number of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerName:
description: |-
The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerNationality:
description: |-
The country code of the country of nationality of the bank account owner.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerPostalCode:
description: |-
The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerState:
description: |-
The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
ownerStreet:
description: |-
The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
primaryAccount:
description: 'If set to true, the bank account is a primary account.'
@@ -860,20 +861,25 @@ components:
description: |-
The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
urlForVerification:
description: |-
The URL to be used for bank account verification.
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on field requirements.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
type: string
BusinessDetails:
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the legal name of the company).
type: string
incorporatedAt:
description: |-
The jurisdiction of incorporation of the company.
>Two (2) characters for a business in the USA or Canada, or a maximum of three (3) characters for an address in all other countries, or 'FEDERAL'
type: string
legalBusinessName:
description: The legal name of the company.
type: string
@@ -982,10 +988,10 @@ components:
- PublicCompany
type: string
primaryCurrency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes), with which the prospective account holder primarily deals.'
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.'
type: string
processingTier:
description: 'The starting [processing tier](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks#tiers) for the prospective account holder.'
description: 'The starting [processing tier](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks#tiers) for the prospective account holder.'
format: int32
type: integer
required:
@@ -1023,7 +1029,7 @@ components:
- PublicCompany
type: string
primaryCurrency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes), with which the prospective account holder primarily deals.'
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.'
type: string
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
@@ -1064,6 +1070,7 @@ components:
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
- DAILY
- DAILY_6PM
- DAILY_US
- DEFAULT
- EVERY_6_HOURS_FROM_MIDNIGHT
- HOLD
@@ -1139,19 +1146,19 @@ components:
required:
- accountHolderCode
- bankAccountUUIDs
DeletePayoutInstrumentTokenRequest:
DeletePayoutMethodRequest:
properties:
accountHolderCode:
description: 'The code of the account holder, from which to delete the payout instrument tokens.'
description: 'The code of the account holder, from which to delete the payout methods.'
type: string
payoutInstrumentTokenCodes:
description: The codes of the payout instrument tokens to be deleted.
payoutMethodCodes:
description: The codes of the payout methods to be deleted.
items:
type: string
type: array
required:
- accountHolderCode
- payoutInstrumentTokenCodes
- payoutMethodCodes
DeleteShareholderRequest:
properties:
accountHolderCode:
@@ -1175,7 +1182,7 @@ components:
The unique ID of the Bank Account to which the document applies.
>Required if the documentType is `BANK_STATEMENT` (i.e., a document is being submitted in order to verify a bank account).
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account.
type: string
description:
description: Description of the document.
@@ -1185,25 +1192,25 @@ components:
The type of a document. Permitted values:
* `BANK_STATEMENT` denotes an image containing a bank statement or other document proving ownership of a specific bank account.
* `PASSPORT` denotes an image containing the identity page(s) of a passport.
* `ID_CARD` denotes an image containing both the front and back of the ID card.
* `ID_CARD_FRONT` denotes an image containing only the front of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted.
* `ID_CARD_BACK` denotes an image containing only the back of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted.
* `DRIVING_LICENCE_FRONT` denotes an image containing only the front of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_BACK` must be submitted.
* `DRIVING_LICENCE_BACK` denotes an image containing only the back of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_FRONT` must be submitted.
>Please refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks) for details on when each document type should be submitted.
>Please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks) for details on when each document type should be submitted.
enum:
- BANK_STATEMENT
- BSN
- COMPANY_REGISTRATION_SCREENING
- DRIVING_LICENCE
- DRIVING_LICENCE_BACK
- DRIVING_LICENCE_FRONT
- ID_CARD
- ID_CARD_BACK
- ID_CARD_FRONT
- NHIS
- PASSPORT
- SSN
- SUPPORTING_DOCUMENTS
type: string
filename:
description: Filename of the document.
@@ -1211,9 +1218,9 @@ components:
shareholderCode:
description: |-
The code of the shareholder, to which the document applies.
>Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type `Business` and the `documentType` is either `PASSPORT`, `ID_CARD`, `ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder).
>Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type `Business` and the `documentType` is either `PASSPORT`, `ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder).
>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder.
>Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder.
type: string
required:
- accountHolderCode
@@ -1250,6 +1257,7 @@ components:
- bankAccount
- bankAccountCode
- bankAccountName
- bankAccountUUID
- bankBicSwift
- bankCity
- bankCode
@@ -1282,6 +1290,7 @@ components:
- firstName
- fullPhoneNumber
- gender
- hopWebserviceUser
- houseNumberOrName
- iban
- idCard
@@ -1289,16 +1298,19 @@ components:
- idCardFront
- idNumber
- identityDocument
- incorporatedAt
- individualDetails
- lastName
- legalBusinessName
- legalEntity
- legalEntityType
- merchantAccount
- merchantCategoryCode
- merchantReference
- microDeposit
- name
- nationality
- originalReference
- ownerCity
- ownerCountryCode
- ownerHouseNumberOrName
@@ -1308,6 +1320,7 @@ components:
- ownerStreet
- passport
- passportNumber
- payoutMethodCode
- personalData
- phoneCountryCode
- phoneNumber
@@ -1315,14 +1328,20 @@ components:
- primaryCurrency
- reason
- registrationNumber
- returnUrl
- schedule
- shareholder
- shareholderCode
- socialSecurityNumber
- sourceAccountCode
- stateOrProvince
- status
- store
- storeDetail
- storeReference
- street
- taxId
- tier
- tierNumber
- transferCode
- unknown
@@ -1397,7 +1416,7 @@ components:
- PublicCompany
type: string
primaryCurrency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes), with which the prospective account holder primarily deals.'
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.'
type: string
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
@@ -1405,6 +1424,10 @@ components:
resultCode:
description: The result code.
type: string
systemUpToDateTime:
description: The time that shows how up to date is the information in the response.
format: date-time
type: string
verification:
description: The details of KYC Verification of the account holder.
$ref: '#/components/schemas/KYCVerificationResult'
@@ -1585,13 +1608,13 @@ components:
- accountHolder
- shareholders
- bankAccounts
PayoutInstrumentToken:
PayoutMethod:
properties:
merchantAccount:
type: string
payoutInstrumentTokenCode:
payoutMethodCode:
type: string
payoutInstrumentTokenType:
payoutMethodType:
enum:
- CardToken
type: string
@@ -1618,6 +1641,7 @@ components:
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
- DAILY
- DAILY_6PM
- DAILY_US
- DEFAULT
- EVERY_6_HOURS_FROM_MIDNIGHT
- HOLD
@@ -1719,9 +1743,10 @@ components:
>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Bank Account will be updated.**
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**
type: string
shareholderReference:
description: Merchant reference to the Shareholder.
type: string
webAddress:
description: The URL of the website of the contact.
@@ -1807,7 +1832,7 @@ components:
- PublicCompany
type: string
primaryCurrency:
description: 'The primary three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes), to which the account holder should be updated.'
description: 'The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated.'
type: string
processingTier:
description: |-
@@ -1847,7 +1872,7 @@ components:
- PublicCompany
type: string
primaryCurrency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/developers/development-resources/currency-codes), with which the prospective account holder primarily deals.'
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.'
type: string
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
@@ -1970,6 +1995,7 @@ components:
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
- DAILY
- DAILY_6PM
- DAILY_US
- DEFAULT
- EVERY_6_HOURS_FROM_MIDNIGHT
- HOLD
@@ -1986,7 +2012,7 @@ components:
description: |-
The content of the document as represented by a Base64-encoded string.
To learn about requirements, see [Bank account check](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks/bank-account-check#requirements) and [Photo ID check](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks/photo-id-check#requirements).
To learn about requirements, see [Bank account check](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks/bank-account-check#requirements) and [Photo ID check](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks/photo-id-check#requirements).
format: byte
type: string
documentDetail:
@@ -2000,12 +2026,12 @@ components:
city:
description: |-
The name of the city.
>Required if either houseNumberOrName, street, postalCode, or stateOrProvince are provided.
>Required if either `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.
type: string
country:
description: |-
The two-character country code of the address
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
type: string
houseNumberOrName:
description: The number or name of the house.
@@ -2014,19 +2040,19 @@ components:
description: |-
The postal code.
>A maximum of five (5) digits for an address in the USA, or a maximum of ten (10) characters for an address in all other countries.
>Required if either houseNumberOrName, street, city, or stateOrProvince are provided.
>Required if either `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided.
type: string
stateOrProvince:
description: |-
The abbreviation of the state or province.
>Two (2) characters for an address in the USA or Canada, or a maximum of three (3) characters for an address in all other countries.
>Required for an address in the USA or Canada if either houseNumberOrName, street, city, or postalCode are provided.
>Required for an address in the USA or Canada if either `houseNumberOrName`, `street`, `city`, or `postalCode` are provided.
type: string
street:
description: |-
The name of the street.
>The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
>Required if either houseNumberOrName, city, postalCode, or stateOrProvince are provided.
>Required if either `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided.
type: string
required:
- country

373
specs/yaml/BinLookupService-v40.yaml Normal file
View File

@@ -0,0 +1,373 @@
openapi: 3.0.0
servers:
- url: 'https://pal-test.adyen.com/pal/servlet/BinLookup/v40'
info:
version: '40'
title: Adyen BinLookup API
description: 'The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.'
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
contact:
name: Adyen Support
url: 'https://support.adyen.com/'
email: support@adyen.com
x-groups:
- General
paths:
/get3dsAvailability:
post:
summary: Checks 3D Secure availability.
description: |-
Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys.
For more information, refer to [3D Secure 2](https://docs.adyen.com/checkout/3d-secure/native-3ds2).
x-groupName: General
x-sortIndex: 0
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDSAvailabilityRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDSAvailabilityResponse'
description: OK - the request has succeeded.
'400':
description: Bad Request - a problem reading or understanding the request.
'401':
description: Unauthorized - authentication required.
'403':
description: Forbidden - insufficient permissions to process the request.
'422':
description: Unprocessable Entity - a request validation error.
'500':
description: Internal Server Error - the server could not process the request.
/getCostEstimate:
post:
summary: Gets a cost estimate.
description: |-
Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary.
To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations).
> Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.
x-groupName: General
x-sortIndex: 0
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CostEstimateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CostEstimateResponse'
description: OK - the request has succeeded.
'400':
description: Bad Request - a problem reading or understanding the request.
'401':
description: Unauthorized - authentication required.
'403':
description: Forbidden - insufficient permissions to process the request.
'422':
description: Unprocessable Entity - a request validation error.
'500':
description: Internal Server Error - the server could not process the request.
components:
schemas:
Amount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).'
maxLength: 3
minLength: 3
type: string
value:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
- value
- currency
CardBin:
properties:
bin:
description: The first 6 digit of the card number. Enable this field via merchant account settings.
type: string
commercial:
description: 'If true, it indicates a commercial card. Enable this field via merchant account settings.'
type: boolean
fundingSource:
description: |-
The card funding source. Valid values are:
* CHARGE
* CREDIT
* DEBIT
* DEFERRED_DEBIT
* PREPAID
* PREPAID_RELOADABLE
* PREPAID_NONRELOADABLE
> Enable this field via merchant account settings.
type: string
fundsAvailability:
description: |-
Indicates availability of funds.
Visa:
* "I" (fast funds are supported)
* "N" (otherwise)
Mastercard:
* "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list)
* "N" (otherwise)
> Returned when you verify a card BIN or estimate costs, and only if `payoutEligible` is different from "N" or "U".
type: string
issuingBank:
description: The issuing bank of the card.
type: string
issuingCountry:
description: The country where the card was issued from.
type: string
issuingCurrency:
description: The currency of the card.
type: string
paymentMethod:
description: 'The payment method associated with the card (e.g. visa, mc, or amex).'
type: string
payoutEligible:
description: |-
Indicates whether a payout is eligible or not for this card.
Visa:
* "Y"
* "N"
Mastercard:
* "Y" (domestic and cross-border)
* "D" (only domestic)
* "N" (no MoneySend)
* "U" (unknown)
> Returned when you verify a card BIN or estimate costs, and only if `payoutEligible` is different from "N" or "U".
type: string
summary:
description: The last four digits of the card number.
type: string
CostEstimateAssumptions:
properties:
assume3DSecureAuthenticated:
description: 'If true, the cardholder is expected to successfully authorise via 3D Secure.'
type: boolean
assumeLevel3Data:
description: 'If true, the transaction is expected to have valid Level 3 data.'
type: boolean
installments:
description: 'If not zero, the number of installments.'
format: int32
type: integer
CostEstimateRequest:
properties:
amount:
description: The transaction amount used as a base for the cost estimation.
$ref: '#/components/schemas/Amount'
assumptions:
description: 'Assumptions made for the expected characteristics of the transaction, for which the charges are being estimated.'
$ref: '#/components/schemas/CostEstimateAssumptions'
cardNumber:
description: |-
The card number (4-19 characters) for PCI compliant use cases. Do not use any separators.
> Either the `cardNumber` or `encryptedCard` field must be provided in a payment request.
maxLength: 19
minLength: 4
type: string
encryptedCard:
description: |-
Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field.
> Either the `cardNumber` or `encryptedCard` field must be provided in a payment request.
type: string
merchantAccount:
description: The merchant account identifier you want to process the (transaction) request with.
type: string
merchantDetails:
description: Additional data for merchants who don't use Adyen as the payment authorisation gateway.
$ref: '#/components/schemas/MerchantDetails'
recurring:
description: 'The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/checkout/tokenization).'
$ref: '#/components/schemas/Recurring'
selectedRecurringDetailReference:
description: The `recurringDetailReference` you want to use for this cost estimate. The value `LATEST` can be used to select the most recently stored recurring detail.
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 card holder 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
shopperReference:
description: |-
The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
> This field is required for recurring payments.
type: string
required:
- amount
- merchantAccount
CostEstimateResponse:
properties:
cardBin:
description: Card BIN details.
$ref: '#/components/schemas/CardBin'
costEstimateAmount:
description: 'The estimated cost (scheme fee + interchange) in the settlement currency. If the settlement currency cannot be determined, the fee in EUR is returned.'
$ref: '#/components/schemas/Amount'
resultCode:
description: The result of the cost estimation.
type: string
surchargeType:
description: |-
Indicates the way the charges can be passed on to the cardholder. The following values are possible:
* `ZERO` - the charges are not allowed to pass on
* `PASSTHROUGH` - the charges can be passed on
* `UNLIMITED` - there is no limit on how much surcharge is passed on
type: string
DSPublicKeyDetail:
properties:
brand:
description: Card brand.
type: string
directoryServerId:
description: Directory Server (DS) identifier.
type: string
publicKey:
description: Public key. The 3D Secure 2 SDK encrypts the device information by using the DS public key.
format: byte
type: string
MerchantDetails:
properties:
countryCode:
description: |-
2-letter ISO 3166 country code of the card acceptor location.
> This parameter is required for the merchants who don't use Adyen as the payment authorisation gateway.
maxLength: 2
minLength: 2
type: string
enrolledIn3DSecure:
description: 'If true, indicates that the merchant is enrolled in 3D Secure for the card network.'
type: boolean
mcc:
description: |-
The 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.
The list of MCCs can be found [here](https://en.wikipedia.org/wiki/Merchant_category_code).
type: string
Recurring:
properties:
contract:
description: |-
The type of recurring contract to be used.
Possible values:
* `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).
* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).
* `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not.
* `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/checkout/online-payouts).
enum:
- ONECLICK
- RECURRING
- PAYOUT
type: string
recurringDetailName:
description: A descriptive name for this detail.
type: string
recurringExpiry:
description: Date after which no further authorisations shall be performed. Only for 3D Secure 2.
format: date-time
type: string
recurringFrequency:
description: Minimum number of days between authorisations. Only for 3D Secure 2.
type: string
tokenService:
description: The name of the token service.
enum:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
ThreeDS2CardRangeDetail:
properties:
brandCode:
description: Card brand.
type: string
endRange:
description: BIN end range.
type: string
startRange:
description: BIN start range.
type: string
threeDS2Version:
description: 3D Secure protocol version.
type: string
threeDSMethodURL:
description: 'In a 3D Secure 2 browser-based flow, this is the URL where you should send the device fingerprint to.'
type: string
ThreeDSAvailabilityRequest:
properties:
additionalData:
description: |-
This field contains additional data, which may be required for a particular request.
The `additionalData` object consists of entries, each of which includes the key and value. For more information on possible key-value pairs, refer to the [additionalData section](https://docs.adyen.com/api-reference/payments-api/paymentrequest/paymentrequest-additionaldata).
type: object
brands:
description: List of brands.
items:
type: string
type: array
cardNumber:
description: Card number or BIN.
type: string
merchantAccount:
description: The merchant account identifier.
type: string
recurringDetailReference:
description: A recurring detail reference corresponding to a card.
type: string
shopperReference:
description: The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
type: string
required:
- merchantAccount
- brands
ThreeDSAvailabilityResponse:
properties:
dsPublicKeys:
description: List of Directory Server (DS) public keys.
items:
$ref: '#/components/schemas/DSPublicKeyDetail'
type: array
threeDS1Supported:
description: Indicator if 3D Secure 1 is supported.
type: boolean
threeDS2CardRangeDetails:
description: List of brand and card range pairs.
items:
$ref: '#/components/schemas/ThreeDS2CardRangeDetail'
type: array
threeDS2supported:
description: Indicator if 3D Secure 2 is supported.
type: boolean

381
specs/yaml/BinLookupService-v50.yaml Normal file
View File

@@ -0,0 +1,381 @@
openapi: 3.0.0
servers:
- url: 'https://pal-test.adyen.com/pal/servlet/BinLookup/v50'
info:
version: '50'
title: Adyen BinLookup API
description: 'The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.'
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
contact:
name: Adyen Support
url: 'https://support.adyen.com/'
email: support@adyen.com
x-groups:
- General
paths:
/get3dsAvailability:
post:
summary: Checks 3D Secure availability.
description: |-
Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys.
For more information, refer to [3D Secure 2](https://docs.adyen.com/checkout/3d-secure/native-3ds2).
x-groupName: General
x-sortIndex: 0
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDSAvailabilityRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDSAvailabilityResponse'
description: OK - the request has succeeded.
'400':
description: Bad Request - a problem reading or understanding the request.
'401':
description: Unauthorized - authentication required.
'403':
description: Forbidden - insufficient permissions to process the request.
'422':
description: Unprocessable Entity - a request validation error.
'500':
description: Internal Server Error - the server could not process the request.
/getCostEstimate:
post:
summary: Gets a cost estimate.
description: |-
Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary.
To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations).
> Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.
x-groupName: General
x-sortIndex: 0
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CostEstimateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CostEstimateResponse'
description: OK - the request has succeeded.
'400':
description: Bad Request - a problem reading or understanding the request.
'401':
description: Unauthorized - authentication required.
'403':
description: Forbidden - insufficient permissions to process the request.
'422':
description: Unprocessable Entity - a request validation error.
'500':
description: Internal Server Error - the server could not process the request.
components:
schemas:
Amount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).'
maxLength: 3
minLength: 3
type: string
value:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
- value
- currency
BinDetail:
properties:
issuerCountry:
description: The country where the card was issued.
type: string
CardBin:
properties:
bin:
description: The first 6 digit of the card number. Enable this field via merchant account settings.
type: string
commercial:
description: 'If true, it indicates a commercial card. Enable this field via merchant account settings.'
type: boolean
fundingSource:
description: |-
The card funding source. Valid values are:
* CHARGE
* CREDIT
* DEBIT
* DEFERRED_DEBIT
* PREPAID
* PREPAID_RELOADABLE
* PREPAID_NONRELOADABLE
> Enable this field via merchant account settings.
type: string
fundsAvailability:
description: |-
Indicates availability of funds.
Visa:
* "I" (fast funds are supported)
* "N" (otherwise)
Mastercard:
* "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list)
* "N" (otherwise)
> Returned when you verify a card BIN or estimate costs, and only if `payoutEligible` is different from "N" or "U".
type: string
issuingBank:
description: The issuing bank of the card.
type: string
issuingCountry:
description: The country where the card was issued from.
type: string
issuingCurrency:
description: The currency of the card.
type: string
paymentMethod:
description: 'The payment method associated with the card (e.g. visa, mc, or amex).'
type: string
payoutEligible:
description: |-
Indicates whether a payout is eligible or not for this card.
Visa:
* "Y"
* "N"
Mastercard:
* "Y" (domestic and cross-border)
* "D" (only domestic)
* "N" (no MoneySend)
* "U" (unknown)
> Returned when you verify a card BIN or estimate costs, and only if `payoutEligible` is different from "N" or "U".
type: string
summary:
description: The last four digits of the card number.
type: string
CostEstimateAssumptions:
properties:
assume3DSecureAuthenticated:
description: 'If true, the cardholder is expected to successfully authorise via 3D Secure.'
type: boolean
assumeLevel3Data:
description: 'If true, the transaction is expected to have valid Level 3 data.'
type: boolean
installments:
description: 'If not zero, the number of installments.'
format: int32
type: integer
CostEstimateRequest:
properties:
amount:
description: The transaction amount used as a base for the cost estimation.
$ref: '#/components/schemas/Amount'
assumptions:
description: 'Assumptions made for the expected characteristics of the transaction, for which the charges are being estimated.'
$ref: '#/components/schemas/CostEstimateAssumptions'
cardNumber:
description: |-
The card number (4-19 characters) for PCI compliant use cases. Do not use any separators.
> Either the `cardNumber` or `encryptedCard` field must be provided in a payment request.
maxLength: 19
minLength: 4
type: string
encryptedCard:
description: |-
Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field.
> Either the `cardNumber` or `encryptedCard` field must be provided in a payment request.
type: string
merchantAccount:
description: The merchant account identifier you want to process the (transaction) request with.
type: string
merchantDetails:
description: Additional data for merchants who don't use Adyen as the payment authorisation gateway.
$ref: '#/components/schemas/MerchantDetails'
recurring:
description: 'The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/checkout/tokenization).'
$ref: '#/components/schemas/Recurring'
selectedRecurringDetailReference:
description: The `recurringDetailReference` you want to use for this cost estimate. The value `LATEST` can be used to select the most recently stored recurring detail.
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 card holder 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
shopperReference:
description: |-
The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
> This field is required for recurring payments.
type: string
required:
- amount
- merchantAccount
CostEstimateResponse:
properties:
cardBin:
description: Card BIN details.
$ref: '#/components/schemas/CardBin'
costEstimateAmount:
description: 'The estimated cost (scheme fee + interchange) in the settlement currency. If the settlement currency cannot be determined, the fee in EUR is returned.'
$ref: '#/components/schemas/Amount'
resultCode:
description: The result of the cost estimation.
type: string
surchargeType:
description: |-
Indicates the way the charges can be passed on to the cardholder. The following values are possible:
* `ZERO` - the charges are not allowed to pass on
* `PASSTHROUGH` - the charges can be passed on
* `UNLIMITED` - there is no limit on how much surcharge is passed on
type: string
DSPublicKeyDetail:
properties:
brand:
description: Card brand.
type: string
directoryServerId:
description: Directory Server (DS) identifier.
type: string
publicKey:
description: Public key. The 3D Secure 2 SDK encrypts the device information by using the DS public key.
format: byte
type: string
MerchantDetails:
properties:
countryCode:
description: |-
2-letter ISO 3166 country code of the card acceptor location.
> This parameter is required for the merchants who don't use Adyen as the payment authorisation gateway.
maxLength: 2
minLength: 2
type: string
enrolledIn3DSecure:
description: 'If true, indicates that the merchant is enrolled in 3D Secure for the card network.'
type: boolean
mcc:
description: |-
The 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.
The list of MCCs can be found [here](https://en.wikipedia.org/wiki/Merchant_category_code).
type: string
Recurring:
properties:
contract:
description: |-
The type of recurring contract to be used.
Possible values:
* `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).
* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).
* `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not.
* `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/checkout/online-payouts).
enum:
- ONECLICK
- RECURRING
- PAYOUT
type: string
recurringDetailName:
description: A descriptive name for this detail.
type: string
recurringExpiry:
description: Date after which no further authorisations shall be performed. Only for 3D Secure 2.
format: date-time
type: string
recurringFrequency:
description: Minimum number of days between authorisations. Only for 3D Secure 2.
type: string
tokenService:
description: The name of the token service.
enum:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
ThreeDS2CardRangeDetail:
properties:
brandCode:
description: Card brand.
type: string
endRange:
description: BIN end range.
type: string
startRange:
description: BIN start range.
type: string
threeDS2Version:
description: 3D Secure protocol version.
type: string
threeDSMethodURL:
description: 'In a 3D Secure 2 browser-based flow, this is the URL where you should send the device fingerprint to.'
type: string
ThreeDSAvailabilityRequest:
properties:
additionalData:
description: |-
This field contains additional data, which may be required for a particular request.
The `additionalData` object consists of entries, each of which includes the key and value. For more information on possible key-value pairs, refer to the [additionalData section](https://docs.adyen.com/api-reference/payments-api/paymentrequest/paymentrequest-additionaldata).
type: object
brands:
description: List of brands.
items:
type: string
type: array
cardNumber:
description: Card number or BIN.
type: string
merchantAccount:
description: The merchant account identifier.
type: string
recurringDetailReference:
description: A recurring detail reference corresponding to a card.
type: string
shopperReference:
description: The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
type: string
required:
- merchantAccount
- brands
ThreeDSAvailabilityResponse:
properties:
binDetails:
description: Bin Group Details
$ref: '#/components/schemas/BinDetail'
dsPublicKeys:
description: List of Directory Server (DS) public keys.
items:
$ref: '#/components/schemas/DSPublicKeyDetail'
type: array
threeDS1Supported:
description: Indicator if 3D Secure 1 is supported.
type: boolean
threeDS2CardRangeDetails:
description: List of brand and card range pairs.
items:
$ref: '#/components/schemas/ThreeDS2CardRangeDetail'
type: array
threeDS2supported:
description: Indicator if 3D Secure 2 is supported.
type: boolean

2644
specs/yaml/CheckoutService-v32.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

2661
specs/yaml/CheckoutService-v33.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

1479
specs/yaml/CheckoutService-v37.yaml
View File

File diff suppressed because it is too large Load Diff

1755
specs/yaml/CheckoutService-v40.yaml
View File

File diff suppressed because it is too large Load Diff

1401
specs/yaml/CheckoutService-v41.yaml
View File

File diff suppressed because it is too large Load Diff

1401
specs/yaml/CheckoutService-v46.yaml
View File

File diff suppressed because it is too large Load Diff

3387
specs/yaml/CheckoutService-v49.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

3420
specs/yaml/CheckoutService-v50.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

3432
specs/yaml/CheckoutService-v51.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

6
specs/yaml/CheckoutUtilityService-v1.yaml
View File

@@ -3,11 +3,11 @@ servers:
- url: 'https://checkout-test.adyen.com/v1'
info:
version: '1'
title: Adyen Checkout Utility Service
title: Adyen Checkout Utility API
description: |-
A web service containing utility functions available for merchants integrating with Checkout APIs.
## Authentication
Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/developers/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example:
Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example:
```
curl
@@ -15,7 +15,7 @@ info:
-H "X-API-Key: Your_Checkout_API_key" \
...
```
Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/developers/development-resources/live-endpoints).
Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).
## Versioning
Checkout API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.