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

A new version of the Checkout OpenAPI spec

Browse Source
This commit is contained in:
Aleksei Akimov
2018-03-27 15:02:53 +02:00
committed by GitHub
parent 90db6835bb
commit fc7b60e3ed
1 changed files with 576 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

637
specs/2.0/CheckoutService-V32.yaml
View File

@@ -2,7 +2,29 @@ swagger: '2.0'
info:
version: '32'
title: Adyen Checkout Service
description: 'A web service to initiate and authorise payments with Adyen Checkout. You can use the same integration for payments made with cards (including One-Click and 3D Secure), mobile wallets, and local payment methods (e.g. iDEAL and Sofort). For more information, refer to [Checkout documentation](https://docs.adyen.com/developers/checkout).'
description: |-
Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including One-Click and 3D Secure), mobile wallets, and local payment methods (e.g. iDEAL and Sofort).
This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/developers/checkout).
## Authentication
Each request to the Checkout 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 Checkout API key](https://docs.adyen.com/developers/user-management/how-to-get-the-checkout-api-key). Then set this key to the `X-API-Key` header value, for example:
```
curl
-H "Content-Type: application/json" \
-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/api-reference/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.
For example:
```
https://checkout-test.adyen.com/services/PaymentSetupAndVerification/v32/setup
```
host: checkout-test.adyen.com
basePath: /services/PaymentSetupAndVerification/v32
schemes:
@@ -12,16 +34,106 @@ produces:
consumes:
- application/json
x-groups:
- General
- SDK Integration
- API Integration
paths:
/paymentMethods:
post:
summary: Returns 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.
x-groupName: API Integration
x-sortIndex: 1
parameters:
- name: request
in: body
schema:
$ref: '#/definitions/PaymentMethodsRequest'
responses:
'200':
description: OK - the request has succeeded.
schema:
$ref: '#/definitions/PaymentMethodsResponse'
'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.
/payments:
post:
summary: Starts a transaction.
description: |-
Sends payment parameters (like amount, country, and currency) together with the input details collected from the shopper. The response returns the result of the payment request:
* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. `authorised` or `refused`).
* For other payment methods, you'll receive `redirectShopper` as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.
x-groupName: API Integration
x-sortIndex: 2
parameters:
- name: request
in: body
schema:
$ref: '#/definitions/PaymentRequest'
responses:
'200':
description: OK - the request has succeeded.
schema:
$ref: '#/definitions/PaymentResponse'
'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.
/payments/details:
post:
summary: Submits details for a payment.
description: |-
Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request (for example for 3D Secure, or when getting redirected back directly from a payment method using an app switch).
The exact details, which need to be sent to this endpoint, are always specified in the response of the associated `/payments` request. When sending in the request to `/payments/details`, make sure you send the corresponding `paymentData` as obtained during the `/payments` call.
In addition, the endpoint can be used to verify a `payload`, which is returned after coming back from the Checkout SDK or any of the redirect based methods on the Checkout API.
x-groupName: API Integration
x-sortIndex: 3
parameters:
- name: request
in: body
schema:
$ref: '#/definitions/DetailsRequest'
responses:
'200':
description: OK - the request has succeeded.
schema:
$ref: '#/definitions/PaymentResponse'
'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.
/setup:
post:
summary: Creates a payment setup
summary: Creates a payment setup.
description: |-
Provides the data object that can be used to start the Checkout SDK. For the initial payment setup, pass the payment amount, currency, and other information that can be used by Adyen to optimize the payment flow and perform better risk assessment of the transaction.
Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.
For more information, refer to [Set up a payment](https://docs.adyen.com/developers/checkout/implement-your-server-checkout/set-up-a-payment-checkout).
x-groupName: General
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).
x-groupName: SDK Integration
x-sortIndex: 1
parameters:
- name: request
@@ -45,12 +157,12 @@ paths:
description: Internal Server Error - the server could not process the request.
/verify:
post:
summary: Verifies payment result
summary: Verifies payment result.
description: |-
Verifies the payment result using the payload returned from the SDK.
For more information, refer to [Verify a payment](https://docs.adyen.com/developers/checkout/implement-your-server-checkout/verify-a-payment-checkout).
x-groupName: General
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).
x-groupName: SDK Integration
x-sortIndex: 2
parameters:
- name: request
@@ -76,29 +188,37 @@ definitions:
Address:
properties:
city:
description: The city name.
description: |-
The name of the city.
>Required if either houseNumberOrName, street, postalCode, or stateOrProvince are provided.
type: string
country:
description: A valid value is an ISO two-character country code (e.g. 'NL').
description: |-
The two-character country code of the address
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
type: string
houseNumberOrName:
description: The house number or name.
description: The number or name of the house.
type: string
postalCode:
description: The postal code with a maximum of 5 characters for USA and maximum of 10 characters for any other country.
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.
type: string
stateOrProvince:
description: 'For USA or Canada, a valid 2-character abbreviation for the state or province respectively. For other countries any abbreviation with maximum 3 characters for the state or province.'
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.
type: string
street:
description: |
The street name.
> Don't append the house number to this field. Instead, pass the house number separately as `houseNumberOrName`.
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.
type: string
required:
- street
- houseNumberOrName
- city
- country
Amount:
properties:
@@ -120,8 +240,20 @@ definitions:
Avs:
properties:
addressEditable:
description: Indicates whether the shopper is allowed to modify the billing address for the current payment request.
type: boolean
enabled:
description: |-
Specifies whether the shopper should enter their billing address during checkout.
Allowed values:
* yes — Perform AVS checks for every card payment.
* automatic — Perform AVS checks only when required to optimize the conversion rate.
* no — Do not perform AVS checks.
enum:
- 'yes'
- 'no'
- automatic
type: string
BankAccount:
properties:
@@ -242,17 +374,50 @@ definitions:
- expiryMonth
- expiryYear
- holderName
Collection: {}
Company:
properties:
homepage:
description: The company website's home page.
type: string
name:
description: The company name.
type: string
registrationNumber:
description: Registration number of the company.
type: string
registryLocation:
description: Registry location of the company.
type: string
taxId:
description: Tax ID of the company.
type: string
type:
description: The company type.
type: string
Configuration:
properties:
avs:
description: 'Describes the configuration for AVS ([Address Verification System](https://en.wikipedia.org/wiki/Address_Verification_System)).'
$ref: '#/definitions/Avs'
cardHolderNameRequired:
description: 'When set to true, the shopper has to provide the cardholder name for card payments.'
type: boolean
installments:
description: 'Describes the configuration for [installment payments](https://docs.adyen.com/developers/payment-methods/installment-payments).'
$ref: '#/definitions/Installments'
DetailsRequest:
properties:
details:
additionalProperties:
type: string
description: Use this collection to submit the details that were returned as a result of the `/payments` call.
type: object
paymentData:
description: The `paymentData` value that you received in the response to the `/payments` call.
type: string
required:
- details
- paymentData
ForexQuote:
properties:
account:
@@ -296,6 +461,23 @@ definitions:
required:
- validTill
- basePoints
FraudCheckResult:
properties:
accountScore:
description: The fraud score generated by the risk check.
format: int32
type: integer
checkId:
description: The ID of the risk check.
format: int32
type: integer
name:
description: The name of the risk check.
type: string
required:
- checkId
- name
- accountScore
FraudResult:
properties:
accountScore:
@@ -304,7 +486,9 @@ definitions:
type: integer
results:
description: The result of the individual risk checks.
type: object
items:
$ref: '#/definitions/FraudCheckResult'
type: array
required:
- accountScore
InputDetail:
@@ -314,8 +498,8 @@ definitions:
type: string
description: Configuration parameters for the required input.
type: object
inputDetails:
description: 'In case of address data, inputDetails can be set recursively.'
details:
description: Input details can also be provided recursively.
items:
$ref: '#/definitions/SubInputDetail'
type: array
@@ -353,21 +537,59 @@ definitions:
Item:
properties:
id:
description: value to provide in the result
description: The value to provide in the result.
type: string
imageUrl:
description: optional image URL
description: The image URL (optional).
type: string
name:
description: display name
description: The display name.
type: string
LineItem:
properties:
amountExcludingTax:
description: 'Item amount excluding the tax, in minor units.'
format: int64
type: integer
amountIncludingTax:
description: 'Item amount including the tax, in minor units.'
format: int64
type: integer
description:
description: Description of the line item.
type: string
id:
description: ID of the line item.
type: string
quantity:
description: Number of items.
format: int64
type: integer
taxAmount:
description: 'Tax amount, in minor units.'
format: int64
type: integer
taxCategory:
description: 'Tax category: High, Low, None, Zero'
enum:
- High
- Low
- None
- Zero
type: string
taxPercentage:
description: 'Tax percentage, in minor units.'
format: int64
type: integer
Name:
properties:
firstName:
description: A person's first name.
description: The first name.
type: string
gender:
description: A person's gender (can be unknown).
description: |-
The gender.
>The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`.
enum:
- MALE
- FEMALE
@@ -376,10 +598,12 @@ definitions:
minLength: 1
type: string
infix:
description: 'A person name''s infix, if applicable. Maximum length: 20 characters.'
description: |-
The name's infix, if applicable.
>A maximum length of twenty (20) characters is imposed.
type: string
lastName:
description: A person's last name.
description: The last name.
type: string
required:
- firstName
@@ -413,21 +637,21 @@ definitions:
configuration:
additionalProperties:
type: string
description: The configuration.
description: The configuration of the payment method.
type: object
group:
description: The group where this payment method belongs to.
$ref: '#/definitions/PaymentMethodGroup'
inputDetails:
details:
description: All input details to be provided to complete the payment with this payment method.
items:
$ref: '#/definitions/InputDetail'
type: array
group:
description: The group where this payment method belongs to.
$ref: '#/definitions/PaymentMethodGroup'
name:
description: The displayable name of this payment method.
type: string
paymentMethodData:
description: echo data required to send in next calls.
description: Echo data required to send in next calls.
type: string
type:
description: The unique payment method code.
@@ -443,6 +667,258 @@ definitions:
type:
description: The unique code of the group.
type: string
PaymentMethodsRequest:
properties:
amount:
description: 'The amount information for the transaction. For [BIN or card verification](https://docs.adyen.com/developers/ecommerce-integration/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).'
$ref: '#/definitions/Amount'
channel:
description: The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms.
enum:
- iOS
- Android
- Web
type: string
countryCode:
description: The shopper's country code.
type: string
merchantAccount:
description: 'The merchant account identifier, with which you want to process the transaction.'
type: string
shopperLocale:
description: The combination of a language code and a country code to specify the language to be used in the payment.
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:
- merchantAccount
PaymentMethodsResponse:
properties:
oneClickPaymentMethods:
description: Detailed list of one-click payment methods.
items:
$ref: '#/definitions/RecurringDetail'
type: array
paymentMethods:
description: Detailed list of payment methods required to generate payment forms.
items:
$ref: '#/definitions/PaymentMethod'
type: array
PaymentRequest:
properties:
additionalData:
additionalProperties:
type: string
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. For more information on possible key-value pairs, refer to the [additionalData section](https://docs.adyen.com/developers/api-reference/payments-api#paymentrequestadditionaldata).
type: object
amount:
description: 'The amount information for the transaction. For [BIN or card verification](https://docs.adyen.com/developers/ecommerce-integration/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).'
$ref: '#/definitions/Amount'
billingAddress:
description: The address where to send the invoice.
$ref: '#/definitions/Address'
captureDelayHours:
description: 'The delay between the authorisation and scheduled auto-capture, specified in hours.'
format: int32
type: integer
channel:
description: 'The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the sdkVersion or token.'
enum:
- iOS
- Android
- Web
type: string
countryCode:
description: |-
The shopper country.
Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
Example: NL or DE
type: string
dateOfBirth:
description: |-
The shopper's date of birth.
Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
format: date-time
type: string
dccQuote:
description: The forex quote as returned in the response of the forex service.
$ref: '#/definitions/ForexQuote'
deliveryAddress:
description: The address where the purchased goods should be delivered.
$ref: '#/definitions/Address'
deliveryDate:
description: |-
The date and time the purchased goods should be delivered.
Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
Example: 2017-07-17T13:42:40.428+01:00
format: date-time
type: string
enableOneClick:
description: 'When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.'
type: boolean
enablePayOut:
description: 'When true and `shopperReference` is provided, the payment details will be tokenized for payouts.'
type: boolean
enableRecurring:
description: 'When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.'
type: boolean
entityType:
description: The type of the entity the payment is processed for.
enum:
- NaturalPerson
- CompanyName
type: string
fraudOffset:
description: An integer value that is added to the normal fraud score. The value can be either positive or negative.
format: int32
type: integer
installments:
description: 'Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/developers/payment-methods/installment-payments).'
$ref: '#/definitions/Installments'
lineItems:
description: Line items regarding the payment.
items:
$ref: '#/definitions/LineItem'
type: array
mcc:
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:
description: |-
This reference allows linking multiple transactions to each other.
> When providing the `merchantOrderReference` value, we also recommend you submit `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values.
type: string
metadata:
additionalProperties:
type: string
description: |-
Metadata consists of entries, each of which includes a key and a value.
Limitations: Error "177", "Metadata size exceeds limit"
type: object
orderReference:
description: The order reference to link multiple partial payments.
type: string
paymentMethod:
additionalProperties:
type: string
description: The collection that contains the type of the payment method and its specific information (e.g. `idealIssuer`).
type: object
reference:
description: |-
The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.
If you need to provide multiple references for a transaction, separate them with hyphens ("-").
Maximum length: 80 characters.
type: string
returnUrl:
description: The URL to return to.
type: string
sessionValidity:
description: The maximum validity of the session.
type: string
shopperEmail:
description: 'The shopper''s email address. We recommend that you provide this data, as it is used in velocity fraud checks.'
type: string
shopperIP:
description: |-
The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).
> This field is mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).
type: string
shopperInteraction:
description: |-
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
For the web service API, Adyen assumes Ecommerce shopper interaction by default.
This field has the following possible values:
* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.
* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).
* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.
* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
enum:
- Ecommerce
- ContAuth
- Moto
- POS
type: string
shopperLocale:
description: The combination of a language code and a country code to specify the language to be used in the payment.
type: string
shopperName:
description: The shopper's full name and gender (if specified).
$ref: '#/definitions/Name'
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
shopperStatement:
description: The text to appear on the shopper's bank statement.
type: string
socialSecurityNumber:
description: The shopper's social security number.
type: string
telephoneNumber:
description: The shopper's telephone number.
type: string
required:
- merchantAccount
- reference
- amount
- returnUrl
- paymentMethod
PaymentResponse:
properties:
additionalData:
additionalProperties:
type: string
description: 'This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Settings** > **API and Response**.'
type: object
details:
description: 'When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.'
items:
$ref: '#/definitions/InputDetail'
type: array
fraudResult:
description: The fraud result properties of the payment.
$ref: '#/definitions/FraudResult'
paymentData:
description: 'When non-empty, contains a value that you must submit to the `/payments/details` endpoint.'
type: string
pspReference:
description: Adyen's 16-digit unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.
type: string
redirect:
description: 'When the payment flow requires a redirect, this object contains information about the redirect URL.'
$ref: '#/definitions/Redirect'
refusalReason:
description: |-
If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error.
When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.
type: string
resultCode:
description: The result of the payment.
enum:
- Authorised
- PartiallyAuthorised
- Refused
- Error
- Cancelled
- Received
- RedirectShopper
type: string
PaymentSetupRequest:
properties:
additionalData:
@@ -464,7 +940,7 @@ definitions:
format: int32
type: integer
channel:
description: The platform where a payment transaction takes place. This field is required for filtering out payment methods that are only available on specific platforms.
description: 'The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the sdkVersion or token.'
enum:
- iOS
- Android
@@ -505,8 +981,11 @@ definitions:
enableOneClick:
description: 'When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.'
type: boolean
enablePayOut:
description: 'When true and `shopperReference` is provided, the payment details will be tokenized for payouts.'
type: boolean
enableRecurring:
description: 'When true and `shopperReference` is provided, ''Recurring'' will be added to the recurring contract.'
description: 'When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.'
type: boolean
entityType:
description: The type of the entity the payment is processed for.
@@ -527,6 +1006,11 @@ definitions:
installments:
description: 'Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/developers/payment-methods/installment-payments).'
$ref: '#/definitions/Installments'
lineItems:
description: Line items regarding the payment.
items:
$ref: '#/definitions/LineItem'
type: array
mcc:
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
@@ -572,7 +1056,7 @@ definitions:
shopperIP:
description: |-
The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).
> This field is mandatory for some merchants depending on your business model. Contact Adyen Support for more information.
> This field is mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).
type: string
shopperInteraction:
description: |-
@@ -620,6 +1104,8 @@ definitions:
- merchantAccount
- reference
- amount
- returnUrl
- countryCode
- channel
PaymentSetupResponse:
properties:
@@ -638,6 +1124,11 @@ definitions:
logoBaseUrl:
description: The base URL for payment method logos.
type: string
oneClickPaymentMethods:
description: The detailed list of stored payment details required to generate payment forms. Will be empty if `enableOneClick` is set to false in the request.
items:
$ref: '#/definitions/RecurringDetail'
type: array
origin:
description: The user origin.
type: string
@@ -661,11 +1152,6 @@ definitions:
publicKeyToken:
description: The public key token.
type: string
recurringDetails:
description: The detailed list of stored payment details required to generate payment forms. Will be empty if oneClick is set to false in the request.
items:
$ref: '#/definitions/RecurringDetail'
type: array
PaymentVerificationRequest:
properties:
payload:
@@ -699,7 +1185,7 @@ definitions:
description: The fraud result properties of the payment.
$ref: '#/definitions/FraudResult'
merchantReference:
description: A unique value that you provided in the initial /setup request as a `reference` field.
description: A unique value that you provided in the initial `/paymentSession` request as a `reference` field.
type: string
pspReference:
description: Adyen's 16-digit unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.
@@ -730,9 +1216,10 @@ definitions:
description: |-
The type of recurring contract to be used.
Possible values:
* `ONECLICK` – The shopper opts to store their card details for future use. The shopper is present for the subsequent transaction, for cards the security code (CVC/CVV) is required.
* `RECURRING` – Payment details are stored for future use. For cards, the security code (CVC/CVV) is not required for subsequent payments. This is used for shopper not present transactions.
* `ONECLICK,RECURRING` – Payment details are stored for future use. This allows the use of the stored payment details regardless of whether the shopper is on your site or not.
* `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/developers/payment-glossary#cardsecuritycodecvccvvcid).
* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/developers/payment-glossary#cardnotpresentcnp).
* `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/developers/features/third-party-payouts).
enum:
- ONECLICK
- RECURRING
@@ -745,37 +1232,65 @@ definitions:
description: The name of the token service.
enum:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
RecurringDetail:
properties:
bank:
$ref: '#/definitions/BankAccount'
card:
$ref: '#/definitions/Card'
configuration:
additionalProperties:
type: string
description: The configuration.
description: The configuration of the payment method.
type: object
emailAddress:
type: string
group:
description: The group where this payment method belongs to.
$ref: '#/definitions/PaymentMethodGroup'
inputDetails:
details:
description: All input details to be provided to complete the payment with this payment method.
items:
$ref: '#/definitions/InputDetail'
type: array
group:
description: The group where this payment method belongs to.
$ref: '#/definitions/PaymentMethodGroup'
name:
description: The displayable name of this payment method.
type: string
paymentMethodData:
description: echo data required to send in next calls.
description: Echo data required to send in next calls.
type: string
storedDetails:
description: Contains information on previously stored payment details.
$ref: '#/definitions/StoredDetails'
type:
description: The unique payment method code.
type: string
Redirect:
properties:
data:
additionalProperties:
type: string
description: 'When the redirect URL must be accessed via POST, use this data to post to the redirect URL.'
type: object
method:
description: |-
The web method that you must use to access the redirect URL.
Possible values: GET, POST.
enum:
- GET
- POST
type: string
url:
description: 'The URL, to which you must redirect a shopper to complete a payment.'
type: string
StoredDetails:
properties:
bank:
description: The stored bank account.
$ref: '#/definitions/BankAccount'
card:
description: The stored card information.
$ref: '#/definitions/Card'
emailAddress:
description: The email associated with stored payment details.
type: string
SubInputDetail:
properties:
key: