spec release

This commit is contained in:
Adyen Automation
2025-05-07 09:31:15 +02:00
parent 61333c82f2
commit 5d409085be
34 changed files with 2376 additions and 7016 deletions

View File

@@ -5963,7 +5963,7 @@ components:
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"allowedPaymentMethods":["ideal","giropay"]`'
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
items:
type: string
type: array
@@ -5993,7 +5993,7 @@ components:
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"blockedPaymentMethods":["ideal","giropay"]`'
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
items:
type: string
type: array
@@ -6476,23 +6476,6 @@ components:
- refused
type: string
type: object
DotpayDetails:
additionalProperties: false
properties:
issuer:
description: The Dotpay issuer value of the shopper's selected bank. Set
this to an **id** of a Dotpay issuer to preselect it.
type: string
type:
default: dotpay
description: '**dotpay**'
enum:
- dotpay
type: string
required:
- issuer
title: Dotpay
type: object
DragonpayDetails:
additionalProperties: false
properties:
@@ -6865,30 +6848,6 @@ components:
- issuer
title: Stored Payment Method
type: object
GiropayDetails:
additionalProperties: false
properties:
recurringDetailReference:
deprecated: true
x-deprecatedInVersion: '49'
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
description: This is the `recurringDetailReference` returned in the response
when you created the token.
type: string
storedPaymentMethodId:
x-addedInVersion: '49'
description: This is the `recurringDetailReference` returned in the response
when you created the token.
maxLength: 64
type: string
type:
default: giropay
description: '**giropay**'
enum:
- giropay
type: string
title: Giropay
type: object
GooglePayDetails:
additionalProperties: false
properties:
@@ -8092,7 +8051,6 @@ components:
- directEbanking
- boletobancario
- neteller
- paysafecard
- cashticket
- ikano
- karenmillen
@@ -8308,7 +8266,7 @@ components:
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"allowedPaymentMethods":["ideal","giropay"]`'
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
items:
type: string
type: array
@@ -8327,7 +8285,7 @@ components:
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"blockedPaymentMethods":["ideal","giropay"]`'
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
items:
type: string
type: array
@@ -8524,7 +8482,7 @@ components:
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"allowedPaymentMethods":["ideal","giropay"]`'
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
items:
type: string
type: array
@@ -8543,7 +8501,7 @@ components:
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"blockedPaymentMethods":["ideal","giropay"]`'
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
items:
type: string
type: array
@@ -8941,7 +8899,7 @@ components:
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"allowedPaymentMethods":["ideal","giropay"]`'
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
items:
type: string
type: array
@@ -8956,7 +8914,7 @@ components:
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
Example: `"blockedPaymentMethods":["ideal","giropay"]`'
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
items:
type: string
type: array
@@ -9052,9 +9010,7 @@ components:
x-addedInVersion: '49'
description: List of all stored payment methods.
items:
oneOf:
- $ref: '#/components/schemas/PixStoredPaymentMethod'
- $ref: '#/components/schemas/StoredPaymentMethod'
$ref: '#/components/schemas/StoredPaymentMethod'
type: array
type: object
PaymentRefundRequest:
@@ -9493,14 +9449,12 @@ components:
- $ref: '#/components/schemas/CashAppDetails'
- $ref: '#/components/schemas/CellulantDetails'
- $ref: '#/components/schemas/DokuDetails'
- $ref: '#/components/schemas/DotpayDetails'
- $ref: '#/components/schemas/DragonpayDetails'
- $ref: '#/components/schemas/EBankingFinlandDetails'
- $ref: '#/components/schemas/EcontextVoucherDetails'
- $ref: '#/components/schemas/EftDetails'
- $ref: '#/components/schemas/FastlaneDetails'
- $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails'
- $ref: '#/components/schemas/GiropayDetails'
- $ref: '#/components/schemas/GooglePayDetails'
- $ref: '#/components/schemas/IdealDetails'
- $ref: '#/components/schemas/KlarnaDetails'
@@ -9583,7 +9537,7 @@ components:
description: "The URL to return to in case of a redirection.\nThe format\
\ depends on the channel. \n* For web, include the protocol `http://`\
\ or `https://`. You can also include your own additional query parameters,\
\ for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n\
\ for example, shopper ID or order reference number.\nExample: `https://your-company.example.com/checkout?shopperOrder=12xy`\n\
* For iOS, use the custom URL for your app. To know more about setting\
\ custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\n\
Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\
@@ -10075,52 +10029,6 @@ components:
type: string
title: pixRecurring
type: object
PixStoredPaymentMethod:
additionalProperties: false
properties:
bankAccountNumber:
description: The bank account number (without separators).
type: string
bankLocationId:
description: The location id of the bank. The field value is `nil` in most
cases.
type: string
brand:
description: The brand of the card.
type: string
expiryMonth:
description: The two-digit month when the card expires
type: string
expiryYear:
description: The year the card expires, for example **2022**.
type: string
holderName:
description: The unique payment method code.
type: string
id:
description: A unique identifier of this stored payment method.
type: string
lastFour:
description: The last four digits of the PAN.
type: string
name:
description: The display name of the stored payment method.
type: string
shopperEmail:
description: "The shopper\u2019s email address."
type: string
supportedShopperInteractions:
description: The supported shopper interactions for this stored payment
method.
items:
type: string
type: array
type:
description: The type of payment method.
enum:
- pix
type: string
type: object
PlatformChargebackLogic:
additionalProperties: false
properties:
@@ -10650,6 +10558,16 @@ components:
- GREEN
- FRAUD
type: string
fraudRiskLevel:
description: The risk level of the payment as determined by the FDM machine
learning model.
enum:
- Very low
- Low
- Medium
- High
- Very high
type: string
fundingSource:
description: 'Information regarding the funding type of the card. The possible
return values are:
@@ -11534,6 +11452,7 @@ components:
- dana
- kakaopay
- truemoney
- paysafecard
type: string
title: Stored Payment Method
type: object
@@ -12457,7 +12376,7 @@ components:
errorType: configuration
pspReference: '8516091485743033'
get-paymentLinks-linkId-basic-200:
summary: List of available payment methods
summary: Payment link details
value:
amount:
currency: EUR
@@ -13260,78 +13179,6 @@ components:
type: text
name: DOKU wallet
type: doku_wallet
- details:
- items:
- id: '66'
name: Bank Nowy BFG S.A.
- id: '92'
name: "Bank Sp\xF3\u0142dzielczy w Brodnicy"
- id: '11'
name: Bank transfer / postal
- id: '74'
name: "Banki Sp\xF3\u0142dzielcze"
- id: '73'
name: BLIK
- id: '90'
name: "BNP Paribas - p\u0142ac\u0119 z Pl@net"
- id: '59'
name: CinkciarzPAY
- id: '87'
name: Credit Agricole PBL
- id: '83'
name: EnveloBank
- id: '76'
name: Getin Bank PBL
- id: '81'
name: Idea Cloud
- id: '7'
name: ING Corporate customers
- id: '93'
name: Kasa Stefczyka
- id: '44'
name: "Millennium - P\u0142atno\u015Bci Internetowe"
- id: '10'
name: Millennium Corporate customers
- id: '68'
name: mRaty
- id: '1'
name: mTransfer
- id: '91'
name: Nest Bank
- id: '80'
name: Noble Pay
- id: '50'
name: Pay Way Toyota Bank
- id: '45'
name: Pay with Alior Bank
- id: '36'
name: Pekao24Przelew
- id: '70'
name: Pocztowy24
- id: '6'
name: Przelew24
- id: '46'
name: "P\u0142ac\u0119 z Citi Handlowy"
- id: '38'
name: "P\u0142ac\u0119 z ING"
- id: '2'
name: "P\u0142ac\u0119 z Inteligo"
- id: '4'
name: "P\u0142ac\u0119 z iPKO"
- id: '75'
name: "P\u0142ac\u0119 z Plus Bank"
- id: '51'
name: "P\u0142a\u0107 z BO\u015A"
- id: '55'
name: Raty z Alior Bankiem PLN
- id: '89'
name: Santander
- id: '52'
name: SkyCash
key: issuer
type: select
name: Local Polish Payment Methods
type: dotpay
- name: Dragonpay Prepaid Credits
type: dragonpay_credits
- name: Online Banking
@@ -14825,7 +14672,7 @@ components:
paymentMethod:
type: applepay
applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YOUR_MERCHANT_ACCOUNT
post-payments-card-3d-secure-2-web:
summary: Make a card payment with 3D Secure 2 native authentication
@@ -14865,8 +14712,8 @@ components:
timeZoneOffset: 0
javaEnabled: true
channel: Web
origin: https://your-company.com
returnUrl: https://your-company.com/checkout/
origin: https://your-company.example.com
returnUrl: https://your-company.example.com/checkout/
merchantAccount: YOUR_MERCHANT_ACCOUNT
post-payments-card-3d-secure-2-web-200:
summary: Successful card payment with 3D Secure 2 native authentication
@@ -14906,7 +14753,7 @@ components:
Firefox/3.0
acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
javaEnabled: true
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YOUR_MERCHANT_ACCOUNT
post-payments-card-3d-secure-direct-200:
summary: Successful card payment with 3D Secure redirect authentication
@@ -14968,7 +14815,7 @@ components:
expiryYear: '2030'
holderName: John Smith
cvc: '737'
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YOUR_MERCHANT_ACCOUNT
post-payments-card-direct-200:
summary: Successful card payment
@@ -15072,7 +14919,7 @@ components:
storePaymentMethod: true
shopperInteraction: Ecommerce
recurringProcessingModel: CardOnFile
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YOUR_MERCHANT_ACCOUNT
post-payments-enableOneClick-raw-200:
summary: Card details tokenized for one-off payments
@@ -15101,7 +14948,7 @@ components:
paymentMethod:
type: paywithgoogle
googlePayToken: ==Payload as retrieved from Google Pay response==
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YourMerchantAccount
post-payments-ideal:
summary: Make an iDEAL payment
@@ -15112,7 +14959,7 @@ components:
reference: Your order number
paymentMethod:
type: ideal
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YOUR_MERCHANT_ACCOUNT
post-payments-ideal-200:
summary: Successful iDEAL payment
@@ -15187,7 +15034,7 @@ components:
storedPaymentMethodId: '8416038790273850'
cvc: '737'
shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YOUR_MERCHANT_ACCOUNT
post-payments-oneclick-securedfields:
summary: Make a one-off payment with a token and CVV, using encrypted card details
@@ -15201,7 +15048,7 @@ components:
recurringDetailReference: '8416038790273850'
encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH...
shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YOUR_MERCHANT_ACCOUNT
post-payments-paymentPspReference-amountUpdates-amount-update:
summary: Update the amount of an authorized payment
@@ -15403,7 +15250,7 @@ components:
type: scheme
storedPaymentMethodId: '8316038796685850'
shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YOUR_MERCHANT_ACCOUNT
shopperInteraction: ContAuth
recurringProcessingModel: Subscription
@@ -15509,7 +15356,7 @@ components:
currency: EUR
reference: YOUR_ORDER_NUMBER
merchantAccount: YOUR_MERCHANT_ACCOUNT
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
splits:
- amount:
value: 6000
@@ -15536,7 +15383,7 @@ components:
holderName: John Smith
cvc: '737'
shopperReference: YOUR_SHOPPER_REFERENCE
returnUrl: https://your-company.com/...
returnUrl: https://your-company.example.com/...
merchantAccount: YOUR_MERCHANT_ACCOUNT
storePaymentMethod: true
shopperInteraction: Ecommerce