spec release

yaml/PaymentService-v51.yaml

@@ -25,7 +25,7 @@ info:
     \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v51/authorise\n\
     ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\
     \ **API URLs** > **Prefix**."
-  x-timestamp: '2022-12-13T09:27:05Z'
+  x-timestamp: '2023-02-20T18:23:09Z'
   termsOfService: https://www.adyen.com/legal/terms-and-conditions
   contact:
     name: Adyen Developer Experience team
@@ -64,7 +64,7 @@ paths:
       operationId: post-adjustAuthorisation
       x-groupName: Modifications
       x-sortIndex: 6
-      x-methodName: changeTheAuthorisedAmount
+      x-methodName: adjustAuthorisation
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -142,7 +142,7 @@ paths:
       operationId: post-authorise
       x-groupName: General
       x-sortIndex: 1
-      x-methodName: createAuthorisation
+      x-methodName: authorise
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -229,7 +229,7 @@ paths:
       operationId: post-authorise3d
       x-groupName: General
       x-sortIndex: 2
-      x-methodName: complete3dsAuthorisation
+      x-methodName: authorise3d
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -305,7 +305,7 @@ paths:
       operationId: post-authorise3ds2
       x-groupName: General
       x-sortIndex: 3
-      x-methodName: complete3ds2Authorisation
+      x-methodName: authorise3ds2
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -383,7 +383,7 @@ paths:
       operationId: post-cancel
       x-groupName: Modifications
       x-sortIndex: 2
-      x-methodName: cancelAuthorisation
+      x-methodName: cancel
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -462,7 +462,7 @@ paths:
       operationId: post-cancelOrRefund
       x-groupName: Modifications
       x-sortIndex: 4
-      x-methodName: cancelOrRefundPayment
+      x-methodName: cancelOrRefund
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -553,7 +553,7 @@ paths:
       operationId: post-capture
       x-groupName: Modifications
       x-sortIndex: 1
-      x-methodName: captureAuthorisation
+      x-methodName: capture
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -632,7 +632,7 @@ paths:
       operationId: post-donate
       x-groupName: Modifications
       x-sortIndex: 6
-      x-methodName: createDonation
+      x-methodName: donate
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -701,7 +701,7 @@ paths:
       operationId: post-getAuthenticationResult
       x-groupName: General
       x-sortIndex: 4
-      x-methodName: getThe3dsAuthenticationResult
+      x-methodName: getAuthenticationResult
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -788,7 +788,7 @@ paths:
       operationId: post-refund
       x-groupName: Modifications
       x-sortIndex: 3
-      x-methodName: refundCapturedPayment
+      x-methodName: refund
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -860,7 +860,7 @@ paths:
       operationId: post-retrieve3ds2Result
       x-groupName: General
       x-sortIndex: 4
-      x-methodName: getThe3ds2AuthenticationResult
+      x-methodName: retrieve3ds2Result
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -935,7 +935,7 @@ paths:
       operationId: post-technicalCancel
       x-groupName: Modifications
       x-sortIndex: 5
-      x-methodName: cancelAuthorisationUsingYourReference
+      x-methodName: technicalCancel
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -1016,7 +1016,7 @@ paths:
       operationId: post-voidPendingRefund
       x-groupName: Modifications
       x-sortIndex: 7
-      x-methodName: cancelInpersonRefund
+      x-methodName: voidPendingRefund
       security:
       - BasicAuth: []
       - ApiKeyAuth: []
@@ -1256,6 +1256,7 @@ components:
         workPhone:
           description: Shopper's work phone number (including the country code).
           type: string
+      type: object
     AdditionalData3DSecure:
       properties:
         allow3DS2:
@@ -1317,6 +1318,7 @@ components:
             \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\
             \ the BIN is not enrolled, you will receive an error.\n\n"
           type: string
+      type: object
     AdditionalDataAirline:
       properties:
         airline.agency_invoice_number:
@@ -1598,6 +1600,7 @@ components:
           type: string
       required:
       - airline.passenger_name
+      type: object
     AdditionalDataCarRental:
       properties:
         carRental.checkOutDate:
@@ -1761,6 +1764,7 @@ components:
 
             * maxLength: 1'
           type: string
+      type: object
     AdditionalDataCommon:
       properties:
         RequestedTestErrorResponseCode:
@@ -1780,6 +1784,13 @@ components:
             \ the same idempotency key not be processed beyond returning the stored\
             \ response."
           type: string
+        allowPartialAuth:
+          description: "Set to true to authorise a part of the requested amount in\
+            \ case the cardholder does not have enough funds on their account. \n\
+            If a payment was partially authorised, the response includes resultCode:\
+            \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\
+            To enable this functionality, contact our Support Team."
+          type: string
         authorisationType:
           description: "Flags a card payment request for either pre-authorisation\
             \ or final authorisation. For more information, refer to [Authorisation\
@@ -1820,6 +1831,10 @@ components:
           - NoShow
           - DelayedCharge
           type: string
+        manualCapture:
+          description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture)
+            for the transaction.
+          type: string
         networkTxReference:
           description: 'Allows you to link the transaction to the original or previous
             one in a subscription/card-on-file chain. This field is required for token-based
@@ -1921,6 +1936,7 @@ components:
 
             * Fixed length: 11 or 14 characters.'
           type: string
+      type: object
     AdditionalDataLevel23:
       properties:
         enhancedSchemeData.customerReference:
@@ -2081,6 +2097,7 @@ components:
 
             > Required for Level 2 and Level 3 data.'
           type: string
+      type: object
     AdditionalDataLodging:
       properties:
         lodging.checkInDate:
@@ -2204,12 +2221,14 @@ components:
 
             * maxLength: 1'
           type: string
+      type: object
     AdditionalDataModifications:
       properties:
         installmentPaymentData.selectedInstallmentOption:
           description: This is the installment option selected by the shopper. It
             is required only if specified by the user.
           type: string
+      type: object
     AdditionalDataOpenInvoice:
       properties:
         openinvoicedata.merchantData:
@@ -2301,6 +2320,7 @@ components:
         openinvoicedataLine[itemNr].trackingUri:
           description: URI where the customer can track their shipment.
           type: string
+      type: object
     AdditionalDataOpi:
       properties:
         opi.includeTransToken:
@@ -2312,6 +2332,7 @@ components:
             You can store this Oracle Payment Interface token in your Oracle Opera
             database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
           type: string
+      type: object
     AdditionalDataRatepay:
       properties:
         ratepay.installmentAmount:
@@ -2340,6 +2361,7 @@ components:
           description: Identification name or number for the invoice, defined by the
             merchant.
           type: string
+      type: object
     AdditionalDataRetry:
       properties:
         retry.chainAttemptNumber:
@@ -2373,6 +2395,7 @@ components:
             and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference`
             to facilitate linking payment attempts together.'
           type: string
+      type: object
     AdditionalDataRisk:
       properties:
         riskdata.[customFieldName]:
@@ -2451,6 +2474,7 @@ components:
             checks for the payment request are skipped and the transaction will not
             get a risk score.
           type: string
+      type: object
     AdditionalDataRiskStandalone:
       properties:
         PayPal.CountryCode:
@@ -2510,6 +2534,7 @@ components:
           description: 'Required for PayPal payments only. The only supported value
             is: **paypal**.'
           type: string
+      type: object
     AdditionalDataSubMerchant:
       properties:
         subMerchant.numberOfSubSellers:
@@ -2587,6 +2612,7 @@ components:
 
             * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ'
           type: string
+      type: object
     AdditionalDataTemporaryServices:
       properties:
         enhancedSchemeData.customerReference:
@@ -2644,6 +2670,7 @@ components:
 
             * maxLength: 12'
           type: string
+      type: object
     AdditionalDataWallets:
       properties:
         androidpay.token:
@@ -2665,6 +2692,7 @@ components:
         visacheckout.callId:
           description: The Visa Checkout Call ID retrieved from the SDK.
           type: string
+      type: object
     Address:
       properties:
         city:
@@ -2705,6 +2733,7 @@ components:
       - city
       - postalCode
       - country
+      type: object
     AdjustAuthorisationRequest:
       properties:
         additionalData:
@@ -2791,6 +2820,7 @@ components:
       - merchantAccount
       - modificationAmount
       - originalReference
+      type: object
     Amount:
       properties:
         currency:
@@ -2805,6 +2835,7 @@ components:
       required:
       - value
       - currency
+      type: object
     ApplicationInfo:
       properties:
         adyenLibrary:
@@ -2831,6 +2862,7 @@ components:
           description: Shopper interaction device, such as terminal, mobile device
             or web browser, to initiate payment requests.
           $ref: '#/components/schemas/ShopperInteractionDevice'
+      type: object
     AuthenticationResultRequest:
       properties:
         merchantAccount:
@@ -2843,6 +2875,7 @@ components:
       required:
       - merchantAccount
       - pspReference
+      type: object
     AuthenticationResultResponse:
       properties:
         threeDS1Result:
@@ -2851,6 +2884,7 @@ components:
         threeDS2Result:
           description: The result of the 3D Secure 2 authentication.
           $ref: '#/components/schemas/ThreeDS2Result'
+      type: object
     BankAccount:
       properties:
         bankAccountNumber:
@@ -2899,12 +2933,11 @@ components:
           x-addedInVersion: '18'
           description: The bank account holder's tax ID.
           type: string
+      type: object
     BrowserInfo:
       properties:
         acceptHeader:
           description: The accept header value of the shopper's browser.
-          maxLength: 50
-          minLength: 10
           type: string
         colorDepth:
           x-addedInVersion: '40'
@@ -2948,8 +2981,6 @@ components:
           type: integer
         userAgent:
           description: The user agent value of the shopper's browser.
-          maxLength: 50
-          minLength: 10
           type: string
       required:
       - userAgent
@@ -2960,6 +2991,7 @@ components:
       - screenWidth
       - timeZoneOffset
       - language
+      type: object
     CancelOrRefundRequest:
       properties:
         additionalData:
@@ -3032,6 +3064,7 @@ components:
       required:
       - merchantAccount
       - originalReference
+      type: object
     CancelRequest:
       properties:
         additionalData:
@@ -3112,6 +3145,7 @@ components:
       required:
       - merchantAccount
       - originalReference
+      type: object
     CaptureRequest:
       properties:
         additionalData:
@@ -3198,6 +3232,7 @@ components:
       - merchantAccount
       - modificationAmount
       - originalReference
+      type: object
     Card:
       properties:
         cvc:
@@ -3262,10 +3297,9 @@ components:
           minLength: 4
           type: string
       required:
-      - number
-      - expiryMonth
       - expiryYear
       - holderName
+      type: object
     CommonField:
       properties:
         name:
@@ -3274,6 +3308,7 @@ components:
         version:
           description: Version of the field. For example, Version of External Platform.
           type: string
+      type: object
     DeviceRenderOptions:
       properties:
         sdkInterface:
@@ -3315,6 +3350,7 @@ components:
             - text
             type: string
           type: array
+      type: object
     DonationRequest:
       properties:
         donationAccount:
@@ -3350,6 +3386,7 @@ components:
       - merchantAccount
       - donationAccount
       - modificationAmount
+      type: object
     ExternalPlatform:
       properties:
         integrator:
@@ -3361,6 +3398,7 @@ components:
         version:
           description: Version of the field. For example, Version of External Platform.
           type: string
+      type: object
     ForexQuote:
       properties:
         account:
@@ -3404,6 +3442,7 @@ components:
       required:
       - validTill
       - basePoints
+      type: object
     FraudCheckResult:
       properties:
         accountScore:
@@ -3421,6 +3460,7 @@ components:
       - checkId
       - name
       - accountScore
+      type: object
     FraudResult:
       properties:
         accountScore:
@@ -3434,6 +3474,7 @@ components:
           type: array
       required:
       - accountScore
+      type: object
     Installments:
       properties:
         value:
@@ -3448,6 +3489,7 @@ components:
           type: integer
       required:
       - value
+      type: object
     Mandate:
       properties:
         amount:
@@ -3510,6 +3552,7 @@ components:
       - frequency
       - amount
       - endsAt
+      type: object
     MerchantDevice:
       properties:
         os:
@@ -3521,6 +3564,7 @@ components:
         reference:
           description: Merchant device reference.
           type: string
+      type: object
     MerchantRiskIndicator:
       properties:
         addressMatch:
@@ -3598,6 +3642,7 @@ components:
           description: Indicator for whether the shopper has already purchased the
             same items in the past.
           type: boolean
+      type: object
     ModificationResult:
       properties:
         additionalData:
@@ -3627,6 +3672,7 @@ components:
       required:
       - response
       - pspReference
+      type: object
     Name:
       properties:
         firstName:
@@ -3638,6 +3684,7 @@ components:
       required:
       - firstName
       - lastName
+      type: object
     PaymentRequest:
       properties:
         accountInfo:
@@ -3732,7 +3779,7 @@ components:
 
 
             Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
-          format: date-time
+          format: date
           type: string
         dccQuote:
           description: The forex quote as returned in the response of the forex service.
@@ -4016,6 +4063,7 @@ components:
       - merchantAccount
       - reference
       - amount
+      type: object
     PaymentRequest3d:
       properties:
         accountInfo:
@@ -4099,7 +4147,7 @@ components:
 
 
             Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
-          format: date-time
+          format: date
           type: string
         dccQuote:
           description: The forex quote as returned in the response of the forex service.
@@ -4371,6 +4419,7 @@ components:
       - merchantAccount
       - paResponse
       - md
+      type: object
     PaymentRequest3ds2:
       properties:
         accountInfo:
@@ -4454,7 +4503,7 @@ components:
 
 
             Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
-          format: date-time
+          format: date
           type: string
         dccQuote:
           description: The forex quote as returned in the response of the forex service.
@@ -4725,6 +4774,7 @@ components:
       - merchantAccount
       - reference
       - amount
+      type: object
     PaymentResult:
       properties:
         additionalData:
@@ -4845,6 +4895,7 @@ components:
           - Refused
           - Success
           type: string
+      type: object
     Recurring:
       properties:
         contract:
@@ -4882,6 +4933,7 @@ components:
           - VISATOKENSERVICE
           - MCTOKENSERVICE
           type: string
+      type: object
     RefundRequest:
       properties:
         additionalData:
@@ -4968,6 +5020,7 @@ components:
       - merchantAccount
       - modificationAmount
       - originalReference
+      type: object
     ResponseAdditionalData3DSecure:
       properties:
         cardHolderInfo:
@@ -4989,6 +5042,7 @@ components:
         threeds2.cardEnrolled:
           description: Indicates whether a card is enrolled for 3D Secure 2.
           type: boolean
+      type: object
     ResponseAdditionalDataBillingAddress:
       properties:
         billingAddress.city:
@@ -5020,6 +5074,7 @@ components:
         billingAddress.street:
           description: The billing address street passed in the payment request.
           type: string
+      type: object
     ResponseAdditionalDataCard:
       properties:
         cardBin:
@@ -5074,6 +5129,7 @@ components:
 
             Example: 52123423'
           type: string
+      type: object
     ResponseAdditionalDataCommon:
       properties:
         acquirerAccountCode:
@@ -5518,6 +5574,7 @@ components:
 
             Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
           type: string
+      type: object
     ResponseAdditionalDataInstallments:
       properties:
         installmentPaymentData.installmentType:
@@ -5569,6 +5626,7 @@ components:
 
             > Only relevant for card payments in countries that support installments.'
           type: string
+      type: object
     ResponseAdditionalDataNetworkTokens:
       properties:
         networkToken.available:
@@ -5582,6 +5640,7 @@ components:
         networkToken.tokenSummary:
           description: The last four digits of a network token.
           type: string
+      type: object
     ResponseAdditionalDataOpi:
       properties:
         opi.transToken:
@@ -5591,6 +5650,7 @@ components:
             tokenized ecommerce transactions. For more information and required settings,
             see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
           type: string
+      type: object
     ResponseAdditionalDataSepa:
       properties:
         sepadirectdebit.dateOfSignature:
@@ -5619,6 +5679,7 @@ components:
 
             Example: OOFF'
           type: string
+      type: object
     SDKEphemPubKey:
       properties:
         crv:
@@ -5633,6 +5694,7 @@ components:
         y:
           description: The `y` value as received from the 3D Secure 2 SDK.
           type: string
+      type: object
     ServiceError:
       properties:
         additionalData:
@@ -5659,6 +5721,7 @@ components:
           description: The HTTP response status.
           format: int32
           type: integer
+      type: object
     ShopperInteractionDevice:
       properties:
         locale:
@@ -5671,6 +5734,7 @@ components:
           description: Version of the operating system on the shopper interaction
             device.
           type: string
+      type: object
     Split:
       properties:
         account:
@@ -5718,6 +5782,7 @@ components:
       required:
       - amount
       - type
+      type: object
     SplitAmount:
       properties:
         currency:
@@ -5735,6 +5800,7 @@ components:
           type: integer
       required:
       - value
+      type: object
     TechnicalCancelRequest:
       properties:
         additionalData:
@@ -5809,6 +5875,7 @@ components:
       required:
       - merchantAccount
       - originalMerchantReference
+      type: object
     ThreeDS1Result:
       properties:
         cavv:
@@ -5830,6 +5897,7 @@ components:
           description: A unique transaction identifier generated by the MPI on behalf
             of the merchant to identify the 3D Secure transaction, in `Base64` encoding.
           type: string
+      type: object
     ThreeDS2RequestData:
       properties:
         acquirerBIN:
@@ -5991,6 +6059,7 @@ components:
           type: string
       required:
       - deviceChannel
+      type: object
     ThreeDS2Result:
       properties:
         authenticationValue:
@@ -6030,6 +6099,7 @@ components:
           x-addedInVersion: '49'
           description: The `whiteListStatus` value as defined in the 3D Secure 2 specification.
           type: string
+      type: object
     ThreeDS2ResultRequest:
       properties:
         merchantAccount:
@@ -6042,11 +6112,13 @@ components:
       required:
       - merchantAccount
       - pspReference
+      type: object
     ThreeDS2ResultResponse:
       properties:
         threeDS2Result:
           description: The result of the 3D Secure 2 authentication.
           $ref: '#/components/schemas/ThreeDS2Result'
+      type: object
     ThreeDSecureData:
       properties:
         authenticationResponse:
@@ -6103,6 +6175,7 @@ components:
             20 bytes in a decoded form).
           format: byte
           type: string
+      type: object
     VoidPendingRefundRequest:
       properties:
         additionalData:
@@ -6188,6 +6261,7 @@ components:
           type: string
       required:
       - merchantAccount
+      type: object
   securitySchemes:
     ApiKeyAuth:
       in: header