diff --git a/yaml/AccountService-v3.yaml b/yaml/AccountService-v3.yaml index a2a7d796..83fa67ac 100644 --- a/yaml/AccountService-v3.yaml +++ b/yaml/AccountService-v3.yaml @@ -62,6 +62,8 @@ x-groups: paths: /closeAccount: post: + tags: + - Accounts summary: Close an account. description: Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed @@ -98,8 +100,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -113,8 +115,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -132,6 +134,8 @@ paths: description: Internal Server Error - the server could not process the request. /closeAccountHolder: post: + tags: + - Account holders summary: Close an account holder. description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't @@ -170,8 +174,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -185,8 +189,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -204,6 +208,8 @@ paths: description: Internal Server Error - the server could not process the request. /createAccount: post: + tags: + - Accounts summary: Create a new account. description: Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#create-additional-accounts). @@ -239,8 +245,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -254,8 +260,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -273,6 +279,8 @@ paths: description: Internal Server Error - the server could not process the request. /createAccountHolder: post: + tags: + - Account holders summary: Create a new account holder. description: Creates an account holder, which [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) @@ -300,10 +308,10 @@ paths: content: application/json: examples: - business-200: - $ref: '#/components/examples/post-createAccountHolder-business-200' - individual-200: - $ref: '#/components/examples/post-createAccountHolder-individual-200' + business: + $ref: '#/components/examples/post-createAccountHolder-business' + individual: + $ref: '#/components/examples/post-createAccountHolder-individual' schema: $ref: '#/components/schemas/CreateAccountHolderResponse' description: OK - the request has succeeded. @@ -311,8 +319,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -320,8 +328,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/post-createAccountHolder-generic-401' + generic: + $ref: '#/components/examples/post-createAccountHolder-generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -329,8 +337,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -338,10 +346,10 @@ paths: content: application/json: examples: - business-422: - $ref: '#/components/examples/post-createAccountHolder-business-422' - individual-422: - $ref: '#/components/examples/post-createAccountHolder-individual-422' + business: + $ref: '#/components/examples/post-createAccountHolder-business' + individual: + $ref: '#/components/examples/post-createAccountHolder-individual' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -349,13 +357,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/post-createAccountHolder-generic-500' + generic: + $ref: '#/components/examples/post-createAccountHolder-generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /deleteBankAccounts: post: + tags: + - Verification summary: Delete bank accounts. description: 'Deletes one or more bank accounts of an account holder. ' operationId: post-deleteBankAccounts @@ -390,8 +400,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -405,8 +415,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -424,6 +434,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteShareholders: post: + tags: + - Verification summary: Delete shareholders. description: Deletes one or more shareholders from an account holder. operationId: post-deleteShareholders @@ -458,8 +470,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -473,8 +485,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -492,6 +504,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteSignatories: post: + tags: + - Verification summary: Delete signatories. description: Deletes one or more signatories from an account holder. operationId: post-deleteSignatories @@ -523,8 +537,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -538,8 +552,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -557,6 +571,8 @@ paths: description: Internal Server Error - the server could not process the request. /getAccountHolder: post: + tags: + - Account holders summary: Get an account holder. description: Retrieves the details of an account holder. operationId: post-getAccountHolder @@ -593,8 +609,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -608,8 +624,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -627,6 +643,8 @@ paths: description: Internal Server Error - the server could not process the request. /getTaxForm: post: + tags: + - Account holders summary: Get a tax form. description: Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/platforms/tax-forms). @@ -655,8 +673,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -670,8 +688,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -689,6 +707,8 @@ paths: description: Internal Server Error - the server could not process the request. /getUploadedDocuments: post: + tags: + - Verification summary: Get documents. description: 'Retrieves documents that were previously uploaded for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks). @@ -719,8 +739,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -734,8 +754,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -753,6 +773,8 @@ paths: description: Internal Server Error - the server could not process the request. /suspendAccountHolder: post: + tags: + - Account holders summary: Suspend an account holder. description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**. @@ -788,8 +810,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -803,8 +825,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -822,6 +844,8 @@ paths: description: Internal Server Error - the server could not process the request. /unSuspendAccountHolder: post: + tags: + - Account holders summary: Unsuspend an account holder. description: 'Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. Account holders can have a **Suspended** @@ -863,8 +887,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -878,8 +902,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -897,6 +921,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccount: post: + tags: + - Accounts summary: Update an account. description: Updates the description or payout schedule of an account. operationId: post-updateAccount @@ -931,8 +957,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -946,8 +972,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -965,6 +991,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolder: post: + tags: + - Account holders summary: Update an account holder. description: "Updates the `accountHolderDetails` and `processingTier` of an\ \ account holder, and adds bank accounts and shareholders.\n\nWhen updating\ @@ -1018,8 +1046,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1033,8 +1061,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1052,6 +1080,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolderState: post: + tags: + - Account holders summary: Update payout or processing state. description: Disables or enables the processing or payout state of an account holder. @@ -1087,8 +1117,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1102,8 +1132,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1121,6 +1151,8 @@ paths: description: Internal Server Error - the server could not process the request. /uploadDocument: post: + tags: + - Verification summary: Upload a document. description: Uploads a document for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks). @@ -1156,8 +1188,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1171,8 +1203,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1284,6 +1316,9 @@ components: > 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 + principalBusinessAddress: + description: The principal business address of the account holder. + $ref: '#/components/schemas/ViasAddress' webAddress: description: The URL of the website of the account holder. type: string @@ -1346,7 +1381,7 @@ components: if payouts are allowed but limited. $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The payout tier that the account holder occupies. format: int32 type: integer @@ -1369,7 +1404,7 @@ components: into this tier). $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The processing tier that the account holder occupies. format: int32 type: integer @@ -1600,6 +1635,12 @@ components: legalBusinessName: description: The legal name of the company. type: string + listedUltimateParentCompany: + description: Information about the parent public company. Required if the + account holder is 100% owned by a publicly listed company. + items: + $ref: '#/components/schemas/UltimateParentCompany' + type: array shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about @@ -1666,7 +1707,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.' @@ -1725,11 +1766,9 @@ components: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string processingTier: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 @@ -1750,11 +1789,11 @@ components: description: Details of the new account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the new account holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccountHolder` request to fail. items: @@ -1779,7 +1818,7 @@ components: may result in an error if the providing service is unavailable.' type: boolean verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -1840,7 +1879,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The status of the account. >Permitted values: `Active`.' @@ -1908,11 +1947,11 @@ components: DocumentDetail: properties: accountHolderCode: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The code of account holder, to which the document applies. type: string bankAccountUUID: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted. @@ -1964,8 +2003,6 @@ components: enum: - BANK_STATEMENT - BSN - - COMPANY_REGISTRATION_SCREENING - - CONSTITUTIONAL_DOCUMENT - DRIVING_LICENCE - DRIVING_LICENCE_BACK - DRIVING_LICENCE_FRONT @@ -1974,13 +2011,12 @@ components: - ID_CARD_FRONT - PASSPORT - SSN - - SUPPORTING_DOCUMENTS type: string filename: description: Filename of the document. type: string shareholderCode: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) for details on when a document should be submitted. @@ -2046,7 +2082,6 @@ components: - currency - currencyCode - dateOfBirth - - description - destinationAccountCode - document - documentExpirationDate @@ -2068,8 +2103,6 @@ components: - houseNumberOrName - iban - idCard - - idCardBack - - idCardFront - idNumber - identityDocument - individualDetails @@ -2107,13 +2140,13 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber - postalCode - primaryCurrency - reason - - registrationNumber - returnUrl - schedule - shareholder @@ -2127,6 +2160,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -2208,7 +2242,7 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' accounts: @@ -2222,8 +2256,6 @@ components: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string pspReference: description: The reference of a request. Can be used to uniquely identify @@ -2244,7 +2276,7 @@ components: may result in an error if the providing service is unavailable.' type: boolean verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -2259,7 +2291,7 @@ components: description: The code of the Account Holder. type: string accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' pspReference: @@ -2333,7 +2365,7 @@ components: description: The code of the Account Holder for which to retrieve the documents. type: string bankAccountUUID: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The code of the Bank Account for which to retrieve the documents. type: string shareholderCode: @@ -2741,6 +2773,37 @@ components: type: boolean required: - accountHolderStatus + UltimateParentCompany: + properties: + address: + description: Address of the ultimate parent company. + $ref: '#/components/schemas/ViasAddress' + businessDetails: + description: Details about the ultimate parent company's business. + $ref: '#/components/schemas/UltimateParentCompanyBusinessDetails' + ultimateParentCompanyCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + entry, returned in the response when you create an ultimate parent company. + Required when updating an existing entry in an `/updateAccountHolder` + request. + type: string + UltimateParentCompanyBusinessDetails: + properties: + legalBusinessName: + description: The legal name of the company. + type: string + registrationNumber: + description: The registration number of the company. + type: string + stockExchange: + description: Market Identifier Code (MIC). + type: string + stockNumber: + description: International Securities Identification Number (ISIN). + type: string + stockTicker: + description: Stock Ticker symbol. + type: string UnSuspendAccountHolderRequest: properties: accountHolderCode: @@ -2785,7 +2848,7 @@ components: Required if a processingTier is not provided.' $ref: '#/components/schemas/AccountHolderDetails' processingTier: - x-addedInVersion: 3 + x-addedInVersion: '3' description: 'The processing tier to which the Account Holder should be updated. @@ -2806,11 +2869,11 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: @@ -2840,7 +2903,7 @@ components: $ref: '#/components/schemas/FieldType' type: array verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -3079,7 +3142,7 @@ components: For example, **2000-01-31**. type: string documentData: - x-addedInVersion: 3 + x-addedInVersion: '3' description: Array that contains information about the person's identification document. You can submit only one entry per document type. items: @@ -3132,14 +3195,7 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad Request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: I' - errorType: validation - generic-403: + generic: summary: Response code 401. Forbidden. value: status: 403 @@ -3159,76 +3215,6 @@ components: value: accountHolderCode: CODE_OF_ACCOUNT_HOLDER post-createAccountHolder-business: - summary: Create a business account holder - value: - accountHolderCode: GENERATE_CODE - accountHolderDetails: - businessDetails: - doingBusinessAs: Real Good Restaurant - legalBusinessName: Real Good Restaurant Inc. - shareholders: - - ShareholderContact: - name: - firstName: John - gender: MALE - lastName: Carpenter - email: test@adyen.com - webAddress: https://www.your-website.com - legalEntity: Business - post-createAccountHolder-business-200: - summary: Response code 200. Success. - value: - invalidFields: [] - pspReference: '8816080397613514' - accountCode: '8816080397613522' - accountHolderCode: GENERATE_CODE - accountHolderDetails: - address: - country: US - bankAccountDetails: [] - email: tim@green.com - individualDetails: - name: - firstName: Tim - gender: MALE - lastName: Green - merchantCategoryCode: '7999' - payoutMethods: [] - webAddress: null - accountHolderStatus: - status: Active - processingState: - disabled: false - processedFrom: - currency: USD - value: 0 - processedTo: - currency: USD - value: 9999 - tierNumber: 0 - payoutState: - allowPayout: false - disabled: false - events: [] - legalEntity: Individual - verification: - accountHolder: - checks: - - type: IDENTITY_VERIFICATION - status: AWAITING_DATA - requiredFields: - - AccountHolderDetails.IndividualDetails.PersonalData.personalData - - AccountHolderDetails.Address.city - - AccountHolderDetails.Address.houseNumberOrName - - AccountHolderDetails.Address.postalCode - - AccountHolderDetails.Address.street - - AccountHolderDetails.IndividualDetails.PersonalData.idNumber - - AccountHolderDetails.PhoneNumber.phoneNumber - - type: PAYOUT_METHOD_VERIFICATION - status: AWAITING_DATA - requiredFields: - - AccountHolderDetails.BankAccountDetails.bankAccount - post-createAccountHolder-business-422: summary: Response code 422. Unprocessable Entity. value: invalidFields: @@ -3238,87 +3224,14 @@ components: field: accountHolderCode fieldName: accountHolderCode pspReference: '8816080407386622' - post-createAccountHolder-generic-401: + post-createAccountHolder-generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - post-createAccountHolder-generic-500: - summary: Response code 500. Internal Server Error. - value: - status: 500 - errorCode: '701' - message: Internal Error in createAccountHolder 991608040809302G - errorType: internal post-createAccountHolder-individual: - summary: Create an individual account holder - value: - accountHolderCode: GENERATE_CODE - accountHolderDetails: - email: tim@green.com - individualDetails: - name: - firstName: Tim - gender: MALE - lastName: Green - webAddress: https://www.your-website.com - legalEntity: Individual - post-createAccountHolder-individual-200: - summary: Response code 200. Success. - value: - invalidFields: [] - pspReference: '8516080413108716' - accountCode: '8516080413108724' - accountHolderCode: GENERATE_CODE - accountHolderDetails: - address: - country: US - bankAccountDetails: [] - email: tim@green.com - individualDetails: - name: - firstName: Tim - gender: MALE - lastName: Green - merchantCategoryCode: '7999' - payoutMethods: [] - webAddress: null - accountHolderStatus: - status: Active - processingState: - disabled: false - processedFrom: - currency: USD - value: 0 - processedTo: - currency: USD - value: 9999 - tierNumber: 0 - payoutState: - allowPayout: false - disabled: false - events: [] - legalEntity: Individual - verification: - accountHolder: - checks: - - type: IDENTITY_VERIFICATION - status: AWAITING_DATA - requiredFields: - - AccountHolderDetails.Address.city - - AccountHolderDetails.Address.houseNumberOrName - - AccountHolderDetails.Address.postalCode - - AccountHolderDetails.Address.street - - AccountHolderDetails.IndividualDetails.PersonalData.idNumber - - AccountHolderDetails.PhoneNumber.phoneNumber - - AccountHolderDetails.IndividualDetails.PersonalData.personalData - - type: PAYOUT_METHOD_VERIFICATION - status: AWAITING_DATA - requiredFields: - - AccountHolderDetails.BankAccountDetails.bankAccount - post-createAccountHolder-individual-422: summary: Response code 422. Unprocessable Entity. value: invalidFields: diff --git a/yaml/AccountService-v4.yaml b/yaml/AccountService-v4.yaml index 3364b0eb..aeaa6cd6 100644 --- a/yaml/AccountService-v4.yaml +++ b/yaml/AccountService-v4.yaml @@ -62,6 +62,8 @@ x-groups: paths: /closeAccount: post: + tags: + - Accounts summary: Close an account. description: Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed @@ -98,8 +100,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -113,8 +115,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -132,6 +134,8 @@ paths: description: Internal Server Error - the server could not process the request. /closeAccountHolder: post: + tags: + - Account holders summary: Close an account holder. description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't @@ -170,8 +174,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -185,8 +189,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -204,6 +208,8 @@ paths: description: Internal Server Error - the server could not process the request. /createAccount: post: + tags: + - Accounts summary: Create a new account. description: Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#create-additional-accounts). @@ -239,8 +245,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -254,8 +260,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -273,6 +279,8 @@ paths: description: Internal Server Error - the server could not process the request. /createAccountHolder: post: + tags: + - Account holders summary: Create a new account holder. description: Creates an account holder, which [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) @@ -306,8 +314,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -321,8 +329,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -340,6 +348,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteBankAccounts: post: + tags: + - Verification summary: Delete bank accounts. description: 'Deletes one or more bank accounts of an account holder. ' operationId: post-deleteBankAccounts @@ -374,8 +384,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -389,8 +399,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -408,6 +418,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteShareholders: post: + tags: + - Verification summary: Delete shareholders. description: Deletes one or more shareholders from an account holder. operationId: post-deleteShareholders @@ -442,8 +454,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -457,8 +469,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -476,6 +488,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteSignatories: post: + tags: + - Verification summary: Delete signatories. description: Deletes one or more signatories from an account holder. operationId: post-deleteSignatories @@ -507,8 +521,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -522,8 +536,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -541,6 +555,8 @@ paths: description: Internal Server Error - the server could not process the request. /getAccountHolder: post: + tags: + - Account holders summary: Get an account holder. description: Retrieves the details of an account holder. operationId: post-getAccountHolder @@ -577,8 +593,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -592,8 +608,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -611,6 +627,8 @@ paths: description: Internal Server Error - the server could not process the request. /getTaxForm: post: + tags: + - Account holders summary: Get a tax form. description: Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/platforms/tax-forms). @@ -639,8 +657,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -654,8 +672,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -673,6 +691,8 @@ paths: description: Internal Server Error - the server could not process the request. /getUploadedDocuments: post: + tags: + - Verification summary: Get documents. description: 'Retrieves documents that were previously uploaded for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks). @@ -703,8 +723,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -718,8 +738,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -737,6 +757,8 @@ paths: description: Internal Server Error - the server could not process the request. /suspendAccountHolder: post: + tags: + - Account holders summary: Suspend an account holder. description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**. @@ -772,8 +794,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -787,8 +809,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -806,6 +828,8 @@ paths: description: Internal Server Error - the server could not process the request. /unSuspendAccountHolder: post: + tags: + - Account holders summary: Unsuspend an account holder. description: 'Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. Account holders can have a **Suspended** @@ -847,8 +871,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -862,8 +886,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -881,6 +905,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccount: post: + tags: + - Accounts summary: Update an account. description: Updates the description or payout schedule of an account. operationId: post-updateAccount @@ -915,8 +941,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -930,8 +956,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -949,6 +975,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolder: post: + tags: + - Account holders summary: Update an account holder. description: "Updates the `accountHolderDetails` and `processingTier` of an\ \ account holder, and adds bank accounts and shareholders.\n\nWhen updating\ @@ -1002,8 +1030,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1017,8 +1045,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1036,6 +1064,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolderState: post: + tags: + - Account holders summary: Update payout or processing state. description: Disables or enables the processing or payout state of an account holder. @@ -1071,8 +1101,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1086,8 +1116,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1105,6 +1135,8 @@ paths: description: Internal Server Error - the server could not process the request. /uploadDocument: post: + tags: + - Verification summary: Upload a document. description: Uploads a document for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks). @@ -1140,8 +1172,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1155,8 +1187,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1188,14 +1220,14 @@ components: of the executing user. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account. type: string payoutSchedule: description: The account's payout schedule. $ref: '#/components/schemas/PayoutScheduleResponse' status: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`.' type: string @@ -1277,6 +1309,9 @@ components: > 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 + principalBusinessAddress: + description: The principal business address of the account holder. + $ref: '#/components/schemas/ViasAddress' webAddress: description: The URL of the website of the account holder. type: string @@ -1339,7 +1374,7 @@ components: if payouts are allowed but limited. $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The payout tier that the account holder occupies. format: int32 type: integer @@ -1362,7 +1397,7 @@ components: into this tier). $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The processing tier that the account holder occupies. format: int32 type: integer @@ -1593,8 +1628,14 @@ components: legalBusinessName: description: The legal name of the company. type: string + listedUltimateParentCompany: + description: Information about the parent public company. Required if the + account holder is 100% owned by a publicly listed company. + items: + $ref: '#/components/schemas/UltimateParentCompany' + type: array registrationNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The registration number of the company. type: string shareholders: @@ -1663,7 +1704,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.' @@ -1704,7 +1745,7 @@ components: By default, this field is set to **true**.' type: boolean description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. @@ -1728,16 +1769,14 @@ components: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string primaryCurrency: - x-addedInVersion: 4 + x-addedInVersion: '4' 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: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 @@ -1758,29 +1797,27 @@ components: description: Details of the new account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the new account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the new account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccountHolder` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The type of legal entity of the new account holder. enum: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string pspReference: description: The reference of a request. Can be used to uniquely identify @@ -1801,7 +1838,7 @@ components: may result in an error if the providing service is unavailable.' type: boolean verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -1816,7 +1853,7 @@ components: description: The code of Account Holder under which to create the account. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. @@ -1859,7 +1896,7 @@ components: description: The code of the account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string payoutSchedule: @@ -1873,7 +1910,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The status of the account. >Permitted values: `Active`.' @@ -1941,11 +1978,11 @@ components: DocumentDetail: properties: accountHolderCode: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The code of account holder, to which the document applies. type: string bankAccountUUID: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted. @@ -1997,8 +2034,6 @@ components: enum: - BANK_STATEMENT - BSN - - COMPANY_REGISTRATION_SCREENING - - CONSTITUTIONAL_DOCUMENT - DRIVING_LICENCE - DRIVING_LICENCE_BACK - DRIVING_LICENCE_FRONT @@ -2007,13 +2042,12 @@ components: - ID_CARD_FRONT - PASSPORT - SSN - - SUPPORTING_DOCUMENTS type: string filename: description: Filename of the document. type: string shareholderCode: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) for details on when a document should be submitted. @@ -2140,6 +2174,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -2160,6 +2195,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -2233,7 +2269,7 @@ components: > Required if no `accountCode` is provided.' type: string showDetails: - x-addedInVersion: 4 + x-addedInVersion: '4' description: True if the request should return the account holder details type: boolean GetAccountHolderResponse: @@ -2245,7 +2281,7 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' accounts: @@ -2254,7 +2290,7 @@ components: $ref: '#/components/schemas/Account' type: array description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account holder. type: string legalEntity: @@ -2263,11 +2299,9 @@ components: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string primaryCurrency: - x-addedInVersion: 4 + x-addedInVersion: '4' 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 @@ -2290,7 +2324,7 @@ components: may result in an error if the providing service is unavailable.' type: boolean verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -2305,7 +2339,7 @@ components: description: The code of the Account Holder. type: string accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' pspReference: @@ -2379,7 +2413,7 @@ components: description: The code of the Account Holder for which to retrieve the documents. type: string bankAccountUUID: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The code of the Bank Account for which to retrieve the documents. type: string shareholderCode: @@ -2787,6 +2821,37 @@ components: type: boolean required: - accountHolderStatus + UltimateParentCompany: + properties: + address: + description: Address of the ultimate parent company. + $ref: '#/components/schemas/ViasAddress' + businessDetails: + description: Details about the ultimate parent company's business. + $ref: '#/components/schemas/UltimateParentCompanyBusinessDetails' + ultimateParentCompanyCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + entry, returned in the response when you create an ultimate parent company. + Required when updating an existing entry in an `/updateAccountHolder` + request. + type: string + UltimateParentCompanyBusinessDetails: + properties: + legalBusinessName: + description: The legal name of the company. + type: string + registrationNumber: + description: The registration number of the company. + type: string + stockExchange: + description: Market Identifier Code (MIC). + type: string + stockNumber: + description: International Securities Identification Number (ISIN). + type: string + stockTicker: + description: Stock Ticker symbol. + type: string UnSuspendAccountHolderRequest: properties: accountHolderCode: @@ -2831,18 +2896,18 @@ components: Required if a processingTier is not provided.' $ref: '#/components/schemas/AccountHolderDetails' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. type: string primaryCurrency: - x-addedInVersion: 4 + x-addedInVersion: '4' 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: - x-addedInVersion: 3 + x-addedInVersion: '3' description: 'The processing tier to which the Account Holder should be updated. @@ -2863,29 +2928,27 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The legal entity of the account holder. enum: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string pspReference: description: The reference of a request. Can be used to uniquely identify @@ -2911,7 +2974,7 @@ components: $ref: '#/components/schemas/FieldType' type: array verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -2954,7 +3017,7 @@ components: description: The code of the account to update. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. @@ -2971,7 +3034,7 @@ components: description: The code of the account. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string payoutSchedule: @@ -3160,7 +3223,7 @@ components: For example, **2000-01-31**. type: string documentData: - x-addedInVersion: 3 + x-addedInVersion: '3' description: Array that contains information about the person's identification document. You can submit only one entry per document type. items: @@ -3213,14 +3276,7 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad Request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: I' - errorType: validation - generic-403: + generic: summary: Response code 401. Forbidden. value: status: 403 diff --git a/yaml/AccountService-v5.yaml b/yaml/AccountService-v5.yaml index afcfc72b..80a67230 100644 --- a/yaml/AccountService-v5.yaml +++ b/yaml/AccountService-v5.yaml @@ -62,10 +62,12 @@ x-groups: paths: /checkAccountHolder: post: + tags: + - Verification summary: Trigger verification. description: Triggers the KYC verification for an account holder even if the checks are not yet required for the volume that they currently process. - x-addedInVersion: 5 + x-addedInVersion: '5' operationId: post-checkAccountHolder x-groupName: Verification x-sortIndex: 3 @@ -98,8 +100,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -113,8 +115,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -132,6 +134,8 @@ paths: description: Internal Server Error - the server could not process the request. /closeAccount: post: + tags: + - Accounts summary: Close an account. description: Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed @@ -168,8 +172,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -183,8 +187,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -202,6 +206,8 @@ paths: description: Internal Server Error - the server could not process the request. /closeAccountHolder: post: + tags: + - Account holders summary: Close an account holder. description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't @@ -240,8 +246,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -255,8 +261,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -274,9 +280,11 @@ paths: description: Internal Server Error - the server could not process the request. /closeStores: post: + tags: + - Account holders summary: Close stores. description: Close one or more stores of the account holder. - x-addedInVersion: 5 + x-addedInVersion: '5' operationId: post-closeStores x-groupName: Account holders x-sortIndex: 9 @@ -299,8 +307,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -314,8 +322,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -333,6 +341,8 @@ paths: description: Internal Server Error - the server could not process the request. /createAccount: post: + tags: + - Accounts summary: Create a new account. description: Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#create-additional-accounts). @@ -368,8 +378,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +393,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -402,6 +412,8 @@ paths: description: Internal Server Error - the server could not process the request. /createAccountHolder: post: + tags: + - Account holders summary: Create a new account holder. description: Creates an account holder, which [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) @@ -435,8 +447,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -450,8 +462,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -469,6 +481,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteBankAccounts: post: + tags: + - Verification summary: Delete bank accounts. description: 'Deletes one or more bank accounts of an account holder. ' operationId: post-deleteBankAccounts @@ -503,8 +517,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -518,8 +532,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -537,9 +551,11 @@ paths: description: Internal Server Error - the server could not process the request. /deletePayoutMethods: post: + tags: + - Verification summary: Delete payout methods. description: Deletes one or more payout methods of an account holder. - x-addedInVersion: 5 + x-addedInVersion: '5' operationId: post-deletePayoutMethods x-groupName: Verification x-sortIndex: 5 @@ -572,8 +588,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -587,8 +603,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -606,6 +622,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteShareholders: post: + tags: + - Verification summary: Delete shareholders. description: Deletes one or more shareholders from an account holder. operationId: post-deleteShareholders @@ -640,8 +658,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -655,8 +673,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -674,6 +692,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteSignatories: post: + tags: + - Verification summary: Delete signatories. description: Deletes one or more signatories from an account holder. operationId: post-deleteSignatories @@ -705,8 +725,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -720,8 +740,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -739,6 +759,8 @@ paths: description: Internal Server Error - the server could not process the request. /getAccountHolder: post: + tags: + - Account holders summary: Get an account holder. description: Retrieves the details of an account holder. operationId: post-getAccountHolder @@ -775,8 +797,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -790,8 +812,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -809,6 +831,8 @@ paths: description: Internal Server Error - the server could not process the request. /getTaxForm: post: + tags: + - Account holders summary: Get a tax form. description: Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/platforms/tax-forms). @@ -837,8 +861,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -852,8 +876,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -871,6 +895,8 @@ paths: description: Internal Server Error - the server could not process the request. /getUploadedDocuments: post: + tags: + - Verification summary: Get documents. description: 'Retrieves documents that were previously uploaded for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks). @@ -901,8 +927,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -916,8 +942,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -935,6 +961,8 @@ paths: description: Internal Server Error - the server could not process the request. /suspendAccountHolder: post: + tags: + - Account holders summary: Suspend an account holder. description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**. @@ -970,8 +998,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -985,8 +1013,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1004,6 +1032,8 @@ paths: description: Internal Server Error - the server could not process the request. /unSuspendAccountHolder: post: + tags: + - Account holders summary: Unsuspend an account holder. description: 'Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. Account holders can have a **Suspended** @@ -1045,8 +1075,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1060,8 +1090,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1079,6 +1109,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccount: post: + tags: + - Accounts summary: Update an account. description: Updates the description or payout schedule of an account. operationId: post-updateAccount @@ -1113,8 +1145,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1128,8 +1160,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1147,6 +1179,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolder: post: + tags: + - Account holders summary: Update an account holder. description: "Updates the `accountHolderDetails` and `processingTier` of an\ \ account holder, and adds bank accounts and shareholders.\n\nWhen updating\ @@ -1200,8 +1234,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1215,8 +1249,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1234,6 +1268,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolderState: post: + tags: + - Account holders summary: Update payout or processing state. description: Disables or enables the processing or payout state of an account holder. @@ -1269,8 +1305,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1284,8 +1320,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1303,6 +1339,8 @@ paths: description: Internal Server Error - the server could not process the request. /uploadDocument: post: + tags: + - Verification summary: Upload a document. description: Uploads a document for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks). @@ -1338,8 +1376,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1353,8 +1391,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1378,7 +1416,7 @@ components: description: The code of the account. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -1394,11 +1432,11 @@ components: of the executing user. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account. type: string metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'A set of key and value pairs for general use by the merchant. @@ -1410,7 +1448,7 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -1419,7 +1457,7 @@ components: description: The account's payout schedule. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -1428,7 +1466,7 @@ components: - STANDARD type: string status: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`.' type: string @@ -1468,7 +1506,7 @@ components: $ref: '#/components/schemas/BankAccountDetail' type: array bankAggregatorDataReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The opaque reference value returned by the Adyen API during bank account login. type: string @@ -1516,15 +1554,18 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethods: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards). items: $ref: '#/components/schemas/PayoutMethod' type: array + principalBusinessAddress: + description: The principal business address of the account holder. + $ref: '#/components/schemas/ViasAddress' storeDetails: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos). items: @@ -1588,7 +1629,7 @@ components: depending on other factors. type: boolean notAllowedReason: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not @@ -1599,7 +1640,7 @@ components: if payouts are allowed but limited. $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The payout tier that the account holder occupies. format: int32 type: integer @@ -1622,7 +1663,7 @@ components: into this tier). $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The processing tier that the account holder occupies. format: int32 type: integer @@ -1663,7 +1704,7 @@ components: description: The name of the bank account. type: string bankAccountReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Merchant reference to the bank account. type: string bankAccountUUID: @@ -1857,8 +1898,14 @@ components: legalBusinessName: description: The legal name of the company. type: string + listedUltimateParentCompany: + description: Information about the parent public company. Required if the + account holder is 100% owned by a publicly listed company. + items: + $ref: '#/components/schemas/UltimateParentCompany' + type: array registrationNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The registration number of the company. type: string shareholders: @@ -1891,7 +1938,7 @@ components: description: The new status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1916,11 +1963,11 @@ components: CloseAccountResponse: properties: accountCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The account code of the account that is closed. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1934,7 +1981,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.' @@ -1977,7 +2024,7 @@ components: By default, this field is set to **true**.' type: boolean description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. @@ -2001,16 +2048,14 @@ components: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string primaryCurrency: - x-addedInVersion: 4 + x-addedInVersion: '4' 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: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 @@ -2031,32 +2076,30 @@ components: description: Details of the new account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the new account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the new account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccountHolder` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The type of legal entity of the new account holder. enum: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string primaryCurrency: - x-addedInVersion: 5 + x-addedInVersion: '5' 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 @@ -2068,7 +2111,7 @@ components: description: The result code. type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -2083,7 +2126,7 @@ components: description: The code of Account Holder under which to create the account. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -2091,13 +2134,13 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. type: string metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'A set of key and value pairs for general use by the merchant. @@ -2109,7 +2152,7 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -2142,7 +2185,7 @@ components: >Required if the payoutSchedule is `HOLD`.' type: string payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' default: STANDARD description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' @@ -2162,7 +2205,7 @@ components: description: The code of the account holder. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -2170,24 +2213,24 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccount` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: A set of key and value pairs containing metadata. type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -2196,7 +2239,7 @@ components: description: The payout schedule of the account. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -2212,7 +2255,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The status of the account. >Permitted values: `Active`.' @@ -2283,11 +2326,11 @@ components: DocumentDetail: properties: accountHolderCode: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The code of account holder, to which the document applies. type: string bankAccountUUID: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted. @@ -2340,7 +2383,6 @@ components: - BANK_STATEMENT - BSN - COMPANY_REGISTRATION_SCREENING - - CONSTITUTIONAL_DOCUMENT - DRIVING_LICENCE - DRIVING_LICENCE_BACK - DRIVING_LICENCE_FRONT @@ -2355,7 +2397,7 @@ components: description: Filename of the document. type: string shareholderCode: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) for details on when a document should be submitted. @@ -2482,6 +2524,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -2502,6 +2545,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -2545,7 +2589,7 @@ components: GenericResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2571,7 +2615,7 @@ components: > Required if no `accountCode` is provided.' type: string showDetails: - x-addedInVersion: 4 + x-addedInVersion: '4' description: True if the request should return the account holder details type: boolean GetAccountHolderResponse: @@ -2583,7 +2627,7 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' accounts: @@ -2592,11 +2636,11 @@ components: $ref: '#/components/schemas/Account' type: array description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2608,11 +2652,9 @@ components: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string primaryCurrency: - x-addedInVersion: 4 + x-addedInVersion: '4' 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 @@ -2624,13 +2666,13 @@ components: description: The result code. type: string systemUpToDateTime: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The time that shows how up to date is the information in the response. format: date-time type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -2645,11 +2687,11 @@ components: description: The code of the Account Holder. type: string accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2692,7 +2734,7 @@ components: description: The content type of the tax form. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2711,7 +2753,7 @@ components: description: The code of the Account Holder for which to retrieve the documents. type: string bankAccountUUID: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The code of the Bank Account for which to retrieve the documents. type: string shareholderCode: @@ -2727,7 +2769,7 @@ components: $ref: '#/components/schemas/DocumentDetail' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2829,13 +2871,13 @@ components: KYCCheckSummary: properties: kycCheckCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes). format: int32 type: integer kycCheckDescription: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A description of the check. type: string KYCShareholderCheckResult: @@ -2869,7 +2911,7 @@ components: $ref: '#/components/schemas/KYCBankAccountCheckResult' type: array cards: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The results of the checks on the cards. items: $ref: '#/components/schemas/KYCCardCheckResult' @@ -3068,7 +3110,7 @@ components: ' type: string shareholderReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Your reference for the shareholder entry. type: string shareholderType: @@ -3172,14 +3214,14 @@ components: readOnly: true $ref: '#/components/schemas/ViasPhoneNumber' shopperInteraction: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'The sales channel. Possible values: **Ecommerce**, **POS**.' enum: - Ecommerce - POS type: string splitConfigurationUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and @@ -3214,12 +3256,12 @@ components: This value will be shown as the store description in your Customer Area.' type: string virtualAccount: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`. type: string webAddress: - x-addedInVersion: 5 + x-addedInVersion: '5' description: URL of the ecommerce store. type: string required: @@ -3240,7 +3282,7 @@ components: description: The new status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -3255,6 +3297,37 @@ components: type: string required: - accountHolderStatus + UltimateParentCompany: + properties: + address: + description: Address of the ultimate parent company. + $ref: '#/components/schemas/ViasAddress' + businessDetails: + description: Details about the ultimate parent company's business. + $ref: '#/components/schemas/UltimateParentCompanyBusinessDetails' + ultimateParentCompanyCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + entry, returned in the response when you create an ultimate parent company. + Required when updating an existing entry in an `/updateAccountHolder` + request. + type: string + UltimateParentCompanyBusinessDetails: + properties: + legalBusinessName: + description: The legal name of the company. + type: string + registrationNumber: + description: The registration number of the company. + type: string + stockExchange: + description: Market Identifier Code (MIC). + type: string + stockNumber: + description: International Securities Identification Number (ISIN). + type: string + stockTicker: + description: Stock Ticker symbol. + type: string UnSuspendAccountHolderRequest: properties: accountHolderCode: @@ -3268,7 +3341,7 @@ components: description: The new status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -3295,13 +3368,13 @@ components: Required if a processingTier is not provided.' $ref: '#/components/schemas/AccountHolderDetails' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. type: string legalEntity: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'The legal entity type of the account holder. This determines the information that should be provided in the request. @@ -3320,16 +3393,14 @@ components: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string primaryCurrency: - x-addedInVersion: 4 + x-addedInVersion: '4' 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: - x-addedInVersion: 3 + x-addedInVersion: '3' description: 'The processing tier to which the Account Holder should be updated. @@ -3350,32 +3421,30 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The legal entity of the account holder. enum: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string primaryCurrency: - x-addedInVersion: 5 + x-addedInVersion: '5' 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 @@ -3387,7 +3456,7 @@ components: description: The result code. type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -3430,7 +3499,7 @@ components: description: The code of the account to update. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -3438,13 +3507,13 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. type: string metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'A set of key and value pairs for general use by the merchant. @@ -3456,7 +3525,7 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -3466,7 +3535,7 @@ components: be updated. $ref: '#/components/schemas/UpdatePayoutScheduleRequest' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -3482,7 +3551,7 @@ components: description: The code of the account. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -3490,24 +3559,24 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/updateAccount` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: A set of key and value pairs containing metadata. type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -3516,7 +3585,7 @@ components: description: The payout schedule of the account. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -3678,7 +3747,7 @@ components: For example, **2000-01-31**. type: string documentData: - x-addedInVersion: 3 + x-addedInVersion: '3' description: Array that contains information about the person's identification document. You can submit only one entry per document type. items: @@ -3727,14 +3796,7 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad Request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: I' - errorType: validation - generic-403: + generic: summary: Response code 401. Forbidden. value: status: 403 diff --git a/yaml/AccountService-v6.yaml b/yaml/AccountService-v6.yaml index 232916d8..cd5bef46 100644 --- a/yaml/AccountService-v6.yaml +++ b/yaml/AccountService-v6.yaml @@ -62,10 +62,12 @@ x-groups: paths: /checkAccountHolder: post: + tags: + - Verification summary: Trigger verification. description: Triggers the KYC verification for an account holder even if the checks are not yet required for the volume that they currently process. - x-addedInVersion: 5 + x-addedInVersion: '5' operationId: post-checkAccountHolder x-groupName: Verification x-sortIndex: 3 @@ -98,8 +100,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -113,8 +115,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -132,6 +134,8 @@ paths: description: Internal Server Error - the server could not process the request. /closeAccount: post: + tags: + - Accounts summary: Close an account. description: Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed @@ -168,8 +172,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -183,8 +187,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -202,6 +206,8 @@ paths: description: Internal Server Error - the server could not process the request. /closeAccountHolder: post: + tags: + - Account holders summary: Close an account holder. description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't @@ -240,8 +246,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -255,8 +261,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -274,9 +280,11 @@ paths: description: Internal Server Error - the server could not process the request. /closeStores: post: + tags: + - Account holders summary: Close stores. description: Close one or more stores of the account holder. - x-addedInVersion: 5 + x-addedInVersion: '5' operationId: post-closeStores x-groupName: Account holders x-sortIndex: 9 @@ -299,8 +307,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -314,8 +322,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -333,6 +341,8 @@ paths: description: Internal Server Error - the server could not process the request. /createAccount: post: + tags: + - Accounts summary: Create a new account. description: Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#create-additional-accounts). @@ -368,8 +378,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +393,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -402,6 +412,8 @@ paths: description: Internal Server Error - the server could not process the request. /createAccountHolder: post: + tags: + - Account holders summary: Create a new account holder. description: Creates an account holder, which [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) @@ -435,8 +447,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -450,8 +462,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -469,6 +481,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteBankAccounts: post: + tags: + - Verification summary: Delete bank accounts. description: 'Deletes one or more bank accounts of an account holder. ' operationId: post-deleteBankAccounts @@ -503,8 +517,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -518,8 +532,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -537,9 +551,11 @@ paths: description: Internal Server Error - the server could not process the request. /deletePayoutMethods: post: + tags: + - Verification summary: Delete payout methods. description: Deletes one or more payout methods of an account holder. - x-addedInVersion: 5 + x-addedInVersion: '5' operationId: post-deletePayoutMethods x-groupName: Verification x-sortIndex: 5 @@ -572,8 +588,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -587,8 +603,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -606,6 +622,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteShareholders: post: + tags: + - Verification summary: Delete shareholders. description: Deletes one or more shareholders from an account holder. operationId: post-deleteShareholders @@ -640,8 +658,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -655,8 +673,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -674,6 +692,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteSignatories: post: + tags: + - Verification summary: Delete signatories. description: Deletes one or more signatories from an account holder. operationId: post-deleteSignatories @@ -705,8 +725,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -720,8 +740,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -739,6 +759,8 @@ paths: description: Internal Server Error - the server could not process the request. /getAccountHolder: post: + tags: + - Account holders summary: Get an account holder. description: Retrieves the details of an account holder. operationId: post-getAccountHolder @@ -775,8 +797,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -790,8 +812,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -809,6 +831,8 @@ paths: description: Internal Server Error - the server could not process the request. /getTaxForm: post: + tags: + - Account holders summary: Get a tax form. description: Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/platforms/tax-forms). @@ -837,8 +861,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -852,8 +876,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -871,6 +895,8 @@ paths: description: Internal Server Error - the server could not process the request. /getUploadedDocuments: post: + tags: + - Verification summary: Get documents. description: 'Retrieves documents that were previously uploaded for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks). @@ -901,8 +927,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -916,8 +942,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -935,6 +961,8 @@ paths: description: Internal Server Error - the server could not process the request. /suspendAccountHolder: post: + tags: + - Account holders summary: Suspend an account holder. description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**. @@ -970,8 +998,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -985,8 +1013,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1004,6 +1032,8 @@ paths: description: Internal Server Error - the server could not process the request. /unSuspendAccountHolder: post: + tags: + - Account holders summary: Unsuspend an account holder. description: 'Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. Account holders can have a **Suspended** @@ -1045,8 +1075,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1060,8 +1090,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1079,6 +1109,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccount: post: + tags: + - Accounts summary: Update an account. description: Updates the description or payout schedule of an account. operationId: post-updateAccount @@ -1113,8 +1145,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1128,8 +1160,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1147,6 +1179,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolder: post: + tags: + - Account holders summary: Update an account holder. description: "Updates the `accountHolderDetails` and `processingTier` of an\ \ account holder, and adds bank accounts and shareholders.\n\nWhen updating\ @@ -1200,8 +1234,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1215,8 +1249,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1234,6 +1268,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolderState: post: + tags: + - Account holders summary: Update payout or processing state. description: Disables or enables the processing or payout state of an account holder. @@ -1269,8 +1305,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1284,8 +1320,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1303,6 +1339,8 @@ paths: description: Internal Server Error - the server could not process the request. /uploadDocument: post: + tags: + - Verification summary: Upload a document. description: Uploads a document for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks). @@ -1338,8 +1376,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1353,8 +1391,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1378,7 +1416,7 @@ components: description: The code of the account. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -1394,11 +1432,11 @@ components: of the executing user. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account. type: string metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'A set of key and value pairs for general use by the merchant. @@ -1410,7 +1448,7 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -1419,7 +1457,7 @@ components: description: The account's payout schedule. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -1428,7 +1466,7 @@ components: - STANDARD type: string status: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`.' type: string @@ -1468,7 +1506,7 @@ components: $ref: '#/components/schemas/BankAccountDetail' type: array bankAggregatorDataReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The opaque reference value returned by the Adyen API during bank account login. type: string @@ -1495,10 +1533,9 @@ components: ' $ref: '#/components/schemas/IndividualDetails' legalArrangements: - x-addedInVersion: 6 - description: Array that contains information about legal arrangements, used - when the account holder is acting on behalf of different parties or is - part of a contractual business agreement. + x-addedInVersion: '6' + description: An array containing information about the account holder's + [legal arrangements](https://docs.adyen.com/platforms/verification-checks/legal-arrangements). items: $ref: '#/components/schemas/LegalArrangementDetail' type: array @@ -1524,7 +1561,7 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethods: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards). @@ -1532,11 +1569,10 @@ components: $ref: '#/components/schemas/PayoutMethod' type: array principalBusinessAddress: - x-addedInVersion: 6 - description: The prinicipal business address of the account holder. + description: The principal business address of the account holder. $ref: '#/components/schemas/ViasAddress' storeDetails: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos). items: @@ -1600,7 +1636,7 @@ components: depending on other factors. type: boolean notAllowedReason: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not @@ -1611,7 +1647,7 @@ components: if payouts are allowed but limited. $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The payout tier that the account holder occupies. format: int32 type: integer @@ -1634,7 +1670,7 @@ components: into this tier). $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The processing tier that the account holder occupies. format: int32 type: integer @@ -1675,7 +1711,7 @@ components: description: The name of the bank account. type: string bankAccountReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Merchant reference to the bank account. type: string bankAccountUUID: @@ -1870,14 +1906,13 @@ components: description: The legal name of the company. type: string listedUltimateParentCompany: - x-addedInVersion: 6 description: Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company. items: $ref: '#/components/schemas/UltimateParentCompany' type: array registrationNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The registration number of the company. type: string shareholders: @@ -1895,15 +1930,15 @@ components: $ref: '#/components/schemas/SignatoryContact' type: array stockExchange: - x-addedInVersion: 6 + x-addedInVersion: '6' description: Market Identifier Code (MIC). type: string stockNumber: - x-addedInVersion: 6 + x-addedInVersion: '6' description: International Securities Identification Number (ISIN). type: string stockTicker: - x-addedInVersion: 6 + x-addedInVersion: '6' description: Stock Ticker symbol. type: string taxId: @@ -1922,7 +1957,7 @@ components: description: The new status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1947,11 +1982,11 @@ components: CloseAccountResponse: properties: accountCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The account code of the account that is closed. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1965,7 +2000,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.' @@ -2008,7 +2043,7 @@ components: By default, this field is set to **true**.' type: boolean description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. @@ -2036,18 +2071,18 @@ components: - PublicCompany type: string primaryCurrency: - x-addedInVersion: 4 + x-addedInVersion: '4' 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: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer verificationProfile: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The identifier of the profile that applies to this entity. type: string required: @@ -2066,22 +2101,22 @@ components: description: Details of the new account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the new account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the new account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccountHolder` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The type of legal entity of the new account holder. enum: - Business @@ -2091,7 +2126,7 @@ components: - PublicCompany type: string primaryCurrency: - x-addedInVersion: 5 + x-addedInVersion: '5' 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 @@ -2103,11 +2138,11 @@ components: description: The result code. type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' verificationProfile: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The identifier of the profile that applies to this entity. type: string required: @@ -2122,7 +2157,7 @@ components: description: The code of Account Holder under which to create the account. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -2130,13 +2165,13 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. type: string metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'A set of key and value pairs for general use by the merchant. @@ -2148,7 +2183,7 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -2181,7 +2216,7 @@ components: >Required if the payoutSchedule is `HOLD`.' type: string payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' default: STANDARD description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' @@ -2201,7 +2236,7 @@ components: description: The code of the account holder. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -2209,24 +2244,24 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccount` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: A set of key and value pairs containing metadata. type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -2235,7 +2270,7 @@ components: description: The payout schedule of the account. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -2251,7 +2286,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The status of the account. >Permitted values: `Active`.' @@ -2322,11 +2357,11 @@ components: DocumentDetail: properties: accountHolderCode: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The code of account holder, to which the document applies. type: string bankAccountUUID: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted. @@ -2394,17 +2429,17 @@ components: description: Filename of the document. type: string legalArrangementCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The Adyen-generated [`legalArrangementCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-legalArrangements-legalArrangementCode) to which the document must be linked. type: string legalArrangementEntityCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The Adyen-generated [`legalArrangementEntityCode`](https://docs.adyen.com/api-explorer/#/Account/v6/post/createAccountHolder__resParam_accountHolderDetails-legalArrangements-legalArrangementEntities-legalArrangementEntityCode) to which the document must be linked. type: string shareholderCode: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) for details on when a document should be submitted. @@ -2531,6 +2566,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -2551,6 +2587,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -2594,7 +2631,7 @@ components: GenericResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2620,7 +2657,7 @@ components: > Required if no `accountCode` is provided.' type: string showDetails: - x-addedInVersion: 4 + x-addedInVersion: '4' description: True if the request should return the account holder details type: boolean GetAccountHolderResponse: @@ -2632,7 +2669,7 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' accounts: @@ -2641,11 +2678,11 @@ components: $ref: '#/components/schemas/Account' type: array description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2661,7 +2698,7 @@ components: - PublicCompany type: string primaryCurrency: - x-addedInVersion: 4 + x-addedInVersion: '4' 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 @@ -2673,17 +2710,17 @@ components: description: The result code. type: string systemUpToDateTime: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The time that shows how up to date is the information in the response. format: date-time type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' verificationProfile: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The identifier of the profile that applies to this entity. type: string required: @@ -2698,11 +2735,11 @@ components: description: The code of the Account Holder. type: string accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2745,7 +2782,7 @@ components: description: The content type of the tax form. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2764,7 +2801,7 @@ components: description: The code of the Account Holder for which to retrieve the documents. type: string bankAccountUUID: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The code of the Bank Account for which to retrieve the documents. type: string shareholderCode: @@ -2780,7 +2817,7 @@ components: $ref: '#/components/schemas/DocumentDetail' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -2862,13 +2899,13 @@ components: KYCCheckSummary: properties: kycCheckCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes). format: int32 type: integer kycCheckDescription: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A description of the check. type: string KYCLegalArrangementCheckResult: @@ -2914,12 +2951,12 @@ components: $ref: '#/components/schemas/KYCCheckStatusData' type: array legalArrangementCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The unique ID of the legal arrangement to which the shareholder belongs, if applicable. type: string legalArrangementEntityCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The unique ID of the legal arrangement entity to which the shareholder belongs, if applicable. type: string @@ -2944,7 +2981,7 @@ components: $ref: '#/components/schemas/KYCCheckStatusData' type: array ultimateParentCompanyCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The code of the Ultimate Parent Company to which the check applies. type: string @@ -2954,19 +2991,19 @@ components: description: The results of the checks on the account holder. $ref: '#/components/schemas/KYCCheckResult2' legalArrangements: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The results of the checks on the legal arrangements. items: $ref: '#/components/schemas/KYCLegalArrangementCheckResult' type: array legalArrangementsEntities: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The results of the checks on the legal arrangement entities. items: $ref: '#/components/schemas/KYCLegalArrangementEntityCheckResult' type: array payoutMethods: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The results of the checks on the payout methods. items: $ref: '#/components/schemas/KYCPayoutMethodCheckResult' @@ -2982,7 +3019,7 @@ components: $ref: '#/components/schemas/KYCSignatoryCheckResult' type: array ultimateParentCompany: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The result of the check on the Ultimate Parent Company. items: $ref: '#/components/schemas/KYCUltimateParentCompanyCheckResult' @@ -2990,7 +3027,7 @@ components: LegalArrangementDetail: properties: address: - description: The address of the legal arrangement member. + description: The address of the legal arrangement. $ref: '#/components/schemas/ViasAddress' legalArrangementCode: description: Adyen-generated unique alphanumeric identifier (UUID) for the @@ -2999,8 +3036,8 @@ components: request. type: string legalArrangementEntities: - description: Array that contains information about the entities or members - that are part of the legal arrangement. + description: An array containing information about other entities that are + part of the legal arrangement. items: $ref: '#/components/schemas/LegalArrangementEntityDetail' type: array @@ -3009,14 +3046,22 @@ components: to 128 characters. type: string legalForm: - description: "The structure of the legal arrangement as defined according\ - \ to legislations in the country.\n\n Possible values: **CashManagementTrust**,\ - \ **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**,\ - \ **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**,\ - \ **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**,\ - \ **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**,\ - \ **PublicTradingTrust**, **UnlistedPublicUnitTrust**, **LimitedPartnership**,\ - \ **FamilyPartnership**, **OtherPartnership**." + description: 'The form of legal arrangement. Required if `type` is **Trust** + or **Partnership**. + + + The possible values depend on the `type`. + + + - For `type` **Trust**: **CashManagementTrust**, **CorporateUnitTrust**, + **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, + **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, + **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, + **PooledSuperannuationTrust**, **PublicTradingTrust**, or **UnlistedPublicUnitTrust**. + + + - For `type` **Partnership**: **LimitedPartnership**, **FamilyPartnership**, + or **OtherPartnership**' enum: - CashManagementTrust - CorporateUnitTrust @@ -3038,7 +3083,8 @@ components: - OtherPartnership type: string name: - description: The legal name of the legal arrangement. + description: 'The legal name of the legal arrangement. Minimum length: 3 + characters.' type: string registrationNumber: description: The registration number of the legal arrangement. @@ -3047,22 +3093,19 @@ components: description: The tax identification number of the legal arrangement. type: string type: - description: 'The type of legal arrangement. - - - Possible values: - - - - **Trust** - A legal agreement where the account holder is a trustee - that manages assets for beneficiaries. - - - **Partnership** - A legal arrangement where the account holder is a - partner that has an agreement with one or more partners to manage, operate - and share profits of their jointly-owned business.' + description: "The [type of legal arrangement](https://docs.adyen.com/platforms/verification-checks/legal-arrangements#types-of-legal-arrangements).\n\ + \nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship**\ + \ \n\n- **Trust** \n\n" enum: + - Association - Partnership + - SoleProprietorship - Trust type: string + required: + - type + - name + - address LegalArrangementEntityDetail: properties: address: @@ -3087,35 +3130,38 @@ components: legalArrangementEntityCode: description: Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity. + Required when updating an existing legal arrangement entity entry in an + `/updateAccountHolder` request. type: string legalArrangementEntityReference: description: Your reference for the legal arrangement entity. type: string legalArrangementMembers: - description: 'The roles of the entity in the legal arrangement. The values - depend on the `legalArragementType`. + description: 'An array containing the roles of the entity in the legal arrangement. + + The possible values depend on the legal arrangement `type`. - Possible values: + - For `type` **Association**: **ControllingPerson** and **Shareholder**. - - For `legalArragementType` **Trust**, you can use **Trustee**, **Settlor**, - **Protector**, **Beneficiary**, or **Shareholder**. + - For `type` **Partnership**: **Partner** and **Shareholder**. - - For `legalArragementType` **Partnership**, you can use **Partner** or - **Shareholder**. ' + + - For `type` **Trust**: **Trustee**, **Settlor**, **Protector**, **Beneficiary**, and + **Shareholder**. + + + ' items: enum: - - Associate - Beneficiary - - Chairman + - ControllingPerson - Partner - Protector - - Secretary - Settlor - Shareholder - - Treasurer - Trustee type: string type: array @@ -3324,7 +3370,7 @@ components: ' type: string shareholderReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Your reference for the shareholder entry. type: string shareholderType: @@ -3428,14 +3474,14 @@ components: readOnly: true $ref: '#/components/schemas/ViasPhoneNumber' shopperInteraction: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'The sales channel. Possible values: **Ecommerce**, **POS**.' enum: - Ecommerce - POS type: string splitConfigurationUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and @@ -3470,12 +3516,12 @@ components: This value will be shown as the store description in your Customer Area.' type: string virtualAccount: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`. type: string webAddress: - x-addedInVersion: 5 + x-addedInVersion: '5' description: URL of the ecommerce store. type: string required: @@ -3496,7 +3542,7 @@ components: description: The new status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -3514,15 +3560,12 @@ components: UltimateParentCompany: properties: address: - x-addedInVersion: 6 description: Address of the ultimate parent company. $ref: '#/components/schemas/ViasAddress' businessDetails: - x-addedInVersion: 6 description: Details about the ultimate parent company's business. $ref: '#/components/schemas/UltimateParentCompanyBusinessDetails' ultimateParentCompanyCode: - x-addedInVersion: 6 description: Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` @@ -3534,19 +3577,15 @@ components: description: The legal name of the company. type: string registrationNumber: - x-addedInVersion: 4 description: The registration number of the company. type: string stockExchange: - x-addedInVersion: 6 description: Market Identifier Code (MIC). type: string stockNumber: - x-addedInVersion: 6 description: International Securities Identification Number (ISIN). type: string stockTicker: - x-addedInVersion: 6 description: Stock Ticker symbol. type: string UnSuspendAccountHolderRequest: @@ -3562,7 +3601,7 @@ components: description: The new status of the Account Holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -3589,13 +3628,13 @@ components: Required if a processingTier is not provided.' $ref: '#/components/schemas/AccountHolderDetails' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. type: string legalEntity: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'The legal entity type of the account holder. This determines the information that should be provided in the request. @@ -3618,12 +3657,12 @@ components: - PublicCompany type: string primaryCurrency: - x-addedInVersion: 4 + x-addedInVersion: '4' 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: - x-addedInVersion: 3 + x-addedInVersion: '3' description: 'The processing tier to which the Account Holder should be updated. @@ -3634,7 +3673,7 @@ components: format: int32 type: integer verificationProfile: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The identifier of the profile that applies to this entity. type: string required: @@ -3648,22 +3687,22 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The legal entity of the account holder. enum: - Business @@ -3673,7 +3712,7 @@ components: - PublicCompany type: string primaryCurrency: - x-addedInVersion: 5 + x-addedInVersion: '5' 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 @@ -3685,11 +3724,11 @@ components: description: The result code. type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' verificationProfile: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The identifier of the profile that applies to this entity. type: string required: @@ -3732,7 +3771,7 @@ components: description: The code of the account to update. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -3740,13 +3779,13 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. type: string metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'A set of key and value pairs for general use by the merchant. @@ -3758,7 +3797,7 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -3768,7 +3807,7 @@ components: be updated. $ref: '#/components/schemas/UpdatePayoutScheduleRequest' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -3784,7 +3823,7 @@ components: description: The code of the account. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -3792,24 +3831,24 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/updateAccount` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: A set of key and value pairs containing metadata. type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -3818,7 +3857,7 @@ components: description: The payout schedule of the account. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -3980,7 +4019,7 @@ components: For example, **2000-01-31**. type: string documentData: - x-addedInVersion: 3 + x-addedInVersion: '3' description: Array that contains information about the person's identification document. You can submit only one entry per document type. items: @@ -4029,14 +4068,7 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad Request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: I' - errorType: validation - generic-403: + generic: summary: Response code 401. Forbidden. value: status: 403 diff --git a/yaml/BalancePlatformNotificationService-v1.yaml b/yaml/BalancePlatformNotificationService-v1.yaml new file mode 100644 index 00000000..f9182c5c --- /dev/null +++ b/yaml/BalancePlatformNotificationService-v1.yaml @@ -0,0 +1,1561 @@ +openapi: 3.1.0 +info: + version: '1' + x-publicVersion: true + title: Balance Platform Notification Webhooks + description: 'Adyen sends notifications through webhooks to inform your system about + events that occur in the balance platform. These events include when a card user + makes a payment, or when a merchant starts a refund. When an event occurs, Adyen + makes an HTTP POST request to a URL on your server and includes the details of + the event in the request body. + + + You can use webhooks to build your implementations. For example, you can use the + information to update balances in your own dashboards or to keep track of incoming + funds. + + + Refer to [Notification webhooks](https://docs.adyen.com/issuing/notification-webhooks) + for more information.' + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- Account holder and balance account +- Payment Instrument +- Authorisation, refund, or transfer requests +- Fund movements +x-staticResponse: response.json +webhooks: + balancePlatform.accountHolder.created: + post: + tags: + - Account holder and balance account + summary: Sent when an account holder has been created. + description: Adyen sends this webhook after you successfully [create an account + holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders). + operationId: post-alancePlatform.accountHolder.created + x-groupName: Account holder and balance account + x-sortIndex: 5 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountHolderNotificationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.accountHolder.updated: + post: + tags: + - Account holder and balance account + summary: Sent when an account holder has been updated. + description: Adyen sends this webhook after you successfully [update an account + holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/patch/accountHolders/{id}). + operationId: post-alancePlatform.accountHolder.updated + x-groupName: Account holder and balance account + x-sortIndex: 5 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountHolderNotificationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.balanceAccount.created: + post: + tags: + - Account holder and balance account + summary: Sent when a balance account has been created. + description: Adyen sends this webhook after you successfully [create a balance + account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts). + operationId: post-alancePlatform.balanceAccount.created + x-groupName: Account holder and balance account + x-sortIndex: 5 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BalanceAccountNotificationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.incomingTransfer.created: + post: + tags: + - Fund movements + summary: Sent when there is a pending incoming transfer. + description: 'Adyen sends this webhook when there are incoming funds due to + a refund or a fund transfer. Use the `paymentId` to link to the original refund + request or funds transfer request. Check the content of the webhook to differentiate + the events. + + + * For refunds, the webhook includes the payment instrument to which funds + will be refunded. + + + * For incoming fund transfers, the webhook only includes information about + the balance account.' + operationId: post-alancePlatform.incomingTransfer.created + x-groupName: Fund movements + x-sortIndex: 1 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IncomingTransferNotificationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.incomingTransfer.updated: + post: + tags: + - Fund movements + summary: Sent when funds were added to a balance account. + description: "Adyen sends this webhook when funds were added to the balance\ + \ account. This could be due to a refund or a funds transfer. Use the `data.id`\ + \ to track the original incoming transfer resource in the `balancePlatform.incomingTransfer.created`\ + \ webhook.\n\nThe `status` field indicates the event that triggered the webhook.\ + \ \n\n* For refunds, the `status` will be **Refunded**. \n\n* For incoming\ + \ fund transfers, the `status` will be **IncomingTransfer**." + operationId: post-alancePlatform.incomingTransfer.updated + x-groupName: Fund movements + x-sortIndex: 1 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IncomingTransferNotificationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.outgoingTransfer.created: + post: + tags: + - Fund movements + summary: Sent when funds were deducted from a balance account. + description: "Adyen sends this webhook when funds were deducted from a balance\ + \ account due to a capture or a funds transfer. Use the `paymentId` to link\ + \ to the original payment authorisation or funds transfer request.\n\nThe\ + \ `status` field indicates the event that triggered the webhook. \n\n* For\ + \ captures, the `status` will be **Captured**. \n\n* For outgoing fund transfers,\ + \ the `status` will be **OutgoingTransfer**." + operationId: post-alancePlatform.outgoingTransfer.created + x-groupName: Fund movements + x-sortIndex: 1 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OutgoingTransferNotificationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.outgoingTransfer.updated: + post: + tags: + - Fund movements + summary: Sent when there is an update after funds were deducted from a balance + account. + description: 'Adyen sends this webhook when there is updated information after + funds have been deducted from a balance account. For example, if the fund + transfer failed. + + + Use the `data.id` to track the original outgoing transfer resource from the + `balancePlatform.outgoingTransfer.created` webhook.' + operationId: post-alancePlatform.outgoingTransfer.updated + x-groupName: Fund movements + x-sortIndex: 1 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OutgoingTransferNotificationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.payment.created: + post: + tags: + - Authorisation, refund, or transfer requests + summary: 'Sent when a payment authorisation, refund, or funds transfer has been + initiated. ' + description: "Adyen sends this webhook when a payment authorisation, a refund,\ + \ or a funds transfer has been initiated. This webhook only informs your server\ + \ of requests. For the actual fund movements, you'll get the information from\ + \ the subsequent outgoing or incoming transfer webhooks.\n\n To differentiate\ + \ the requests, check the content of the webhook.\n\n* For payments, the webhook\ + \ contains the authorisation result, information about the processing merchant,\ + \ and shows a negative amount.\n\n * For refunds, the webhook contains to\ + \ which payment instrument the funds will be refunded, and shows a positive\ + \ amount.\n\n* For outgoing or incoming fund transfers, the webhook shows\ + \ a positive or negative amount depending on the direction of the transfer,\ + \ and only includes information about the balance account.\n\nRefer to webhooks\ + \ for [payment events](https://docs.adyen.com/issuing/notification-types/payment-events)\ + \ and [fund transfers](https://docs.adyen.com/issuing/notification-types/fund-transfers-webhooks)\ + \ for more information." + operationId: post-alancePlatform.payment.created + x-groupName: Authorisation, refund, or transfer requests + x-sortIndex: 1 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentNotificationRequest2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.payment.updated: + post: + tags: + - Authorisation, refund, or transfer requests + summary: Sent when a payment authorisation has expired or has been cancelled. + description: Adyen sends this webhook when a payment authorisation has expired + or has been cancelled. Use the `data.id` to track the original payment authorisation + from the `balancePlatform.payment.created` webhook. + operationId: post-alancePlatform.payment.updated + x-groupName: Authorisation, refund, or transfer requests + x-sortIndex: 1 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentNotificationRequest2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.paymentInstrument.created: + post: + tags: + - Payment Instrument + summary: Sent when a payment instrument has been created. + description: Adyen sends this webhook after you successfully [create a payment + instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments). + When creating a virtual card, note that the notification does not include + the card number. You can only get the card number in the POST response. + operationId: post-alancePlatform.paymentInstrument.created + x-groupName: Payment Instrument + x-sortIndex: 3 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentNotificationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. + balancePlatform.paymentInstrument.updated: + post: + tags: + - Payment Instrument + summary: Sent when a payment instrument has been updated. + description: 'Adyen sends this webhook after you successfully [update a payment + instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/patch/paymentInstruments/{id}). ' + operationId: post-alancePlatform.paymentInstrument.updated + x-groupName: Payment Instrument + x-sortIndex: 3 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentNotificationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BalancePlatformNotificationResponse' + description: OK - the request has succeeded. +components: + schemas: + AccountHolder: + properties: + balancePlatform: + description: Unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) + where the account holder belongs. Required in the request if your API + credentials has access to multiple balance platforms. + type: string + contactDetails: + description: Contact details of the account holder. + $ref: '#/components/schemas/ContactDetails' + description: + description: Your description for the account holder, maximum 300 characters. + maxLength: 300 + type: string + id: + description: Unique identifier of the account holder. + type: string + legalEntityId: + description: 'The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities) + associated with the account holder. Adyen performs the Know Your Customer + (KYC) verification process against the legal entity of the account holder. + + + To create a legal entity, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).' + type: string + reference: + description: Your reference to the account holder, maximum 150 characters. + maxLength: 150 + type: string + status: + description: "The status of the account holder.\n\nPossible values: \n\n\ + \ * **Active**: The account holder is active. This the default status\ + \ when creating an account holder. \n\n * **Suspended**: The account holder\ + \ is temporarily suspended. You can set the account back to active or\ + \ permanently close the account. \n\n* **Closed**: The account holder\ + \ is permanently closed. This action cannot be undone." + enum: + - Active + - Closed + - Inactive + - Suspended + type: string + sweepConfigurations: + additionalProperties: + $ref: '#/components/schemas/SweepConfiguration' + description: "Contains key-value pairs that specify configurations for balance\ + \ sweeps per currency code. A sweep pulls in or pushes out funds based\ + \ on a defined schedule, amount, and a source (for pulling funds) or a\ + \ destination (for pushing funds).\n\n Sweep configurations on the account\ + \ holder level applies to all the account holder's balance accounts.\n\ + \n The key must be a currency code in the three-character [ISO currency\ + \ code](https://docs.adyen.com/development-resources/currency-codes) format\ + \ and in uppercase. For example, **EUR**. The value must be an object\ + \ containing the sweep configuration.\n\n" + type: object + required: + - contactDetails + - id + AccountHolderNotificationData: + properties: + accountHolder: + $ref: '#/components/schemas/AccountHolder' + balancePlatform: + description: The ID of the balance platform. + type: string + AccountHolderNotificationRequest: + properties: + data: + description: Contains the event details. + $ref: '#/components/schemas/AccountHolderNotificationData' + environment: + description: 'The environment from where the webhook originated. + + + Possible values: **test**, **live**.' + type: string + type: + description: The type of the notification. + enum: + - balancePlatform.accountHolder.updated + - balancePlatform.accountHolder.created + type: string + Address2: + properties: + city: + description: The name of the city. + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > 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. + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + 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`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + 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 amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - value + - currency + Authentication: + properties: + password: + description: "The password used for 3D Secure password-based authentication.\ + \ The value must be between 1 to 30 characters and must only contain the\ + \ following supported characters.\n\n- Characters between **a-z**, **A-Z**,\ + \ and **0-9**\n\n- Special characters: **\xE4\xF6\xFC\xDF\xC4\xD6\xDC\ + +-*/\xE7%()=?!~#'\",;:$&\xE0\xF9\xF2\xE2\xF4\xFB\xE1\xFA\xF3**" + type: string + phone: + description: 'The phone number where the one-time password (OTP) is sent. + + + This object must have: + + + - A `type` set to **mobile**. + + + - A `number` with a valid country code. + + + - A `number` with more than 4 digits, excluding the country code. + + + >Make sure to verify that the card user owns the phone number.' + $ref: '#/components/schemas/Phone' + Balance: + properties: + available: + description: The remaining amount available for spending. + format: int64 + type: integer + balance: + description: The total amount in the balance. + format: int64 + type: integer + currency: + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) + of the balance. + type: string + reserved: + description: The amount reserved for payments that have been authorised, + but have not been captured yet. + format: int64 + type: integer + required: + - currency + - balance + - reserved + - available + BalanceAccount: + properties: + accountHolderId: + description: Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}) + associated with the balance account. + type: string + balances: + description: List of balances with the amount and currency. + items: + $ref: '#/components/schemas/Balance' + type: array + defaultCurrencyCode: + description: 'The default currency code of this balance account, in three-character + [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) + format. + + The default value is **EUR**.' + type: string + description: + description: A human-readable description of the balance account, maximum + 300 characters. You can use this parameter to help distinguish between + multiple balance accounts under an account holder. + maxLength: 300 + type: string + id: + description: Unique identifier of the balance account. + type: string + paymentInstruments: + description: List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstruments/{id}__queryParam_id) + associated with the balance account. + items: + $ref: '#/components/schemas/PaymentInstrumentReference' + type: array + reference: + description: Your reference to the balance account, maximum 150 characters. + maxLength: 150 + type: string + status: + description: "The status of the balance account, set to **Active** by default.\ + \ \n" + type: string + sweepConfigurations: + additionalProperties: + $ref: '#/components/schemas/SweepConfiguration' + description: 'Contains key-value pairs that specify configurations for balance + sweeps per currency code. A sweep pulls in or pushes out funds based on + a defined schedule, amount, and a source (for pulling funds) or a destination + (for pushing funds). + + + Sweep configurations on the balance account override [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/accountHolders__reqParam_sweepConfigurations) + configurations. + + + The key must be a currency code in the three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) + format and in uppercase. For example, **EUR**. The value must be an object + containing the sweep configuration.' + type: object + required: + - accountHolderId + - id + BalanceAccountNotificationData: + properties: + balanceAccount: + $ref: '#/components/schemas/BalanceAccount' + balancePlatform: + description: The ID of the balance platform. + type: string + BalanceAccountNotificationRequest: + properties: + data: + description: Contains the event details. + $ref: '#/components/schemas/BalanceAccountNotificationData' + environment: + description: 'The environment from where the webhook originated. + + + Possible values: **test**, **live**.' + type: string + type: + description: The type of the notification. + enum: + - balancePlatform.balanceAccount.updated + - balancePlatform.balanceAccount.created + type: string + BalancePlatformNotificationData: + properties: + balancePlatform: + description: The ID of the balance platform. + type: string + creationDate: + description: Date and time when the resource was created, in ISO 8601 extended + offset date-time format. For example, `2020-12-18T10:15:30+01:00`. + format: date-time + type: string + id: + description: The ID of the resource. + type: string + BalancePlatformNotificationResponse: + properties: + notificationResponse: + description: Respond with an **HTTP 200 OK** and `[accepted]` in the response + body to [accept the webhook](https://docs.adyen.com/issuing/notification-webhooks#accept-notifications). + type: string + Card: + properties: + authentication: + description: Authentication details for 3D Secure and wallet activation. + $ref: '#/components/schemas/Authentication' + bin: + description: The BIN of the card number. + type: string + brand: + description: 'The brand for the payment instrument. + + Possible values: **visa**, **mc**.' + type: string + brandVariant: + description: 'The brand variant for the payment instrument. + + >Contact your Adyen Implementation Manager to get the values that are + relevant to your integration. Examples: **visadebit**, **mcprepaid**.' + type: string + cardholderName: + description: The name of the card holder. Maximum length 26 characters. + type: string + configuration: + description: Specific settings for this card, including the configuration + profile. + $ref: '#/components/schemas/CardConfiguration' + cvc: + description: 'The CVC2 value of the card. + + > The CVC2 is not sent by default. This is only returned in the `POST` + response for single-use virtual cards.' + type: string + deliveryContact: + description: The delivery contact (name and address) for physical card delivery. + $ref: '#/components/schemas/Contact' + expiration: + description: The expiration date of the card. + $ref: '#/components/schemas/Expiry' + formFactor: + description: 'The form factor of the card. + + Possible values: **virtual**, **physical**.' + enum: + - physical + - unknown + - virtual + type: string + lastFour: + description: Last last four digits of the card number. + type: string + number: + description: 'The primary account number of the card. + + > The primary account number is masked by default. The full primary account + number is only returned for single-use virtual cards.' + readOnly: true + type: string + required: + - formFactor + - cardholderName + - brand + - brandVariant + - number + CardConfiguration: + properties: + activationUrl: + description: The activation URL of the card configuration profile. + type: string + cardImageId: + description: The Entity Reference of the card image. + type: string + carrierImageId: + description: The Entity Reference of the carrier image. + type: string + configurationProfileId: + description: The ID of the card configuration profile. + type: string + currency: + description: The ISO-4217 currency code for the card. For example **EUR**. + type: string + language: + description: The ISO-639-1 application language for the card. For example, + **en**. + type: string + logoImageId: + description: The Entity Reference of the logo image. + type: string + Contact: + properties: + address: + description: The address of the contact. + $ref: '#/components/schemas/Address2' + email: + description: The e-mail address of the contact. + type: string + fullPhoneNumber: + description: 'The phone number of the contact provided as a single string. It + will be handled as a landline phone. + + **Examples:** "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"' + type: string + name: + description: The name of the contact. + $ref: '#/components/schemas/Name2' + personalData: + description: Personal data of the contact. + $ref: '#/components/schemas/PersonalData' + phoneNumber: + description: The phone number of the contact. + $ref: '#/components/schemas/PhoneNumber2' + webAddress: + description: The URL of the website of the contact. + type: string + ContactDetails: + properties: + address: + description: The address of the account holder. + $ref: '#/components/schemas/Address2' + email: + description: The e-mail address of the account holder. + type: string + phone: + description: The phone number of the account holder. + $ref: '#/components/schemas/Phone' + webAddress: + description: URL to the website of the account holder. + type: string + required: + - email + - phone + - address + Expiry: + properties: + month: + description: The month in which the card will expire. + type: string + year: + description: The year in which the card will expire. + type: string + IncomingTransferNotificationData: + properties: + accountHolder: + description: Contains information about the account holder. + $ref: '#/components/schemas/ResourceReference' + amount: + description: "The amount converted to the balance account's currency, in\ + \ case the original transaction currency is different.\n\n * A _positive_\ + \ value means an addition to the balance account, as a result of a refund\ + \ or an incoming transfer.\n\n * A _negative_ value means a deduction\ + \ from the balance account, as a result of a payment or an outgoing transfer. " + $ref: '#/components/schemas/Amount' + balanceAccount: + description: Contains information about the balance account. + $ref: '#/components/schemas/ResourceReference' + balancePlatform: + description: The ID of the balance platform. + type: string + creationDate: + description: Date and time when the resource was created, in ISO 8601 extended + offset date-time format. For example, `2020-12-18T10:15:30+01:00`. + format: date-time + type: string + id: + description: The ID of the resource. + type: string + originalAmount: + description: "The amount in the original currency of the transaction.\n\n\ + * A _positive_ value means an addition to the balance account, as a result\ + \ of a refund or an incoming transfer.\n\n * A _negative_ value means\ + \ a deduction from the balance account, as a result of a payment or an\ + \ outgoing transfer. " + $ref: '#/components/schemas/Amount' + paymentId: + description: The ID of the original payment authorisation, refund, or funds + transfer request. Use this to trace the original request from the `balancePlatform.payment.created` + webhook. + type: string + paymentInstrument: + description: Contains information about the payment instrument. + $ref: '#/components/schemas/ResourceReference' + platformPayment: + description: Contains information about the related platform payment. + $ref: '#/components/schemas/PlatformPayment' + status: + description: "The event status. The possible values depend on the `type`.\n\ + \n* **Authorised**, **Refused**, or **Error** for type `balancePlatform.payment.created`\n\ + \n * **Expired** or **Cancelled** for type `balancePlatform.payment.updated`\n\ + \n* **PendingIncomingTransfer** for type `balancePlatform.incomingTransfer.created`\ + \ \n\n* **Refunded** or **IncomingTransfer** for type `balancePlatform.incomingTransfer.updated`\n\ + \n * **Captured** or **OutgoingTransfer** for type `balancePlatform.outgoingTransfer.created`\n\ + \n* **TransferConfirmed**, **TransferSentOut**, or **TransferFailed**\ + \ for type `balancePlatform.outgoingTransfer.updated`\n\n " + type: string + valueDate: + description: Indicates the expected settlement date of this transaction. + format: date-time + type: string + IncomingTransferNotificationRequest: + properties: + data: + description: Contains details about the event. + $ref: '#/components/schemas/IncomingTransferNotificationData' + environment: + description: 'The environment from where the webhook originated. + + + Possible values: **test**, **live**.' + type: string + type: + description: The type of the notification. + enum: + - balancePlatform.incomingTransfer.updated + - balancePlatform.incomingTransfer.created + type: string + MerchantData: + properties: + mcc: + description: The merchant category code. + type: string + merchantId: + description: The merchant identifier. + type: string + nameLocation: + description: Contains the merchant's name and location. + $ref: '#/components/schemas/NameLocation' + Name2: + properties: + firstName: + description: The first name. + type: string + lastName: + description: The last name. + type: string + required: + - firstName + - lastName + NameLocation: + properties: + city: + description: The city where the merchant is located. + type: string + country: + description: The country where the merchant is located in [three-letter + country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format. + type: string + countryOfOrigin: + description: The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) + format, used for government-controlled merchants such as embassies. + type: string + name: + description: The name of the merchant's shop or service. + type: string + rawData: + description: The raw data. + type: string + state: + description: The state where the merchant is located. + type: string + NotificationModificationData: + properties: + amount: + description: "The modification amount converted to the balance account's\ + \ currency, in case the original transaction currency is different.\n\n\ + \ * A _positive_ value means an addition to the balance account, as a\ + \ result of a refund or an incoming transfer.\n\n * A _negative_ value\ + \ means a deduction from the balance account, as a result of a payment\ + \ or an outgoing transfer. " + $ref: '#/components/schemas/Amount' + type: + description: The type of the modification that generates this notification. + type: string + OutgoingTransferNotificationData: + properties: + accountHolder: + description: Contains information about the account holder. + $ref: '#/components/schemas/ResourceReference' + amount: + description: "The amount converted to the balance account's currency, in\ + \ case the original transaction currency is different.\n\n * A _positive_\ + \ value means an addition to the balance account, as a result of a refund\ + \ or an incoming transfer.\n\n * A _negative_ value means a deduction\ + \ from the balance account, as a result of a payment or an outgoing transfer. " + $ref: '#/components/schemas/Amount' + balanceAccount: + description: Contains information about the balance account. + $ref: '#/components/schemas/ResourceReference' + balancePlatform: + description: The ID of the balance platform. + type: string + creationDate: + description: Date and time when the resource was created, in ISO 8601 extended + offset date-time format. For example, `2020-12-18T10:15:30+01:00`. + format: date-time + type: string + id: + description: The ID of the resource. + type: string + merchantData: + description: Contains information about the merchant that processed the + payment. This object is only included for payment authorisation requests + and captures. + $ref: '#/components/schemas/MerchantData' + originalAmount: + description: "The amount in the original currency of the transaction.\n\n\ + * A _positive_ value means an addition to the balance account, as a result\ + \ of a refund or an incoming transfer.\n\n * A _negative_ value means\ + \ a deduction from the balance account, as a result of a payment or an\ + \ outgoing transfer. " + $ref: '#/components/schemas/Amount' + paymentId: + description: The ID of the original payment authorisation, refund, or funds + transfer request. Use this to trace the original request from the `balancePlatform.payment.created` + webhook. + type: string + paymentInstrument: + description: Contains information about the payment instrument. + $ref: '#/components/schemas/ResourceReference' + platformPayment: + description: Contains information about the related platform payment. + $ref: '#/components/schemas/PlatformPayment' + processingType: + description: Contains information about how the payment was processed. For + example, **ecommerce** for online or **pos** for point-of-sale payments. + type: string + purposeCode: + description: Indicates the purpose of the transaction. Adyen sets this to + **payout** when transferring funds out of the balance platform. + type: string + relayedAuthorisationData: + description: If you're using [relayed authorisation](https://docs.adyen.com/issuing/processing-payments-for-cards#relayed-authorisation), + this object contains information from the relayed authorisation response + from your server. + $ref: '#/components/schemas/RelayedAuthorisationData' + status: + description: "The event status. The possible values depend on the `type`.\n\ + \n* **Authorised**, **Refused**, or **Error** for type `balancePlatform.payment.created`\n\ + \n * **Expired** or **Cancelled** for type `balancePlatform.payment.updated`\n\ + \n* **PendingIncomingTransfer** for type `balancePlatform.incomingTransfer.created`\ + \ \n\n* **Refunded** or **IncomingTransfer** for type `balancePlatform.incomingTransfer.updated`\n\ + \n * **Captured** or **OutgoingTransfer** for type `balancePlatform.outgoingTransfer.created`\n\ + \n* **TransferConfirmed**, **TransferSentOut**, or **TransferFailed**\ + \ for type `balancePlatform.outgoingTransfer.updated`\n\n " + type: string + transactionRulesResult: + description: Contains results from the evaluation of [transaction rules](https://docs.adyen.com/issuing/transaction-rules). + $ref: '#/components/schemas/TransactionRulesResult' + valueDate: + description: Indicates the expected settlement date of this transaction. + format: date-time + type: string + OutgoingTransferNotificationRequest: + properties: + data: + description: Contains details about the event. + $ref: '#/components/schemas/OutgoingTransferNotificationData' + environment: + description: 'The environment from where the webhook originated. + + + Possible values: **test**, **live**.' + type: string + type: + description: The type of the notification. + enum: + - balancePlatform.outgoingTransfer.created + - balancePlatform.outgoingTransfer.updated + type: string + PaymentInstrument: + properties: + balanceAccountId: + description: Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) + associated with the payment instrument. + type: string + card: + description: Contains information about the card payment instrument. + $ref: '#/components/schemas/Card' + description: + description: Your description for the payment instrument, maximum 300 characters. + maxLength: 300 + type: string + id: + description: Unique identifier of the payment instrument. + type: string + issuingCountryCode: + description: Country where the payment instrument is being issued, in the + two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + format. For example, **NL**, **US**. + type: string + paymentInstrumentGroupId: + description: The ID of a payment instrument group that this payment instrument + is part of. + type: string + reference: + description: Your reference to the payment instrument, maximum 150 characters. + maxLength: 150 + type: string + status: + x-enum: + - description: The payment instrument has been requested. This state is + applicable when creating physical cards. + value: Requested + - description: The payment instrument is active and can be used to make + payments. + value: Active + - description: The payment instrument is inactive and cannot be used to + make payments. + value: Inactive + - description: The payment instrument is temporarily suspended and cannot + be used to make payments. + value: Suspended + - description: The payment instrument is permanently closed. This action + cannot be undone. + value: Closed + description: "The status of the payment instrument. If a status is not specified\ + \ when creating a payment instrument, the status is set to **Active**\ + \ by default. However, there can be exceptions based on the `card.formFactor`\ + \ and the `issuingCountryCode`. For example, when issuing physical cards\ + \ issued in the US, the default status is **Requested**.\n\nPossible values:\ + \ \n\n * **Active**: The payment instrument is active and can be used\ + \ to make payments. \n\n * **Requested**: The payment instrument has been\ + \ requested. This state is applicable when creating physical cards. \n\ + \n* **Inactive**: The payment instrument is inactive and cannot be used\ + \ to make payments. \n\n * **Suspended**: The payment instrument is temporarily\ + \ suspended and cannot be used to make payments. \n\n * **Closed**: The\ + \ payment instrument is permanently closed. This action cannot be undone.\ + \ \n\n* **Stolen** \n\n * **Lost**\n\n " + enum: + - Active + - Closed + - Inactive + - Lost + - Requested + - Stolen + - Suspended + type: string + type: + description: 'The type of payment instrument. + + + Possible value: **card** ' + enum: + - bankAccount + - card + - unknown + type: string + required: + - balanceAccountId + - issuingCountryCode + - type + - id + PaymentInstrumentNotificationData: + properties: + balancePlatform: + description: The ID of the balance platform. + type: string + paymentInstrument: + $ref: '#/components/schemas/PaymentInstrument' + PaymentInstrumentReference: + properties: + id: + description: Unique identifier of the payment instrument. + type: string + required: + - id + PaymentNotificationData: + properties: + accountHolder: + description: Contains information about the account holder. + $ref: '#/components/schemas/ResourceReference' + amount: + description: "The amount converted to the balance account's currency, in\ + \ case the original transaction currency is different.\n\n * A _positive_\ + \ value means an addition to the balance account, as a result of a refund\ + \ or an incoming transfer.\n\n * A _negative_ value means a deduction\ + \ from the balance account, as a result of a payment or an outgoing transfer. " + $ref: '#/components/schemas/Amount' + authCode: + description: The authorisation code for the payment. + type: string + balanceAccount: + description: Contains information about the balance account. + $ref: '#/components/schemas/ResourceReference' + balancePlatform: + description: The ID of the balance platform. + type: string + creationDate: + description: Date and time when the resource was created, in ISO 8601 extended + offset date-time format. For example, `2020-12-18T10:15:30+01:00`. + format: date-time + type: string + id: + description: The ID of the resource. + type: string + merchantData: + description: Contains information about the merchant that processed the + payment. This object is only included for payment authorisation requests + and captures. + $ref: '#/components/schemas/MerchantData' + originalAmount: + description: "The amount in the original currency of the transaction.\n\n\ + * A _positive_ value means an addition to the balance account, as a result\ + \ of a refund or an incoming transfer.\n\n * A _negative_ value means\ + \ a deduction from the balance account, as a result of a payment or an\ + \ outgoing transfer. " + $ref: '#/components/schemas/Amount' + paymentInstrument: + description: Contains information about the payment instrument. + $ref: '#/components/schemas/ResourceReference' + platformPayment: + description: Contains information about the related platform payment. + $ref: '#/components/schemas/PlatformPayment' + processingType: + description: Contains information about how the payment was processed. For + example, **ecommerce** for online or **pos** for point-of-sale payments. + type: string + relayedAuthorisationData: + description: If you're using [relayed authorisation](https://docs.adyen.com/issuing/processing-payments-for-cards#relayed-authorisation), + this object contains information from the relayed authorisation response + from your server. + $ref: '#/components/schemas/RelayedAuthorisationData' + status: + description: "The event status. The possible values depend on the `type`.\n\ + \n* **Authorised**, **Refused**, or **Error** for type `balancePlatform.payment.created`\n\ + \n * **Expired** or **Cancelled** for type `balancePlatform.payment.updated`\n\ + \n* **PendingIncomingTransfer** for type `balancePlatform.incomingTransfer.created`\ + \ \n\n* **Refunded** or **IncomingTransfer** for type `balancePlatform.incomingTransfer.updated`\n\ + \n * **Captured** or **OutgoingTransfer** for type `balancePlatform.outgoingTransfer.created`\n\ + \n* **TransferConfirmed**, **TransferSentOut**, or **TransferFailed**\ + \ for type `balancePlatform.outgoingTransfer.updated`\n\n " + type: string + transactionRulesResult: + description: Contains results from the evaluation of [transaction rules](https://docs.adyen.com/issuing/transaction-rules). + $ref: '#/components/schemas/TransactionRulesResult' + validationResult: + description: Array of checks that Adyen performed to validate the payment + and the result of each. + items: + $ref: '#/components/schemas/ValidationResult' + type: array + PaymentNotificationRequest: + properties: + data: + description: Contains the event details. + $ref: '#/components/schemas/PaymentInstrumentNotificationData' + environment: + description: 'The environment from where the webhook originated. + + + Possible values: **test**, **live**.' + type: string + type: + description: The type of the notification. + enum: + - balancePlatform.paymentInstrument.created + - balancePlatform.paymentInstrument.updated + type: string + PaymentNotificationRequest2: + properties: + data: + description: Contains details about the event. + $ref: '#/components/schemas/PaymentNotificationData' + environment: + description: 'The environment from where the webhook originated. + + + Possible values: **test**, **live**.' + type: string + type: + description: The type of the notification. + enum: + - balancePlatform.payment.created + - balancePlatform.payment.updated + type: string + PersonalData: + properties: + dateOfBirth: + description: 'The date of birth of the person. + + The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).' + type: string + idNumber: + description: An ID number of the person. + type: string + nationality: + description: 'The nationality of the person represented by a two-character + country code. + + >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').' + maxLength: 2 + minLength: 2 + type: string + Phone: + properties: + number: + description: "The full phone number provided as a single string. \nFor example,\ + \ **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, \n\n or **\"(0031)\ + \ 611223344\"**." + type: string + type: + description: "The type of phone number.\nPossible values: \n**Landline**,\ + \ **Mobile**.\n" + enum: + - Landline + - Mobile + type: string + required: + - number + - type + PhoneNumber2: + properties: + phoneCountryCode: + description: 'The two-character country code of the phone number. + + >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').' + type: string + phoneNumber: + description: 'The phone number. + + >The inclusion of the phone number country code is not necessary.' + type: string + phoneType: + description: 'The type of the phone number. + + >The following values are permitted: `Landline`, `Mobile`, `SIP`, `Fax`.' + enum: + - Fax + - Landline + - Mobile + - SIP + type: string + required: + - phoneCountryCode + - phoneNumber + PlatformPayment: + properties: + account: + description: The account given in the related split. + type: string + description: + description: The description of the related split. + type: string + modificationMerchantReference: + description: The merchant reference of the modification. + type: string + modificationPspReference: + description: The pspReference of the modification. + type: string + paymentMerchantReference: + description: The merchant reference of the payment. + type: string + paymentPspReference: + description: The pspReference of the payment. + type: string + reference: + description: The reference of the related split. + type: string + type: + description: The type of the related split. + enum: + - BalanceAccount + - Commission + - Default + - PaymentFee + - VAT + type: string + RelayedAuthorisationData: + properties: + metadata: + additionalProperties: + type: string + description: The `metadata` object from the relayed authorisation response + from your server. + type: object + reference: + description: The `reference` from the relayed authorisation response from + your server. + type: string + status: + description: The value can be can be **Authorised** or **Refused**, based + on the `authorisationDecision.status` in the relayed authorisation response + from your server. + type: string + ResourceReference: + properties: + description: + description: The description of the resource. + type: string + id: + description: The unique identifier of the resource. + type: string + reference: + description: The reference of the resource. + type: string + SweepConfiguration: + properties: + balanceAccountId: + description: Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}) + that will be the source or destination of the balance sweep. This can + only be used for periodic sweep schedules such as `schedule.type` **daily** + or **monthly**. + type: string + merchantAccount: + description: The merchant account that will be the source of funds. You + can only use this if you are processing payments with Adyen. This can + only be used for sweeps of `type` **pull** and `schedule.type` **balance**. + type: string + schedule: + description: The schedule when the `triggerAmount` is evaluated. If the + balance meets the threshold, funds are pushed out of or pulled in to the + balance account. + $ref: '#/components/schemas/SweepSchedule' + sweepAmount: + description: The amount that must be pushed out or pulled in. You can configure + only one of `sweepAmount` or `targetAmount`. + $ref: '#/components/schemas/Amount' + targetAmount: + description: The amount that must be available in the balance account after + the sweep. You can configure only one of `sweepAmount` or `targetAmount`. + $ref: '#/components/schemas/Amount' + transferInstrumentId: + description: Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/transferInstruments/{id}__queryParam_id) + that will be the source or destination of the balance sweep. This can + only be used for periodic sweep schedules such as `schedule.type` **daily** + or **monthly**. + type: string + triggerAmount: + description: 'The threshold amount that triggers the sweep. If not specified, + the amount defaults to zero. The `triggerAmount` is evaluated at the specified + `schedule.type`. + + + * For `type` **pull**, if the balance is less than or equal to the `triggerAmount`, + funds will be pulled in to the balance account. + + + * For `type` **push**, if the balance is more than or equal to the `triggerAmount`, + funds will be pushed out of the balance account.' + $ref: '#/components/schemas/Amount' + type: + default: push + description: "The direction of sweep. Possible values:\n\n * **push**: _Push\ + \ funds out_ to a destination balance account or transfer instrument.\n\ + \n * **pull**: _Pull funds in_ from a source merchant account or balance\ + \ account. " + enum: + - pull + - push + type: string + required: + - schedule + - type + SweepSchedule: + properties: + type: + description: 'The schedule type. + + + Possible values: + + + * **daily**: Push out funds daily at 07:00 AM CET. + + + * **weekly**: Push out funds every Monday at 07:00 AM CET. + + + * **monthly**: Push out funds every 1st of the month at 07:00 AM CET. + + + * **balance**: Only for sweeps of `type` **pull** and with a `merchantAccount` + source. Pull in funds instantly if the balance is less than or equal to + the `triggerAmount`.' + enum: + - balance + - daily + - monthly + - weekly + type: string + TransactionEventViolation: + properties: + reason: + description: An explanation about why the transaction rule failed. + type: string + transactionRule: + description: Contains information about the transaction rule. + $ref: '#/components/schemas/ResourceReference' + transactionRuleSource: + description: Contains the type and ID of the resource where the transaction + rule is linked. + $ref: '#/components/schemas/TransactionRuleSource' + TransactionNotificationData: + properties: + accountHolder: + description: Contains information about the account holder. + $ref: '#/components/schemas/ResourceReference' + amount: + description: "The amount converted to the balance account's currency, in\ + \ case the original transaction currency is different.\n\n * A _positive_\ + \ value means an addition to the balance account, as a result of a refund\ + \ or an incoming transfer.\n\n * A _negative_ value means a deduction\ + \ from the balance account, as a result of a payment or an outgoing transfer. " + $ref: '#/components/schemas/Amount' + authCode: + description: The authorisation code for the payment. + type: string + balanceAccount: + description: Contains information about the balance account. + $ref: '#/components/schemas/ResourceReference' + balancePlatform: + description: The ID of the balance platform. + type: string + creationDate: + description: Date and time when the resource was created, in ISO 8601 extended + offset date-time format. For example, `2020-12-18T10:15:30+01:00`. + format: date-time + type: string + id: + description: The ID of the resource. + type: string + merchantData: + description: Contains information about the merchant that processed the + payment. This object is only included for payment authorisation requests + and captures. + $ref: '#/components/schemas/MerchantData' + originalAmount: + description: "The amount in the original currency of the transaction.\n\n\ + * A _positive_ value means an addition to the balance account, as a result\ + \ of a refund or an incoming transfer.\n\n * A _negative_ value means\ + \ a deduction from the balance account, as a result of a payment or an\ + \ outgoing transfer. " + $ref: '#/components/schemas/Amount' + paymentId: + description: The ID of the original payment authorisation, refund, or funds + transfer request. Use this to trace the original request from the `balancePlatform.payment.created` + webhook. + type: string + paymentInstrument: + description: Contains information about the payment instrument. + $ref: '#/components/schemas/ResourceReference' + platformPayment: + description: Contains information about the related platform payment. + $ref: '#/components/schemas/PlatformPayment' + processingType: + description: Contains information about how the payment was processed. For + example, **ecommerce** for online or **pos** for point-of-sale payments. + type: string + purposeCode: + description: Indicates the purpose of the transaction. Adyen sets this to + **payout** when transferring funds out of the balance platform. + type: string + relayedAuthorisationData: + description: If you're using [relayed authorisation](https://docs.adyen.com/issuing/processing-payments-for-cards#relayed-authorisation), + this object contains information from the relayed authorisation response + from your server. + $ref: '#/components/schemas/RelayedAuthorisationData' + status: + description: "The event status. The possible values depend on the `type`.\n\ + \n* **Authorised**, **Refused**, or **Error** for type `balancePlatform.payment.created`\n\ + \n * **Expired** or **Cancelled** for type `balancePlatform.payment.updated`\n\ + \n* **PendingIncomingTransfer** for type `balancePlatform.incomingTransfer.created`\ + \ \n\n* **Refunded** or **IncomingTransfer** for type `balancePlatform.incomingTransfer.updated`\n\ + \n * **Captured** or **OutgoingTransfer** for type `balancePlatform.outgoingTransfer.created`\n\ + \n* **TransferConfirmed**, **TransferSentOut**, or **TransferFailed**\ + \ for type `balancePlatform.outgoingTransfer.updated`\n\n " + type: string + transactionRulesResult: + description: Contains results from the evaluation of [transaction rules](https://docs.adyen.com/issuing/transaction-rules). + $ref: '#/components/schemas/TransactionRulesResult' + validationResult: + description: Array of checks that Adyen performed to validate the payment + and the result of each. + items: + $ref: '#/components/schemas/ValidationResult' + type: array + valueDate: + description: Indicates the expected settlement date of this transaction. + format: date-time + type: string + TransactionRuleSource: + properties: + id: + description: ID of the resource, when applicable. + type: string + type: + description: "Indicates the type of resource for which the transaction rule\ + \ is defined.\n\nPossible values:\n\n - **PaymentInstrumentGroup**\n\n\ + - **PaymentInstrument**\n\n- **BalancePlatform**\n\n- **EntityUsageConfiguration**\n\ + \n- **PlatformRule**: The transaction rule is a platform-wide rule imposed\ + \ by Adyen." + type: string + TransactionRulesResult: + properties: + allRulesPassed: + description: Whether the transaction passed the evaluation for all transaction + rules. + type: boolean + failedTransactionRules: + description: Array containing all the transaction rules that the transaction + violated. This list is only sent when `allRulesPassed` is **false**. + items: + $ref: '#/components/schemas/TransactionEventViolation' + type: array + ValidationResult: + properties: + result: + description: 'The result of the check. + + + Possible values: + + + - **valid** - The validation was successful. + + + - **invalid** - The validation failed. + + + - **notValidated** - The validation was not performed because some services + were unreachable or Adyen does not have the information needed to perform + the check. + + + - **notApplicable** - The validation is not applicable.' + type: string + type: + description: The type of check. + type: string + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: {} diff --git a/yaml/BalancePlatformService-v1.yaml b/yaml/BalancePlatformService-v1.yaml index 5d5fadf3..3cc7ce7a 100644 --- a/yaml/BalancePlatformService-v1.yaml +++ b/yaml/BalancePlatformService-v1.yaml @@ -40,17 +40,20 @@ x-groups: paths: /accountHolders: post: + tags: + - Account holders summary: Create an account holder. description: 'Creates an account holder. This resource represents your user''s entity within the balance platform. For more information, refer to [Create accounts](https://docs.adyen.com/issuing/create-accounts).' - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-accountHolders x-groupName: Account holders x-sortIndex: 1 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -65,8 +68,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/post-accountHolders-success-200' + success: + $ref: '#/components/examples/post-accountHolders-success' schema: $ref: '#/components/schemas/AccountHolder' description: OK - the request has succeeded. @@ -74,8 +77,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -83,8 +86,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -92,8 +95,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -101,8 +104,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -110,20 +113,23 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /accountHolders/{id}: get: + tags: + - Account holders summary: Retrieve an account holder. description: Returns a specific account holder. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-accountHolders-id x-groupName: Account holders x-sortIndex: 3 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the account holder. @@ -137,8 +143,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-accountHolders-id-success-200' + success: + $ref: '#/components/examples/get-accountHolders-id-success' schema: $ref: '#/components/schemas/AccountHolder' description: OK - the request has succeeded. @@ -146,8 +152,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -155,8 +161,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -164,8 +170,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -173,8 +179,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -182,12 +188,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Account holders summary: Update an account holder. description: 'Updates a specific account holder. When updating an account holder resource, note that: @@ -198,11 +206,12 @@ paths: * When updating any parameter in the `contactDetails` object, you must send all other existing `contactDetails` parameters.' - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: patch-accountHolders-id x-groupName: Account holders x-sortIndex: 2 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -224,8 +233,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/patch-accountHolders-id-success-200' + success: + $ref: '#/components/examples/patch-accountHolders-id-success' schema: $ref: '#/components/schemas/AccountHolder' description: OK - the request has succeeded. @@ -233,8 +242,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -242,8 +251,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -251,8 +260,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -260,8 +269,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -269,23 +278,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /accountHolders/{id}/balanceAccounts: get: + tags: + - Account holders summary: Retrieve all balance accounts of a specific account holder. description: "Returns a paginated list of balance accounts associated with a\ \ specific account holder. To fetch multiple pages, use the query parameters.\ \ \n\nFor example, to limit the page to 5 balance accounts and to skip the\ \ first 10: `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`." - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-accountHolders-id-balanceAccounts x-groupName: Account holders x-sortIndex: 4 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the account holder. @@ -314,8 +326,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-accountHolders-id-balanceAccounts-success-200' + success: + $ref: '#/components/examples/get-accountHolders-id-balanceAccounts-success' schema: $ref: '#/components/schemas/PaginatedBalanceAccountsResponse' description: OK - the request has succeeded. @@ -323,8 +335,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -332,8 +344,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -341,8 +353,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -350,8 +362,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -359,22 +371,25 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /balanceAccounts: post: + tags: + - Balance accounts summary: Create a balance account. description: "Creates a balance account. The balance account resource holds\ \ the funds of the associated account holder. \n\nFor more information, refer\ \ to [Create accounts](https://docs.adyen.com/issuing/create-accounts)." - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-balanceAccounts x-groupName: Balance accounts x-sortIndex: 1 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -389,8 +404,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/post-balanceAccounts-success-200' + success: + $ref: '#/components/examples/post-balanceAccounts-success' schema: $ref: '#/components/schemas/BalanceAccount' description: OK - the request has succeeded. @@ -398,8 +413,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -407,8 +422,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -416,8 +431,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -425,8 +440,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -434,20 +449,23 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /balanceAccounts/{id}: get: + tags: + - Balance accounts summary: Retrieve a balance account. description: Returns a specific balance account. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-balanceAccounts-id x-groupName: Balance accounts x-sortIndex: 3 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the balance account. @@ -461,8 +479,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-balanceAccounts-id-success-200' + success: + $ref: '#/components/examples/get-balanceAccounts-id-success' schema: $ref: '#/components/schemas/BalanceAccount' description: OK - the request has succeeded. @@ -470,8 +488,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -479,8 +497,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -488,8 +506,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -497,8 +515,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -506,23 +524,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /balanceAccounts/{id}/paymentInstruments: get: + tags: + - Balance accounts summary: Retrieve all payment instruments for a specific balance account. description: "Returns a paginated list of the payment instruments associated\ \ with a specific balance account. To fetch multiple pages, use the query\ \ parameters. \n\nFor example, to limit the page to 3 payment instruments\ \ and to skip the first 6: `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`" - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-balanceAccounts-id-paymentInstruments x-groupName: Balance accounts x-sortIndex: 4 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the balance account. @@ -551,8 +572,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-balanceAccounts-id-paymentInstruments-success-200' + success: + $ref: '#/components/examples/get-balanceAccounts-id-paymentInstruments-success' schema: $ref: '#/components/schemas/PaginatedPaymentInstrumentsResponse' description: OK - the request has succeeded. @@ -560,8 +581,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -569,8 +590,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -578,8 +599,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -587,8 +608,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -596,20 +617,23 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /balancePlatforms/{id}: get: + tags: + - General summary: Retrieve a balance platform. description: Returns a specific balance platform. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-balancePlatforms-id x-groupName: General x-sortIndex: 0 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the balance platform. @@ -623,8 +647,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-balancePlatforms-id-success-200' + success: + $ref: '#/components/examples/get-balancePlatforms-id-success' schema: $ref: '#/components/schemas/BalancePlatform' description: OK - the request has succeeded. @@ -632,8 +656,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -641,8 +665,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -650,8 +674,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -659,8 +683,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -668,23 +692,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /balancePlatforms/{id}/accountHolders: get: + tags: + - General summary: Retrieve all account holders under a specific balance platform. description: "Returns a paginated list of all the account holders that belong\ \ to the balance platform. To fetch multiple pages, use the query parameters.\ \ \n\nFor example, to limit the page to 5 account holders and to skip the\ \ first 20: `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`." - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-balancePlatforms-id-accountHolders x-groupName: General x-sortIndex: 0 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the balance platform. @@ -713,8 +740,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-balancePlatforms-id-accountHolders-success-200' + success: + $ref: '#/components/examples/get-balancePlatforms-id-accountHolders-success' schema: $ref: '#/components/schemas/PaginatedAccountHoldersResponse' description: OK - the request has succeeded. @@ -722,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -731,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -740,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -749,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -758,13 +785,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /documents: post: + tags: + - Documents summary: Upload a document for verification checks. description: "Uploads a document for verification checks. Adyen uses the information\ \ from the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities)\ @@ -775,11 +804,12 @@ paths: \ only upload documents when your Adyen contact informs you to provide additional\ \ information for the legal entity. For more information, refer to [Onboard\ \ and verify account holders](https://docs.adyen.com/issuing/kyc-verification)." - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-documents x-groupName: Documents x-sortIndex: 4 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -797,8 +827,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -806,8 +836,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -815,8 +845,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -824,8 +854,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -833,20 +863,23 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /documents/{id}: delete: + tags: + - Documents summary: Delete a document. description: Deletes a document. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: delete-documents-id x-groupName: Documents x-sortIndex: 7 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the document to be deleted. @@ -866,8 +899,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -875,8 +908,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -884,8 +917,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -893,8 +926,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -902,19 +935,22 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. get: + tags: + - Documents summary: Retrieve a document. description: Returns a specific document. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-documents-id x-groupName: Documents x-sortIndex: 5 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the document. @@ -934,8 +970,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -943,8 +979,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -952,8 +988,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -961,8 +997,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -970,19 +1006,22 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Documents summary: Update a document. description: Updates a specific document. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: patch-documents-id x-groupName: Documents x-sortIndex: 6 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -1007,8 +1046,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1016,8 +1055,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1025,8 +1064,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1034,8 +1073,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1043,13 +1082,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /legalEntities: post: + tags: + - Legal entities summary: Create a legal entity. description: "Creates a legal entity. This resource contains information about\ \ an individual or organization that will be onboarded on your balance platform.\ @@ -1058,11 +1099,12 @@ paths: \ you of the status and results of the KYC checks. \n\nWhen the legal entity\ \ passes the verification checks, you can issue a card to them. For more information,\ \ refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification)." - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-legalEntities x-groupName: Legal entities x-sortIndex: 1 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -1080,8 +1122,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1089,8 +1131,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1098,8 +1140,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1107,8 +1149,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1116,20 +1158,23 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /legalEntities/{id}: get: + tags: + - Legal entities summary: Retrieve a legal entity. description: Returns a specific legal entity. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-legalEntities-id x-groupName: Legal entities x-sortIndex: 2 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the legal entity. @@ -1149,8 +1194,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1158,8 +1203,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1167,8 +1212,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1176,8 +1221,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1185,22 +1230,25 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Legal entities summary: Update a legal entity. description: "Updates a legal entity. When updating a legal entity resource,\ \ note that:\n\n * To update the `entityAssociations` array, you need to replace\ \ the entire array. For example, if the array has 3 entries and you want to\ \ remove 1 entry, you need to PATCH the resource with the remaining 2 entries." - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: patch-legalEntities-id x-groupName: Legal entities x-sortIndex: 3 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -1225,8 +1273,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1234,8 +1282,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1243,8 +1291,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1252,8 +1300,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1261,22 +1309,25 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentInstrumentGroups: post: + tags: + - Payment instrument groups summary: Create a payment instrument group. description: Creates a payment instrument group, which you use to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-paymentInstrumentGroups x-groupName: Payment instrument groups x-sortIndex: 1 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -1291,8 +1342,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/post-paymentInstrumentGroups-success-200' + success: + $ref: '#/components/examples/post-paymentInstrumentGroups-success' schema: $ref: '#/components/schemas/PaymentInstrumentGroup' description: OK - the request has succeeded. @@ -1300,8 +1351,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1309,8 +1360,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1318,8 +1369,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1327,8 +1378,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -1336,20 +1387,23 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /paymentInstrumentGroups/{id}: get: + tags: + - Payment instrument groups summary: Retrieve a payment instrument group. description: Returns a specific payment instrument group. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-paymentInstrumentGroups-id x-groupName: Payment instrument groups x-sortIndex: 2 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the payment instrument group. @@ -1363,8 +1417,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-paymentInstrumentGroups-id-success-200' + success: + $ref: '#/components/examples/get-paymentInstrumentGroups-id-success' schema: $ref: '#/components/schemas/PaymentInstrumentGroup' description: OK - the request has succeeded. @@ -1372,8 +1426,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1381,8 +1435,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1390,8 +1444,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1399,8 +1453,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -1408,21 +1462,24 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /paymentInstrumentGroups/{id}/transactionRules: get: + tags: + - Payment instrument groups summary: Retrieve all transaction rules for a specific payment instruments group. description: Returns a list of all the transaction rules associated with a specific payment instrument group. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-paymentInstrumentGroups-id-transactionRules x-groupName: Payment instrument groups x-sortIndex: 3 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the payment instrument group. @@ -1436,8 +1493,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success-200' + success: + $ref: '#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success' schema: $ref: '#/components/schemas/TransactionRulesResponse' description: OK - the request has succeeded. @@ -1445,8 +1502,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1454,8 +1511,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1463,8 +1520,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1472,8 +1529,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -1481,22 +1538,25 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /paymentInstruments: post: + tags: + - Payment instruments summary: Create a payment instrument. description: "Creates a payment instrument, which results in issuing either\ \ a physical or a virtual card to your user.\n\n For more information, refer\ \ to [Create cards](https://docs.adyen.com/issuing/create-cards)." - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-paymentInstruments x-groupName: Payment instruments x-sortIndex: 11 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -1513,8 +1573,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/post-paymentInstruments-success-200' + success: + $ref: '#/components/examples/post-paymentInstruments-success' schema: $ref: '#/components/schemas/PaymentInstrument' description: OK - the request has succeeded. @@ -1522,8 +1582,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1531,8 +1591,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1540,8 +1600,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1549,8 +1609,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -1558,20 +1618,23 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /paymentInstruments/{id}: get: + tags: + - Payment instruments summary: Retrieve a payment instrument. description: Returns a specific payment instrument. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-paymentInstruments-id x-groupName: Payment instruments x-sortIndex: 13 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the payment instrument. @@ -1585,8 +1648,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-paymentInstruments-id-success-200' + success: + $ref: '#/components/examples/get-paymentInstruments-id-success' schema: $ref: '#/components/schemas/PaymentInstrument' description: OK - the request has succeeded. @@ -1594,8 +1657,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1603,8 +1666,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1612,8 +1675,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1621,8 +1684,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -1630,22 +1693,25 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment instruments summary: Update a payment instrument. description: Updates a specific payment instrument. Once a payment instrument is already active, you can only update the status. However, for cards created with a **Requested** or **Inactive** status, you can still update the balance account associated with the card. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: patch-paymentInstruments-id x-groupName: Payment instruments x-sortIndex: 12 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -1669,8 +1735,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/patch-paymentInstruments-id-success-200' + success: + $ref: '#/components/examples/patch-paymentInstruments-id-success' schema: $ref: '#/components/schemas/PaymentInstrument' description: OK - the request has succeeded. @@ -1678,8 +1744,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1687,8 +1753,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1696,8 +1762,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1705,10 +1771,10 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' - invalidData-422: - $ref: '#/components/examples/patch-paymentInstruments-id-invalidData-422' + generic: + $ref: '#/components/examples/generic' + invalidData: + $ref: '#/components/examples/patch-paymentInstruments-id-invalidData' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -1716,21 +1782,24 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /paymentInstruments/{id}/transactionRules: get: + tags: + - Payment instruments summary: Retrieve all transaction rules for a specific payment instrument. description: Returns a list of transaction rules associated to a specific payment instrument. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-paymentInstruments-id-transactionRules x-groupName: Payment instruments x-sortIndex: 14 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the payment instrument. @@ -1744,8 +1813,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-paymentInstruments-id-transactionRules-success-200' + success: + $ref: '#/components/examples/get-paymentInstruments-id-transactionRules-success' schema: $ref: '#/components/schemas/TransactionRulesResponse' description: OK - the request has succeeded. @@ -1753,8 +1822,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1762,8 +1831,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1771,8 +1840,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1780,8 +1849,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -1789,13 +1858,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /transactionRules: post: + tags: + - Transaction rules summary: Create a transaction rule. description: 'Creates a transaction rule. Transaction rules define conditions to automatically approve or deny transactions. You can apply transaction rules @@ -1805,11 +1876,12 @@ paths: For more information on how you can set conditions, refer to [Transaction rules](https://docs.adyen.com/issuing/transaction-rules).' - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-transactionRules x-groupName: Transaction rules x-sortIndex: 1 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -1824,8 +1896,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/post-transactionRules-success-200' + success: + $ref: '#/components/examples/post-transactionRules-success' schema: $ref: '#/components/schemas/TransactionRule' description: OK - the request has succeeded. @@ -1833,8 +1905,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1842,8 +1914,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1851,8 +1923,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1860,8 +1932,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -1869,20 +1941,23 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /transactionRules/{transactionRuleId}: delete: + tags: + - Transaction rules summary: Delete a transaction rule. description: Deletes a transaction rule. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: delete-transactionRules-transactionRuleId x-groupName: Transaction rules x-sortIndex: 5 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the transaction rule. @@ -1896,8 +1971,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/delete-transactionRules-transactionRuleId-success-200' + success: + $ref: '#/components/examples/delete-transactionRules-transactionRuleId-success' schema: $ref: '#/components/schemas/TransactionRule' description: OK - the request has succeeded. @@ -1905,8 +1980,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1914,8 +1989,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1923,8 +1998,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1932,8 +2007,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -1941,19 +2016,22 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. get: + tags: + - Transaction rules summary: Retrieve a transaction rule. description: Returns a specific transaction rule. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-transactionRules-transactionRuleId x-groupName: Transaction rules x-sortIndex: 2 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the transaction rule. @@ -1967,8 +2045,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/get-transactionRules-transactionRuleId-success-200' + success: + $ref: '#/components/examples/get-transactionRules-transactionRuleId-success' schema: $ref: '#/components/schemas/TransactionRuleResponse' description: OK - the request has succeeded. @@ -1976,8 +2054,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1985,8 +2063,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -1994,8 +2072,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -2003,8 +2081,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -2012,12 +2090,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Transaction rules summary: Update a transaction rule. description: "Updates a transaction rule. When updating a transaction rule\ \ resource, note that: \n\n* When updating only the `status`, you can send\ @@ -2025,11 +2105,12 @@ paths: \ are left unchanged.\n\n* When updating any other parameter, you need to\ \ send all existing resource parameters. If you omit a parameter in the request,\ \ the parameter is removed from the resource." - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: patch-transactionRules-transactionRuleId x-groupName: Transaction rules x-sortIndex: 3 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -2051,8 +2132,8 @@ paths: content: application/json: examples: - success-200: - $ref: '#/components/examples/patch-transactionRules-transactionRuleId-success-200' + success: + $ref: '#/components/examples/patch-transactionRules-transactionRuleId-success' schema: $ref: '#/components/schemas/TransactionRule' description: OK - the request has succeeded. @@ -2060,8 +2141,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2069,8 +2150,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. @@ -2078,8 +2159,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. @@ -2087,8 +2168,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -2096,13 +2177,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /transferInstruments: post: + tags: + - Transfer instruments summary: Create a transfer instrument. description: 'Creates a transfer instrument. A transfer instrument is a bank account or other payment details that a legal entity owns. Adyen performs @@ -2114,11 +2197,12 @@ paths: When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).' - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-transferInstruments x-groupName: Transfer instruments x-sortIndex: 8 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -2136,8 +2220,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2145,8 +2229,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -2154,8 +2238,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -2163,8 +2247,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -2172,20 +2256,23 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /transferInstruments/{id}: delete: + tags: + - Transfer instruments summary: Delete a transfer instrument description: Deletes a transfer instrument. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: delete-transferInstruments-id x-groupName: Transfer instruments x-sortIndex: 11 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the transfer instrument to be deleted. @@ -2205,8 +2292,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2214,8 +2301,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -2223,8 +2310,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -2232,8 +2319,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -2241,19 +2328,22 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. get: + tags: + - Transfer instruments summary: Retrieve a transfer instrument. description: Returns a specific transfer instrument. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: get-transferInstruments-id x-groupName: Transfer instruments x-sortIndex: 9 security: + - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Unique identifier of the transfer instrument. @@ -2273,8 +2363,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2282,8 +2372,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -2291,8 +2381,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -2300,8 +2390,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -2309,19 +2399,22 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Transfer instruments summary: Update a transfer instrument. description: Updates a transfer instrument. - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: patch-transferInstruments-id x-groupName: Transfer instruments x-sortIndex: 10 security: + - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: @@ -2346,8 +2439,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2355,8 +2448,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -2364,8 +2457,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -2373,8 +2466,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -2382,8 +2475,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2569,14 +2662,14 @@ components: type: string contentType: deprecated: true - x-deprecatedInVersion: 1 + x-deprecatedInVersion: '1' x-deprecatedMessage: Field is being deprecated. description: "The file format.\n\n Possible values: **application/pdf**,\ \ **image/jpg**, **image/jpeg**, or **image/png**. " type: string filename: deprecated: true - x-deprecatedInVersion: 1 + x-deprecatedInVersion: '1' x-deprecatedMessage: Field is being deprecated. description: The name of the file including the file extension. type: string @@ -2592,12 +2685,29 @@ components: Authentication: properties: password: - description: The password to be used for 3D Secure password-based authentication. + description: "The password used for 3D Secure password-based authentication.\ + \ The value must be between 1 to 30 characters and must only contain the\ + \ following supported characters.\n\n- Characters between **a-z**, **A-Z**,\ + \ and **0-9**\n\n- Special characters: **\xE4\xF6\xFC\xDF\xC4\xD6\xDC\ + +-*/\xE7%()=?!~#'\",;:$&\xE0\xF9\xF2\xE2\xF4\xFB\xE1\xFA\xF3**" type: string phone: - description: 'The phone number to be used for payment authentication. + description: 'The phone number where the one-time password (OTP) is sent. - >Make sure to verify that the account holder owns the phone number.' + + This object must have: + + + - A `type` set to **mobile**. + + + - A `number` with a valid country code. + + + - A `number` with more than 4 digits, excluding the country code. + + + >Make sure to verify that the card user owns the phone number.' $ref: '#/components/schemas/Phone' Balance: properties: @@ -2800,8 +2910,7 @@ components: Card: properties: authentication: - description: Authentication details for 3D Secure and SMS one-time password - (OTP) for wallet activation. + description: Authentication details for 3D Secure and wallet activation. $ref: '#/components/schemas/Authentication' bin: description: The BIN of the card number. @@ -2888,8 +2997,7 @@ components: CardInfo: properties: authentication: - description: Authentication details for 3D Secure and SMS one-time password - (OTP) for wallet activation. + description: Authentication details for 3D Secure and wallet activation. $ref: '#/components/schemas/Authentication' brand: description: 'The brand for the payment instrument. @@ -2974,10 +3082,9 @@ components: properties: attachment: deprecated: true - x-deprecatedInVersion: 1 + x-deprecatedInVersion: '1' x-deprecatedMessage: Use the `attachments` array instead. - description: This object will be deprecated soon. Use the `attachments` - array instead. + description: Object that contains the document. $ref: '#/components/schemas/Attachment' attachments: description: Array that contains the document. The array supports multiple @@ -2990,7 +3097,7 @@ components: type: string expiryDate: deprecated: true - x-deprecatedInVersion: 1 + x-deprecatedInVersion: '1' x-deprecatedMessage: Field is deprecated. description: The expiry date of the document, in YYYY-MM-DD format. type: string @@ -2999,7 +3106,7 @@ components: type: string issuerCountry: deprecated: true - x-deprecatedInVersion: 1 + x-deprecatedInVersion: '1' x-deprecatedMessage: Field is deprecated. description: The country where the document was issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -3007,7 +3114,7 @@ components: type: string issuerState: deprecated: true - x-deprecatedInVersion: 1 + x-deprecatedInVersion: '1' x-deprecatedMessage: Field is being deprecated. description: The state or province where the document was issued (AU only). type: string @@ -3018,13 +3125,15 @@ components: description: Contains information about the resource that owns the document. $ref: '#/components/schemas/Entity' type: - description: "The type of document. The possible values depend on the legal\ - \ entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**,\ - \ **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**,\ - \ the values can be **driversLicense**, **identityCard**, **nationalIdNumber**,\ - \ **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **ssn**.\n\ - \nWhen uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner),\ - \ use **bankStatement**." + description: "The type of document, used when providing an ID number or\ + \ uploading a document. The possible values depend on the legal entity\ + \ `type`.\n\n* When providing ID numbers for individuals, the values can\ + \ be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\ + \nWhen uploading documents:\n* For `type` **organization**, the values\ + \ can be **proofOfAddress**, **registrationDocument**, **taxDocument**.\ + \ \n\n* For `type` **individual**, the values can be **identityCard**,\ + \ **driversLicense**, **proofOfNationalIdNumber**, or **proofOfResidency**.\n\ + \n* Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner)." enum: - bankStatement - driversLicense @@ -3035,7 +3144,6 @@ components: - proofOfNationalIdNumber - proofOfResidency - registrationDocument - - ssn - taxDocument type: string Entity: @@ -3082,13 +3190,13 @@ components: properties: expiryDate: deprecated: true - x-deprecatedInVersion: 1 + x-deprecatedInVersion: '1' x-deprecatedMessage: Field is deprecated. description: The expiry date of the document, in YYYY-MM-DD format. type: string issuerCountry: deprecated: true - x-deprecatedInVersion: 1 + x-deprecatedInVersion: '1' x-deprecatedMessage: Field is deprecated. description: The country where the document was issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -3106,13 +3214,15 @@ components: description: The number in the document. type: string type: - description: "The type of document. The possible values depend on the legal\ - \ entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**,\ - \ **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**,\ - \ the values can be **driversLicense**, **identityCard**, **nationalIdNumber**,\ - \ **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **ssn**.\n\ - \nWhen uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner),\ - \ use **bankStatement**." + description: "The type of document, used when providing an ID number or\ + \ uploading a document. The possible values depend on the legal entity\ + \ `type`.\n\n* When providing ID numbers for individuals, the values can\ + \ be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\ + \nWhen uploading documents:\n* For `type` **organization**, the values\ + \ can be **proofOfAddress**, **registrationDocument**, **taxDocument**.\ + \ \n\n* For `type` **individual**, the values can be **identityCard**,\ + \ **driversLicense**, **proofOfNationalIdNumber**, or **proofOfResidency**.\n\ + \n* Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner)." enum: - bankStatement - driversLicense @@ -3123,7 +3233,6 @@ components: - proofOfNationalIdNumber - proofOfResidency - registrationDocument - - ssn - taxDocument type: string Individual: @@ -3927,7 +4036,9 @@ components: - ecommerce - moto - pos + - purchaseWithCashback - recurring + - token - unknown type: string type: array @@ -3950,6 +4061,19 @@ components: - inactive type: string type: + x-enum: + - description: The rule provides categories (such as country and MCC) where + payments must be allowed. + value: allowList + - description: The rule provides categories (such as country and MCC) where + payments must be blocked. + value: blockList + - description: The rule sets limits for the maximum amount or maximum number + of transactions for a given time interval. + value: velocity + - description: The rule sets limits for the maximum amount or maximum number + of transactions for the lifetime of the payment instrument. + value: maxUsage description: "The type of conditions provided in the rule.\n\nPossible values:\n\ \ * **allowList** - The rule provides categories (such as country and\ \ MCC) where payments must be allowed. \n * **blockList** - The rule provides\ @@ -4051,7 +4175,9 @@ components: - ecommerce - moto - pos + - purchaseWithCashback - recurring + - token - unknown type: string type: array @@ -4074,6 +4200,19 @@ components: - inactive type: string type: + x-enum: + - description: The rule provides categories (such as country and MCC) where + payments must be allowed. + value: allowList + - description: The rule provides categories (such as country and MCC) where + payments must be blocked. + value: blockList + - description: The rule sets limits for the maximum amount or maximum number + of transactions for a given time interval. + value: velocity + - description: The rule sets limits for the maximum amount or maximum number + of transactions for the lifetime of the payment instrument. + value: maxUsage description: "The type of conditions provided in the rule.\n\nPossible values:\n\ \ * **allowList** - The rule provides categories (such as country and\ \ MCC) where payments must be allowed. \n * **blockList** - The rule provides\ @@ -4186,7 +4325,7 @@ components: scheme: basic type: http examples: - delete-transactionRules-transactionRuleId-success-200: + delete-transactionRules-transactionRuleId-success: summary: Response code - 200 OK description: Example response for successfully deleting a transaction rule value: @@ -4201,66 +4340,14 @@ components: startDate: '2021-01-25T12:46:35.476629Z' type: velocity id: TR3227C223222B5CMDKQTBQ5M - generic-400: - summary: Response code - 400 Bad request - value: - type: https://docs.adyen.com/errors/general/bad-request - title: Bad request - status: 400 - detail: Empty input which would have resulted in a null result. - errorCode: '00_400' - generic-401: - summary: Response code - 401 Unauthorized - value: - type: https://docs.adyen.com/errors/security/unauthorized - title: Unauthorized - status: 401 - errorCode: '00_401' - generic-403: - summary: Response code - 403 Forbidden. - value: - type: https://docs.adyen.com/errors/security/unauthorized - title: Forbidden - status: 403 - detail: Not the right permission to access this service. - errorCode: '00_403' - generic-404: + generic: summary: Response code 404 - Not found value: - type: https://docs.adyen.com/errors/security/unauthorized - title: Unauthorized - status: 401 - detail: Not the right permission to access this service. - errorCode: '00_401' - generic-422: - summary: Response code - 422 Unprocessable Entity. - value: - type: https://docs.adyen.com/errors/general/invalid-field-value - title: Invalid Payment Instrument information provided - status: 422 - detail: The balanceAccountId can only be changed when the status is Inactive - or Requested - requestId: 1W1UI15PLVGC9V8O - errorCode: '30_031' - generic-500: - summary: Response code - 500 Internal Server Error - value: - type: https://docs.adyen.com/errors/general/internal - title: An internal error happened - status: 500 - detail: Unrecoverable error while trying to create payment instrument - requestId: 1WAF555PLWNTLYOQ - errorCode: '00_500' - generic-503: - summary: Response code - 503 Internal Server Error - value: - type: https://docs.adyen.com/errors/general/processing-error - title: Error processing request - status: 500 - detail: Error while determining the payment instrument workflow - requestId: 1W1UHY5O2CONU4R7 - errorCode: '99_500' - get-accountHolders-id-balanceAccounts-success-200: + type: https://docs.adyen.com/errors/general/not-found + title: Not found + status: 404 + errorCode: '00_404' + get-accountHolders-id-balanceAccounts-success: summary: Response code - 200 OK description: Example response when retrieving a list of balance accounts under an account holder @@ -4280,7 +4367,7 @@ components: status: Active hasNext: true hasPrevious: false - get-accountHolders-id-success-200: + get-accountHolders-id-success: summary: Response code - 200 OK description: Example response when retrieving an account holder value: @@ -4299,7 +4386,7 @@ components: description: S.Hopper - Staff 123 id: AH32272223222B5CM4MWJ892H status: Active - get-balanceAccounts-id-paymentInstruments-success-200: + get-balanceAccounts-id-paymentInstruments-success: summary: Response code - 200 OK description: Example response when retrieving a list of payment instruments under a balance account @@ -4337,7 +4424,7 @@ components: lastFour: '8331' number: '************8331' id: PI32272223222B59PXDGQDLSF - get-balanceAccounts-id-success-200: + get-balanceAccounts-id-success: summary: Response code - 200 OK description: Example response when retrieving a balance account value: @@ -4352,7 +4439,7 @@ components: paymentInstruments: - id: PI32272223222B5BRM4FZ7J9J status: Active - get-balancePlatforms-id-accountHolders-success-200: + get-balancePlatforms-id-accountHolders-success: summary: Response code - 200 OK description: Example response when retrieving a list of account holders under a balance platform @@ -4380,20 +4467,20 @@ components: status: Active hasNext: 'true' hasPrevious: 'false' - get-balancePlatforms-id-success-200: + get-balancePlatforms-id-success: summary: Response code - 200 OK description: Example response when retrieving a balance platform value: id: YOUR_BALANCE_PLATFORM status: Active - get-paymentInstrumentGroups-id-success-200: + get-paymentInstrumentGroups-id-success: summary: Response code - 200 OK description: Example response when retrieving a payment instrument group value: balancePlatform: YOUR_BALANCE_PLATFORM txVariant: mc id: PG3227C223222B5CMD3FJFKGZ - get-paymentInstrumentGroups-id-transactionRules-success-200: + get-paymentInstrumentGroups-id-transactionRules-success: summary: Response code - 200 OK description: Example response when retrieving a list of transaction rules applied to a payment instrument group @@ -4421,7 +4508,7 @@ components: status: active type: velocity id: TR32272223222B5CMDGT89F4F - get-paymentInstruments-id-success-200: + get-paymentInstruments-id-success: summary: Response code - 200 OK description: Example response when retrieving a payment instrument value: @@ -4442,7 +4529,7 @@ components: lastFour: '3548' number: '************3548' id: PI32272223222B5CMD3MQ3HXX - get-paymentInstruments-id-transactionRules-success-200: + get-paymentInstruments-id-transactionRules-success: summary: Response code - 200 OK description: Example response when retrieving a list of transaction rules applied to a payment instrument @@ -4470,7 +4557,7 @@ components: status: active type: velocity id: TR32272223222B5CMDGT89F4F - get-transactionRules-transactionRuleId-success-200: + get-transactionRules-transactionRuleId-success: summary: Response code - 200 OK description: Example response when retrieving a transaction rule value: @@ -4485,7 +4572,7 @@ components: status: active type: velocity id: TR32272223222B5CMD3V73HXG - patch-accountHolders-id-success-200: + patch-accountHolders-id-success: summary: Response code - 200 OK description: Example response for successfully updating the status of an account holder @@ -4510,7 +4597,7 @@ components: description: Example request for updating the status of an account holder value: status: Suspended - patch-paymentInstruments-id-invalidData-422: + patch-paymentInstruments-id-invalidData: summary: Response code - 422 Unprocessable Entity description: Example response for a failed request to update the balance account ID @@ -4522,7 +4609,7 @@ components: or Requested requestId: 1W1UI15PLVGC9V8O errorCode: '30_031' - patch-paymentInstruments-id-success-200: + patch-paymentInstruments-id-success: summary: Response code - 200 OK description: Example respones for successfully updating the status of a payment instrument @@ -4553,7 +4640,7 @@ components: summary: Update the status of a payment instrument. value: status: Suspended - patch-transactionRules-transactionRuleId-success-200: + patch-transactionRules-transactionRuleId-success: summary: Response code - 200 OK description: Example response for successfully updating the status of a transaction rule @@ -4590,7 +4677,7 @@ components: street: Brannan Street houseNumberOrName: '274' postalCode: 1020CD - post-accountHolders-success-200: + post-accountHolders-success: summary: Response code - 200 OK description: Example response for successfully creating an account holder value: @@ -4615,7 +4702,7 @@ components: value: accountHolderId: AH32272223222B59K6ZKBBFNQ description: S.Hopper - Main balance account - post-balanceAccounts-success-200: + post-balanceAccounts-success: summary: Response code - 200 OK description: Example response for successfully creating a balance account value: @@ -4635,7 +4722,7 @@ components: value: balancePlatform: YOUR_BALANCE_PLATFORM txVariant: mc - post-paymentInstrumentGroups-success-200: + post-paymentInstrumentGroups-success: summary: Response code - 200 OK description: Example response for successfully creating a payment instrument group @@ -4686,7 +4773,7 @@ components: brand: mc brandVariant: mcdebit formFactor: virtual - post-paymentInstruments-success-200: + post-paymentInstruments-success: summary: Response code - 200 OK description: Example response for successfully creating a virtual card value: @@ -4719,7 +4806,7 @@ components: startDate: '2021-01-21T12:46:35.476629Z' status: inactive type: velocity - post-transactionRules-success-200: + post-transactionRules-success: summary: Response code - 200 OK description: Example response for successfully creating a transaction rule value: diff --git a/yaml/BinLookupService-v40.yaml b/yaml/BinLookupService-v40.yaml index 0e637501..9d7358f5 100644 --- a/yaml/BinLookupService-v40.yaml +++ b/yaml/BinLookupService-v40.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/BinLookup/v40 info: @@ -17,6 +17,8 @@ x-groups: paths: /get3dsAvailability: post: + tags: + - General 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 @@ -24,10 +26,13 @@ paths: For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).' - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-get3dsAvailability x-groupName: General x-sortIndex: 0 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -41,8 +46,8 @@ paths: content: application/json: examples: - get3dsAvailability-200: - $ref: '#/components/examples/post-get3dsAvailability-get3dsAvailability-200' + get3dsAvailability: + $ref: '#/components/examples/post-get3dsAvailability-get3dsAvailability' schema: $ref: '#/components/schemas/ThreeDSAvailabilityResponse' description: OK - the request has succeeded. @@ -50,8 +55,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -81,6 +86,8 @@ paths: description: Internal Server Error - the server could not process the request. /getCostEstimate: post: + tags: + - General 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 @@ -100,6 +107,9 @@ paths: operationId: post-getCostEstimate x-groupName: General x-sortIndex: 0 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -121,14 +131,14 @@ paths: content: application/json: examples: - getCostEstimate-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimate-200' - getCostEstimateEncryptedCard-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard-200' - getCostEstimateMinimal-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal-200' - getCostEstimateMinimal3DS-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS-200' + getCostEstimate: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimate' + getCostEstimateEncryptedCard: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard' + getCostEstimateMinimal: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal' + getCostEstimateMinimal3DS: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS' schema: $ref: '#/components/schemas/CostEstimateResponse' description: OK - the request has succeeded. @@ -136,8 +146,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -401,6 +411,11 @@ components: directoryServerId: description: Directory Server (DS) identifier. type: string + fromSDKVersion: + description: The version of the mobile 3D Secure 2 SDK. For the possible + values, refer to the versions in [Adyen 3DS2 Android](https://github.com/Adyen/adyen-3ds2-android/releases) + and [Adyen 3DS2 iOS](https://github.com/Adyen/adyen-3ds2-ios/releases). + type: string publicKey: description: Public key. The 3D Secure 2 SDK encrypts the device information by using the DS public key. @@ -448,18 +463,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -560,7 +575,7 @@ components: scheme: basic type: http examples: - generic-400: + generic: summary: Response code 400. Bad Request. value: status: 400 @@ -573,12 +588,6 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT cardNumber: '4111111111111111' - post-get3dsAvailability-get3dsAvailability-200: - summary: Example response for request 'get3dsAvailability' - value: - threeDS1Supported: 'true' - threeDS2CardRangeDetails: [] - threeDS2supported: 'false' post-getCostEstimate-getCostEstimate: summary: Estimate the transaction cost description: Example request to get the estimated cost of a transaction @@ -596,14 +605,6 @@ components: mcc: '7411' enrolledIn3DSecure: true shopperInteraction: Ecommerce - post-getCostEstimate-getCostEstimate-200: - summary: Example response for request 'getCostEstimate' - value: - costEstimateAmount: - currency: EUR - value: 12 - resultCode: Success - surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateEncryptedCard: summary: Estimate the transaction cost using an encrypted card number description: Example request to get the estimated cost of a transaction @@ -621,25 +622,7 @@ components: mcc: '7411' enrolledIn3DSecure: true shopperInteraction: Ecommerce - post-getCostEstimate-getCostEstimateEncryptedCard-200: - summary: Example response for request 'getCostEstimateEncryptedCard' - value: - costEstimateAmount: - currency: EUR - value: 12 - resultCode: Success - surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateMinimal: - summary: Estimate the transaction cost (minimal) - description: Example request to get the estimated cost of a transaction with - minimum details - value: - amount: - value: 1234 - currency: EUR - cardNumber: '5101180000000007' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-getCostEstimate-getCostEstimateMinimal-200: summary: Example response for request 'getCostEstimateMinimal' value: costEstimateAmount: @@ -660,14 +643,6 @@ components: assume3DSecureAuthenticated: true cardNumber: '5101180000000007' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-getCostEstimate-getCostEstimateMinimal3DS-200: - summary: Example response for request 'getCostEstimateMinimal3DS' - value: - costEstimateAmount: - currency: EUR - value: 12 - resultCode: Success - surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateRecurringContract: summary: Estimate the transaction cost (recurring contract) description: Example request to get the estimated cost of a recurring transaction diff --git a/yaml/BinLookupService-v50.yaml b/yaml/BinLookupService-v50.yaml index 24188746..21c76058 100644 --- a/yaml/BinLookupService-v50.yaml +++ b/yaml/BinLookupService-v50.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/BinLookup/v50 info: @@ -17,6 +17,8 @@ x-groups: paths: /get3dsAvailability: post: + tags: + - General 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 @@ -24,10 +26,13 @@ paths: For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).' - x-addedInVersion: 1 + x-addedInVersion: '1' operationId: post-get3dsAvailability x-groupName: General x-sortIndex: 0 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -41,8 +46,8 @@ paths: content: application/json: examples: - get3dsAvailability-200: - $ref: '#/components/examples/post-get3dsAvailability-get3dsAvailability-200' + get3dsAvailability: + $ref: '#/components/examples/post-get3dsAvailability-get3dsAvailability' schema: $ref: '#/components/schemas/ThreeDSAvailabilityResponse' description: OK - the request has succeeded. @@ -50,8 +55,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -81,6 +86,8 @@ paths: description: Internal Server Error - the server could not process the request. /getCostEstimate: post: + tags: + - General 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 @@ -100,6 +107,9 @@ paths: operationId: post-getCostEstimate x-groupName: General x-sortIndex: 0 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -121,14 +131,14 @@ paths: content: application/json: examples: - getCostEstimate-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimate-200' - getCostEstimateEncryptedCard-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard-200' - getCostEstimateMinimal-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal-200' - getCostEstimateMinimal3DS-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS-200' + getCostEstimate: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimate' + getCostEstimateEncryptedCard: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard' + getCostEstimateMinimal: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal' + getCostEstimateMinimal3DS: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS' schema: $ref: '#/components/schemas/CostEstimateResponse' description: OK - the request has succeeded. @@ -136,8 +146,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -406,6 +416,11 @@ components: directoryServerId: description: Directory Server (DS) identifier. type: string + fromSDKVersion: + description: The version of the mobile 3D Secure 2 SDK. For the possible + values, refer to the versions in [Adyen 3DS2 Android](https://github.com/Adyen/adyen-3ds2-android/releases) + and [Adyen 3DS2 iOS](https://github.com/Adyen/adyen-3ds2-ios/releases). + type: string publicKey: description: Public key. The 3D Secure 2 SDK encrypts the device information by using the DS public key. @@ -453,18 +468,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -473,7 +488,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -549,7 +564,7 @@ components: ThreeDSAvailabilityResponse: properties: binDetails: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Bin Group Details $ref: '#/components/schemas/BinDetail' dsPublicKeys: @@ -577,7 +592,7 @@ components: scheme: basic type: http examples: - generic-400: + generic: summary: Response code 400. Bad Request. value: status: 400 @@ -590,12 +605,6 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT cardNumber: '4111111111111111' - post-get3dsAvailability-get3dsAvailability-200: - summary: Example response for request 'get3dsAvailability' - value: - threeDS1Supported: 'true' - threeDS2CardRangeDetails: [] - threeDS2supported: 'false' post-getCostEstimate-getCostEstimate: summary: Estimate the transaction cost description: Example request to get the estimated cost of a transaction @@ -613,14 +622,6 @@ components: mcc: '7411' enrolledIn3DSecure: true shopperInteraction: Ecommerce - post-getCostEstimate-getCostEstimate-200: - summary: Example response for request 'getCostEstimate' - value: - costEstimateAmount: - currency: EUR - value: 12 - resultCode: Success - surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateEncryptedCard: summary: Estimate the transaction cost using an encrypted card number description: Example request to get the estimated cost of a transaction @@ -638,25 +639,7 @@ components: mcc: '7411' enrolledIn3DSecure: true shopperInteraction: Ecommerce - post-getCostEstimate-getCostEstimateEncryptedCard-200: - summary: Example response for request 'getCostEstimateEncryptedCard' - value: - costEstimateAmount: - currency: EUR - value: 12 - resultCode: Success - surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateMinimal: - summary: Estimate the transaction cost (minimal) - description: Example request to get the estimated cost of a transaction with - minimum details - value: - amount: - value: 1234 - currency: EUR - cardNumber: '5101180000000007' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-getCostEstimate-getCostEstimateMinimal-200: summary: Example response for request 'getCostEstimateMinimal' value: costEstimateAmount: @@ -677,14 +660,6 @@ components: assume3DSecureAuthenticated: true cardNumber: '5101180000000007' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-getCostEstimate-getCostEstimateMinimal3DS-200: - summary: Example response for request 'getCostEstimateMinimal3DS' - value: - costEstimateAmount: - currency: EUR - value: 12 - resultCode: Success - surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateRecurringContract: summary: Estimate the transaction cost (recurring contract) description: Example request to get the estimated cost of a recurring transaction diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index 08bc134a..b2832b7d 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -899,8 +919,8 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -911,8 +931,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -920,8 +940,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -929,8 +949,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -938,8 +958,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -950,13 +970,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1001,14 +1023,14 @@ paths: content: application/json: examples: - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1019,8 +1041,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1028,8 +1050,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1037,8 +1059,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1046,8 +1068,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1058,13 +1080,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1105,8 +1129,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1114,8 +1138,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1123,8 +1147,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1132,8 +1156,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1144,13 +1168,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1187,8 +1213,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1196,8 +1222,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1205,8 +1231,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1214,8 +1240,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1226,13 +1252,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1291,8 +1319,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1300,8 +1328,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1309,8 +1337,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1318,8 +1346,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1330,13 +1358,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1398,8 +1428,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1407,8 +1437,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1416,8 +1446,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1425,8 +1455,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1437,13 +1467,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1501,8 +1533,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1510,8 +1542,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1519,8 +1551,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1528,8 +1560,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1540,13 +1572,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1604,8 +1638,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1613,8 +1647,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1622,8 +1656,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1631,8 +1665,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1643,13 +1677,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1708,8 +1744,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1717,8 +1753,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1726,8 +1762,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1735,8 +1771,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1747,8 +1783,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2330,6 +2366,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2803,19 +2847,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3041,68 +3072,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3431,7 +3400,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3470,7 +3439,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3735,7 +3704,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3751,13 +3720,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3771,7 +3740,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3782,7 +3751,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -3793,12 +3762,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3808,7 +3777,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3823,7 +3792,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3855,7 +3824,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3949,12 +3918,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3970,11 +3939,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3982,24 +3951,26 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4215,7 +4186,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4256,7 +4227,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4277,7 +4248,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -4413,7 +4384,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5007,14 +4978,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -5528,7 +5491,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -5566,7 +5529,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -5679,7 +5642,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5860,7 +5823,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -5876,7 +5839,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -5909,7 +5872,7 @@ components: the transaction. type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -5920,8 +5883,10 @@ components: > This field is required for recurring payments.' type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6016,7 +5981,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6032,7 +5997,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6057,7 +6022,7 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' countryCode: @@ -6069,7 +6034,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -6083,7 +6048,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -6094,29 +6059,29 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -6128,17 +6093,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6146,7 +6111,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -6156,7 +6121,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -6171,7 +6136,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -6253,7 +6218,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -6270,12 +6235,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -6372,12 +6337,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -6393,11 +6358,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -6405,17 +6370,19 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -6489,7 +6456,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6595,7 +6562,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6611,7 +6578,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6619,7 +6586,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6630,7 +6597,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6655,7 +6622,7 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: @@ -6670,7 +6637,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -6684,7 +6651,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -6695,23 +6662,23 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -6723,17 +6690,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6741,7 +6708,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -6751,7 +6718,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -6766,7 +6733,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -6840,7 +6807,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -6900,12 +6867,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -6921,11 +6888,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -6933,13 +6900,15 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string token: @@ -6949,7 +6918,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7046,7 +7015,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7167,7 +7136,7 @@ components: description: A descriptive name for this detail. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -7251,6 +7220,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -7563,6 +7535,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8162,7 +8166,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -8390,43 +8393,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -8444,20 +8418,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8466,17 +8426,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8484,11 +8433,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8496,13 +8440,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8529,15 +8466,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8555,39 +8483,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -8628,6 +8579,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -8653,1867 +8605,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -10656,6 +8794,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -10715,22 +8862,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.3.0 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: {"checkoutshopperBaseUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/","disableRecurringDetailUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/services\/PaymentInitiation\/v1\/disableRecurringDetail","generationtime":"2021-04-08T14:13:09Z","initiationUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/services\/PaymentInitiation\/v1\/initiate?token=pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91cndlYnNpdGUuY29t.pupr33DCNDCi6ZWcCbuL1_kaz57Jh_Ibkm2mkBZP5gk","origin":"https:\/\/www.yourwebsite.com","originKey":"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91cndlYnNpdGUuY29t.pupr33DCNDCi6ZWcCbuL1_kaz57Jh_Ibkm2mkBZP5gk","payment":{"amount":{"currency":"EUR","value":17408},"countryCode":"NL","reference":"shopper-reference-ekvL83","returnUrl":"https:\/\/www.yourshop.com\/checkout\/result","sessionValidity":"2021-04-08T15:13:09Z","shopperLocale":"hu-HU","shopperReference":"shopper-reference-LZfdWZ"},"paymentData":"Ab02b4c0!BQABAgCgt+NI0xLstN4SvHGzWhRqhw6PMY1WymPaPRkvmAZ1rk8qrsqC2Fp8V9r2Jy\/5kzJ1+jmP56FkJz2TqJG5MTt\/ksfRnH0ljyM5Mg1p0EbcOZ6sTy6ClUyO6zn9Ka3SPiE1fAkSe\/wUj4wfWvZHMcRM5Dy+w43IMRWH7htanbaeUOGW6YgudizbdueIHu57gApsyQuxOxOqmifBUCksVf4nEy5kvpv9\/qfb\/QeIiKefGnxNpcftaYIHDPuEA4K\/+kKf13vt1OZf1RspFc0qDXFRKkTYHrnbGJS0W6T0sPNwHiG5mG+40A1FxZWhgimUFQ7\/HcbZfHu5Mq9slUysZarI+FAekNL6O5xIhZxBGbIdW7ilSpcQosak2lKATmwSKk4fnheenwFRCf+lJErIdlqmkFAe+go1fJ0qxIdwQZO8z\/HdA\/jtOea17faE137ZoTprvnNwKOC1KRBxBSac12OVs8VVxKbPvFQKTDHPp7jzsTQlb9xF3cZ9KRWkzlJxFZ31u+c5ngezyC51JqurlH9VIweCY76vE9WZmBrj86xQ6mlEtBENFo+YSkGW7r8\/rZlLraMIt17fdIqcyQeBM\/aBiWIH0mp9ktsN5Hj1YrSf506SWjJDmp\/BZ3E1ZkuV+GgdJfpeIZAzja48UfvSxPwv01tK4dxIUOfi0l9OB3aEwhASQnCZbKJDc6rkkvxgdLp+AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiff8fordfxJF3vxiYAd061rUEWVjkGNR0OpRcV8Qgk5dMNzGewODwBGBXzYiov4ledGZi4KCYpr4x6ujQ3Lgf\/r\/DThHVVS0juFM\/BDFgc35GL8tQ82CA3JgqQZx0f7TmZqohgPPgp3k\/2g5G\/vt0TIyFUOHw51wzO\/x66Bwgm++565WS06R8l+GLLw1Gl0Zknz0zsi0GGvgd6Y4\/8wlwZzyXdGpkhtW5G0Uxjj1ZyIUiYiD4AS\/SIHBx0LsI4yXkT22a8dutkyBnKUFfuoTGvGBacbPPfL1g7BU2He3Cqqag0Ab3qfOFuOaZ441Z0u9pc0x0xdc\/T3q8R0rmQHUoleHIg+V5bwEsNi3KLg5ZWX\/bvU6F5+\/\/ufB4zfe2eJV5QKJ\/wGEDSuxg1cYBX4PPLycL4a0tl4Wdjs015E5bBnOM5HDeDmdN4eR6tTGZj+P\/nVDQMBFP1oTFjy5SHAF4urQh8hpyRA992MwWkugGbpQCQc+YivS5pxH2JTqa8OsXFUn4Fc\/ZfbF40yphHxNfV980NwCwj0ZVabX+vd+2aOUHYqXIwmh\/2f16\/\/rYY6RJVePbSev\/\/\/rsAmGNTze3Rs5jOxcamoR0OEmRtytepBaEe\/nkNcCLsFhF2Tu7uhQPTSoUfMeDApT5se1zNMDU7rCruMR+M5DOSpX+W3SaRBYCyoeivN13dR5pk+uiQgExsyII6nykFhkJcM\/HKgMhBuCV6Uv8BhghySGS\/355yQpzfgxBi0ek403FWPBAw8ulf4KWrb50wasfivTTP\/KQyFklpQ1rX+35Eq9uOqOcTKm2xuvdqMRcVGbIIP2F+1mtBYX14tTkA49QNWLt5xuHSdzCQy4LCnzWruXrXdI3ZYdcF30ZPcdbpK1XFYpakYojiOk2QzSU2R45iqcQlFuxoMHxs+iL1n3vtOzyTNU1XZepkKk31IlJ3aTKKYhTfghDWJHm7JclenYgvObmZ5s5I36N4FDsocxAV5+c014Z49tH0etUAHEqTHpUd5YFbM7PQnLQgp43zTN7NUDwP9hrYKguRX\/b2WqruviyO4NZrKWJqtwmywnqT9NcjGP0+hJ9hVv86zhZuGjZNVyZGCj1p0r+tbHqufN9RxSchcM\/zTN0RDmffwU\/Z3gk\/qtjDFevIkki6TiYboLugnc6ZEs3gpo+gClgmHZ5dLuscwLU6EjCaiZoj12KBiRxTNPzEnOaRqK+YnWCKTamaMnD6SO5t1SLIi7Nf+uHkLygXrZ\/zZWh\/alF1niwmDp4NpZAO6efOC8Q\/ixahG6zzaGqNI5eUpKND2B+Uk45kOgJCffgPL8XHRGz88z1lc+wrnV35bw2kIiY5frf1vwSzjEFS1MQFZVrBDTmPkoq0VSGdja1LmP8htOYcYCAs3i2X9GxwOOycADCZjbWUikbwknWBSAf1lFrh39x5me78zOz0fSPOX\/d3C3pysK5u+zAMiPc2vL9nWFpG\/1K3s1xwaIgaS4i+BWvlO1i9iNEzqA1bocTU0q\/KX3wE9C08j8SrWsi6yjuzjFrU5syH3Gz8lHgsv4QTnmf8L4AQDR5kOjRWqQkArGPQ0E45pDaO5sK2ISxwgNIpuKtJ6+9MFM7vYGrHB9H3JomrZ8FEEjKKP8cUI2weIB9LsEpQJskMdKwMDdIi4dPgzvRaE2YxwHxJgtWGOd5YZTocHhaBYnr25dx8lKF91C4LohOzjzd1JCDJDsOmQ7FRZNsnz0s83tTFfjHcz\/ZBuaAPj0txCL7bHLfPrmziaGuf9wQ4vxqW0iAR5Cvmid+BVFJIz64Gww0GqThnHSyWRXYZeQ1DSG98orStea9gYEzqy8KWwrh\/rhSrDsC1bN+pZfZbslEYgB0riFML22owiGijw+n7dJZCyp2abifEocR260ffMxfKJQBvc5aPqGp+kA4na+l8GxHL\/+Yxn6SiSfgD5dVQ6+3nlhcGtBZBut04KRz7CSzQ0kEyL0T7MPG","paymentMethods":[{"configuration":{"canIgnoreCookies":"true"},"details":[{"items":[{"id":"1121","name":"Test Issuer"},{"id":"1154","name":"Test Issuer 5"},{"id":"1153","name":"Test Issuer 4"},{"id":"1152","name":"Test Issuer 3"},{"id":"1151","name":"Test Issuer 2"},{"id":"1162","name":"Test Issuer Cancelled"},{"id":"1161","name":"Test Issuer Pending"},{"id":"1160","name":"Test Issuer Refused"},{"id":"1159","name":"Test Issuer 10"},{"id":"1158","name":"Test Issuer 9"},{"id":"1157","name":"Test Issuer 8"},{"id":"1156","name":"Test Issuer 7"},{"id":"1155","name":"Test Issuer 6"}],"key":"idealIssuer","type":"select"}],"name":"iDEAL","paymentMethodData":"Ab02b4c0!BQABAgAQOXfyuJdcL0vN3gOePL4QWWQDWZd0LGPXi0C3mVF6yNIVtGxiUpdzI1UakkQbYHn8YL7Tr9UfSnGr11hvBzltGbnVP1Vusvasn8g\/En2dWWHdP8noxErAICPrypiG4VZ6rq\/b7GiTEuiWRLSXU0Fm7TmwbWfsU8xepTrdDLov+R7nUOXq9cZMZtsdEWDxZTS676VRvPPzOvmq+9VMZPKaqSOdFZQemZYJiTUGntTHtXT378jUWS3pv3V3BiyUy1OlgSNcfAejVFgpZtMFwS1Df6rwCi+uYvmj0+BhId3xLPFXI1pG2Tmpc491X0BnpCT25rESPdLZEGY6XAeUk4EbfBDSwjEfGkRd5coapUOPD1NlEYloW+drqGJSk8xz6a0Ikq\/nw7gVWUDqruWw6SPXMEfVAjGItHODnWdWXrjLTQuhu3BYrMy4xchwk1yKmJBnKsd\/mwg3px9zLZojAfE2KisG1X1Amy5jHMNnLEFAkywTqUMFcC8V5RSS3S8uMgBSnF5JCVKTQb+KC0KilRuq68UtlBk+jvzkTGcCQrOlq87MQWVbp\/6Mu7Ng4T29W4D1OXg8k9bp3BpNz+8jI6viUlwl8FR2PrumLZe4\/DhfnH1mHFgI0+7HCgNfYXcUdvICFkbiELQcP0PPsVXrs4I7aBo0mjeRW7cncuj7o1zvaRACy\/VCEXKEOZ10Uagna4YAAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbjsE3jTDdtjckWCfvwTDtha\/9AdnTpE6V\/TBqC19+bBUiFsW+3kRbX8jZRgbHbbI7\/YmA==","type":"ideal"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"MasterCard","paymentMethodData":"Ab02b4c0!BQABAgCCognvnK3ydYPFoFKGKJEJleIkYbKAN3VVg5WXPNE1ud05KRqgsNVdvwuu9NEwpkb4UutL9KBUWA3feoTBBAWVJt1qpgZXF+JZOzfJ6BSc1a0zowCMQz6wtCI\/tWBxKxaKFaljAv30jga3+JCQkpU\/4gq2ubsNWcOWJWDFEvH15WN4gungZebQzS220kOfwyd6IS8TnwEWd5qg40rt0xD8xBaPoNYd5Cx\/C92i+6PtJzIX2SYBjGjG7dZmKno9RTXawhkjJmssEvFGgw9S9U+\/MYwKBel\/daKBTI1c+JIc4zqd523iev0YCruNLHv7pO4MTy0VXRwizCBURJZ8ZskCUbDM8FFPwxcel7CnF6ts4R0blmKKZCJr4VaX3uInfETy6x\/qUULaSatmFusDtePyQDzZA\/8c1jX3Uq896mnGi2nsK0DDeFzGmPA1rKEg77YGPtu2MRL+7\/9d5WOoqBzTe8h7Sp0uAP8mwx1ySXq9hdf8tkXrnB+yDP+DcBA0+sBNdx6PocBCaPfK4rwXZanRwFisZT2vrV1+e4iKdBAOExLm7\/mTlmhD8OpXugJkZuEY9K634aDcaNYB8aK1flD5J7y+eifQ0tuc18brADlJXIqpVx3uPQyA6BP1dNW\/nIFZBVnayz1lZXErLEDz899zB++kRFUKaqWAdGRUVU3DgRAppOX0EK6OiasLkA2YdsdkAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZrwQHzXOXVvxGnqd5Cf75gjjoMkWzjgBSDVUu7iX12mv5VN1NNupVld4T5R40AiBQ==","type":"mc"},{"name":"PayPal","paymentMethodData":"Ab02b4c0!BQABAgCNokZKlG1MT3DDsUkmC0wuH87A3cCl2OZGQ8uu9Oc2na4sg1lYO19JLWqo83fNrq2L+9caG\/6t802SVQtD2ywXUeEU\/JifxXHbgD4zgC6I2XrJB2BrAVlfEu+Ni2Mkmty6R89owPoD4BH2BBgnb6pKYbgHJPP9qJj4TD\/oNst2sMkSXPNJv5v75ZhhJpkYM2MOO+eSgM901ssLWT9lj7ppbiavqoO8lpGDNHD\/IsJEqGvWhpIXrOFLMAx6FsS1xnTljouQv1kWYG\/p5esvpGenhWQkreUl3uYfv172B+3pRpCtHCL8qMflB+pdYKL5c9Sn3oTfCd3YtmINOtEMVcH8zew5VY6jr04yvc1x8sUYcdhovYfm8C3kGuDG+TEfuet7QFeRcBx\/zzv\/GIxsxqaJWA2mJEQNqjMbYrv1PzQLA44GcdgFI6xpT\/AwNoj5MALM6GYKs\/2\/0T1lYRh\/\/o3hLMx9R\/X5QuiufQa5zn2uZCyiNXEDaJ1bLNQ0gGQ3X+dkClEfidD1oxfau8uanfQ\/LZNsFWvWS9qaEyLSRBYEfQDDPMYujFy+C80PD51rDOG0nsppKLJ89kPR8M2F3OGE4PG2ENPOBtBHuYtnSYTUFFw3jSL3oZ+O+a3RBDlURp8QdtgZPYZHG6WBIb0AiN0WK1Xc+i3sZQ8s+nJrshBBRRBdkOu3rQvcuTX0wzkVrcOqAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUnF2up7n17FMeYCgsWh5y7+HaUMslBb\/NQw7cuTFWeKoMv7CLTU4HNxt1bdkYHC00DSDxA=","type":"paypal"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"VISA","paymentMethodData":"Ab02b4c0!BQABAgBSuoz29NnQafIoNneRKy7zbb7IqZLX6ZV8vFZ3N8ZkrkcwfMrKsfHesG4Qeh8R87jaWboITvb7muraTbZSTFbULBnyIlKS8j7g7WnKuxoTF541aiEjRGcF8G+5mktPsM09wFcgEKMJuI8CbztrjGMirsa8LINAqqMlJwsvwJqMDmBjj6S+lEmq6dxGNIjBZsBeSqsihOfZ1UB4Jz\/Ne6gWwvhl5gEaege6mdDxs\/y\/g\/93Ml7XxwkGeedbh43LcLPg6lLPM1QV5NQ7Qt1vWAA9mw2m9ev95xitkZRNoMXgQuk\/M9kDwofWVkmfxUP8W8olKjjK0p4rQAEpT+ORT6RPkpNBpzVzvEgwFUpZr4XP+LCasjf177sLL3MoZUJ4fZ8QfXaPLaIq\/nY2FFESItOU1ZotNF\/EAsHt\/OHd0Zq9RSTLeSOfGMDgo\/itkS9dWrQOoEdYT\/7plVxnKo46eABC4cvTn4G1s6CdTJYgNXkA\/IcMc3maFvyyfzNcDGihF1VwpMpWEDg+I5is6FZBU6IKJHXVEERmuLSzi5OImCn4CWXKXXrM4+3U8+OtUQxN+pKBXvxaP1eh8VigtWmrn94MtvSWlrJOOFn178cV\/HqZNk\/COf4hqC8qilfpSzvkMteg59N0sLQ1hNV2FlLZQjw+PTzu\/f8onV8M8Euu5DRkexCsL6yXSFRqurrTdabb6j8NAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQRC+LRtIEHnt1T9Ayq9sA4kWH6yF\/z2vdEl6fMR\/uE2\/6SRXJvd5DqpPfhoLNBPeYjJ","type":"visa"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"American Express","paymentMethodData":"Ab02b4c0!BQABAgBEGvruCjCI0v7n7aiHYnRKwExtyMG\/Nu0gW1S9yqchaWGFbonc+h4sZf9dK60J6iSibKWhjuYolkUVx\/+GwSb\/vdZN20mJTlrXEEPAyQI4qMIb5QVKa\/WTVbZdeOp9kDhCbn8fBBN58Y\/Uk0TdHOH4wfz1rOYaferr7iucPJXZB8byagvbUFvzwpS8GzoDKrp6XNgbKkd0y5oEeE17Cl0d3fGgbCJk\/B5D\/kTYEuAzqGZUA0eKQOkZfcnc1J08aDNLK5GPNpNjZdy2oeYAmsLZY3Zube1orrk1GsVIT4J0BWA2fw\/TfGPzxMsJZc7SfmErZSyJEWpDZraRYFIXMZ+IT5gFYzORRkkMFyqhvoUCGTyK2jRZzk00XCjMZRke\/fCe5HX0gxDz8zBDWpCR6ekvfk6GKkKtaKAu5tcQjFICarRcX3wIPNYhxrtESiWtzTugjnH1ZM7FqacdrJ92crsb2u8f5uxPOSFNjJwprkXXIdiSYxCiJsz\/vMy+usvfw+vGCUtwDaBXzvWAf3yYvr6ZI8r3RxMRBFvFpnRHpMDhuVGkV+3S1HUWV8xExq7MuY4jEPlWTsvM\/eZyXmLg8O3MKvYioaqvUDa9kecB5aBAw6y8+lSWgGV1cHyPl2RiqUNXdrz6+fJ\/KmQ5x57CFgw4tiPoivUJ0uTS69F7TZQjohA1QzcXutAWtXzBglU99635AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZfDoLu\/zISKFsToh1bg0F8aRlRFGDHwqcUx7eum3yCLQD21cqfKmrTLyacrlo5aM4kt","type":"amex"},{"name":"SEPA Direct Debit","paymentMethodData":"Ab02b4c0!BQABAgCbwCT+JO8UEoxoBPrI+qyUS4vR5TT646v1MiN\/gUM4MVm7jekk7Wd0Hmrjk1\/NEg7NTAcpsfZDBOcMlQeuTeDsEaC4kBf3tqsttfw+qY6TbaFLCtgNIr5wJ3dm2TwVhFCYVMArwJ5zoBIsoONUWpSKR11DY6zE5vuDgtifNA0YiN6h6rzq8O9GuCrCqUJbu23PMejDHA0rHDOKyxyOmBXHRvUHhNR1\/Kwtrvx+fYANnAHgkznTH4ldSXcuaMVtZFqcpHZTiYpLv2ydiT14PzipiODpRGiXy0nO7b5N8Rs27nYxlgH\/tDcI4eF4jl981TPKlF+u6XEOGm4Ebyya\/BfTDp93rKRMxo6K\/LrfI9J4WaA2tEZo6eGNbRuKPpBlV3ASu7wpCfSSw2NjouVTCkfYt8+XeeJeIIYZ0p8AWjn4LTwarmSVZ7cYw9b9eCU4XX\/RrcNgoLFPXEr8w0McUF2n0GVWDM7Q5b9UtoZ36yk185LXmoMuy\/\/vaBIvE8m7Qlgo\/YROv9Uem6muLu4hZzW+V+WEKAmwGL0eJZCdjAeGWz6c0nty8PNMUv3pf7tTeYN1gsvQfqlij3ILsRLcw4kNYvElnGlCv8dgu3cxlz6DsnMuy\/EqKQMZAIoUCd6eF19I3NfvAo2j5MfrpSKS3QGLTP6TXKqgTNb6d8sVD8gRKhCDK4Av\/N0p2CHGN\/YG5xaBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWQL\/0ruABUrzlPtx5llC5MJp\/\/iChDPZ8r7lkIf4QbzPP+8ETdxbzNZU4vwKTmUjffpLdQA2aswKEtOzYM=","type":"sepadirectdebit"},{"name":"Paysafecard","paymentMethodData":"Ab02b4c0!BQABAgAIhU3xKBF8QbmAvj\/6ONqIvvCbMr98epy6\/KIV9u+yJz2pSj4PoMDLbJxV5PZ1Ykxaa9WjWvTnlZ9NgeB+eoO26MbmIoAsMw8knjay+FE0Pyg5Gj0JXo9Ibe+D513sf4qKB+wQPXfUEqkniitTi8o+jyhbB123rCAJWvbZfPOEKE1RE+FHSEZyVvJmHQPl5y8vWsCKBHjyDK5oLJjtxDfbdoPRrMc2ogNsGlfI\/qpIFW8HXNRKXpzCj+YF4vif8Zn6Z8Eb52rfNZI12xVG6hZnmox8BmMgmSnGkCwnY3O3CFpDTZlCbJo\/XWSGgEe3xeHk7PiZSAjPOVHpDDALRB\/wZVf7XzGYqKkiwtjnzqF8kGYy7XUduLeVF2z4C\/QzgF1DzqzIA7Lf3V+0UBWhpDqHJCrwkAWyTCaOXrqw7T66pT7MtZr5V3lGBUqHk8T\/hNwcuzg9wrx5eHse\/wdC1+2eVay3i0YWyikn\/rYt7z1iyTTIyz96IxxoyMIq0zyULkniylcCspd20\/XgNhbrRmdAt7qPmD9rH+Cp7abIXbbiAM4LWfn9yOWsOsALSDr2TGZDjsmMISCXzLHU+SDOrp2SiJRJ3NHNsTrdEbX8I6w7zTaviTsNMEAd0t9gbyb3kW1F2rqzJT\/UPeQb5MJQ\/wqGGYbIOe\/XGE9BKxQoluKLFhBv4haTKeq9Rr3VsuBtdUxoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifew63Hop++4N+AhTkkdsSKG980izIWOIBwRrfCIR6YloEnJY\/80hintVkjZcIzDoQYFnf\/zExjiwIQ==","type":"paysafecard"},{"name":"Bijenkorf Cadeaucard","paymentMethodData":"Ab02b4c0!BQABAgCpQPz5Zr3DETTfSmxZeO1skeivMnITjgMXOAmpc6OHdPt04Qs0PjkWF\/7+nfFXEyS6dhYw6aOGIFTcr7R2xav\/88lWDCUhP1G7TtUl87npuGEsmlaqS0Kasl6BD+s5HQ1rlplfffupDBlFj3rePozF449gWoGX+bNq1Vgeh7StI7XB17K\/FDqEYQi+N0NUEtJpCDottPouvo0KgKuED9r0RQjAb8k3nNEuAFxkLTCEfgrRYv7HPDil4dx2yqOhsbv6DXfq0k+JxIFIR6HscRXmggWx1yzou4O4OB5UepYBSlxoJMKqEQXFQxURkF9RI8gOyG++2KYLHHolZkqRImnxeSZ88yZ3zP1eLbaw96TmsXcSk2Sjg5qWEr8RpJuL9UaXEpaOLaqm6E0QMXkbw7A2945YMYTc51tIB8hjY4GOVsoVqkKz2c4Md6yziKlv4XcfI5cMic1rI9q3x+NTSnpNAEBY9XsfE3KV+5dcwIUvIBw4BGkH8Wg9+N\/WZFeRLDKgmFwZ8kkTYMKaax03oHLR5\/NyCBX6GiySwLOqm6QlHtTIVajskcW5qQO9gbz\/JWxBBBtyAdeThE1Qv\/09fZULNYPZ5CgTot0q32It2Jash\/jQGf0lKLDjqWu6Xc\/rPeFDk6M5b6k8NZqSj+fegHK6+NmyFMzaBLWK8uyeSzUCbxDHtI02OGPTOI40iSVTnQfjAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYEvni+wibC9so6deSW0g2CaF42cgtTYVc0woMUDCt0gSvKHfPkxEExT4rv2Pj6tBy5nTOrvmoI73RtR","type":"bijcadeaucard"},{"name":"Fonq Giftcard","paymentMethodData":"Ab02b4c0!BQABAgA\/VmZkWktBF5weoHZawlAmhz9rivBPh3eF24ct7JDXb0uvbxZCJ6cweI0fTU+i4iyExCthFm7I6wxgRLrEznH6033kj9J+rr7d32BywPOxNq+dt3yG3lZN\/LfO11k\/HeMobXvxU3\/al4nszGTXyVMiLTgf84vzyCYZWifPx6pakWjMeHI0qTYF2cbUzsGsoob+AUIh8HBQ3cHs9eRVTUI1P9QAErzjYCNzFljjayFgG6iWuzq113TpuLuSoA3YHn09moZ\/AGu4HIUnTK4Cfp9fu5\/FMzFHzRxzf0jxcy8xrW3ClyHPttsHxytACCvCt39xyryiNcHnmnZGzvcOb+R8DLTG\/jXLe6KjQHfWl1WjrCOHr74PDBglYf1wvicYj88iqQLI6TEzJopctDxmWI4FEyfQw7DEZX\/LooqVUwYblRuV+k1qg2RVJ8y9NaJn4m4R3Ti\/5yc9Wq1OrvpYUbFMB56DuCBm63knV3sEEFJRSUtVti6uDLP5NA7cYM0NRWLjyxYBMiI\/r\/zWOEg+mLjspuO80gQeg6aC7PzfVY5bj2YGJVY6TmSmVdNZAipa9xzHH4RpB5R1Pf3cBT6+xchT6i3ZFVC8VY9+iCxxdpG4TYeqcLW6pVe9hHAe6vq97G8+F6Gghqxb7Z\/DlxIPRuu+D4lWa2mshpGNUTdbF4xuzhDxi3\/zjFAoR8jPpymbJQZoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVU7KkI531G4lKfLWRXWEry7pNzwCMfzANGS3PGZeYA+2n31DEhwavXsiPBvv3Sx31V4XCQiEEUNE0k=","type":"fonqgiftcard"},{"name":"Bank Transfer (NL)","paymentMethodData":"Ab02b4c0!BQABAgB51DuujA7vUd5HEKFbHqfqbOvXmmtjP4CdUi0JruTVYdcMSuKAATLdzyB3ayN6V5KrvUKitJV3ogvhNPtJ7gGBKB3idHBUb6v2iy+YEvuTb\/\/bJ04X3OxxI\/9f70qvVKtbSjpXhgmJrO1E0evJrIhml12sCVTaAL\/paykhzWFvHzMmUZV62KWOayWyiMEzcnndbG\/CkJ4OMe22ipfsuNr8TTEQwzmAMiSt77lDdeN+y0JiyQyLHfR+gV57FC5PDYgP3ylpso4W1VXCcGx6jRFTwHhb+gyJf7HqrWErYl83GietwukM6TB261cadT9NHbSfh4FCTDvL6twoRzhefGbRDuO5xvs569K\/e9VCSEnen1Fa7vZP04azaZ7mhfYUcL60CFoWgNkJt7NrFlmSO71BzpyvWwEJYFnhk8vLmjDd8UqitLyV2hrusnyK3ESHiE\/k0d5Cbil3CB3QEyhw4zC6WMzXIutTMvLaJyn13nR4SGWhObWomXkSvX9NKv8NrZwy2BXheRAyOHStD3QLBORrAiq9pEWPZF9wv+eBJFNmDHCXwK88nlKbFKV4WzTO4vGPbNVGrHyM9DVIRHt25neVZBYcDGIyVrUI9txBm3rL6QUqnt4ly+5gDFNLjhpFs26mkcex0++7VgpuzcS9WUOuiOIY5uBplYS1aPesyxW6uhAypRves0tGoyoUelhL0ZXbAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaOmKTlIMV4D9THzNGG1oMsJb6VRZpIiBiSEWovHLgIBa1wHI3H28jenqzyq5a+7rK5XpMhLpq1i0LLu","type":"bankTransfer_NL"},{"name":"Pathe Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhO2Q2JTyJ44bDAkSQQlkgI86+4Hz\/IMv3o8J2Xk9Ky\/Ckz0b68SDv35YholJFlJezRYrYWntzXfcjcfrv+HsRqej9Aieb8bGo1NrSSUa5FEpB\/aGXAP5Bn4ph2UzppDyACOOy97jlG6CPiZZZ2RPW9\/2SBP+Zwl3fzE4PyON4uM5piN+b9c9mQBlUZ5trTAgcOPBPhGpdesNqOklsHUYedp04B5RH4fyMDQTotP7WoHpbptMTPhLuuNn9rFRaIZrf4n+hnsiGa66KnGa\/MK0RKpwI5vgcY7TJt7Ym9lqwcnfjwYSW73hEeZj9J4r1nhTvc1p8SSnKN2wKCs+Tj4Bla+7pPzJjxpiNdeENOj+DVKAc4qh7lrGvLs\/eM6sTwrmk6k6bqD2VfC7yIlcQuWgwEDyU3BELkun+\/KBfwH7O9qC8YdEQ6ftHknq5qu7esOgmKUPrh0+0pO8QSnuzeObGcmVZsKZSWPK83W10XUtd\/Eb557f+E53C5wurfM6hlkaoLA9Xy4tuq3OyzJSn+U6f5jnYpWoPFbiU6FfPI594VjasrFZiaZ6pZFVvqe3z00sj7J3FEKtPDuABbgCoshdUeqkftUh6hNGcP9YieHtKEXxqiXFlk75yJ1qZeLvh4HeBJUqwctWgwyCirIBqMTI3icF31cdnwMYj9x6pnK56ahAAcSdzbZPYiLmLBmK2IDnwAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVSWDvE6KaKChC2HUEIlit8WNjy2vPU\/veo+SPjHQXporYlv409pRe+Ott+IgTXXbCtWN8G6oOrVI1ht","type":"pathegiftcard"},{"name":"VVV Giftcard","paymentMethodData":"Ab02b4c0!BQABAgA+A4idTs3qRa1aqP3B0gIqp1\/XQ+I4v6akD6AGmgH5smozPUK8f8UzFSBqwgq74fKmLWOj6S563FZHvcS2DdPKSATlh8bdG5htjyaFWkyHsuyga1\/fX5cE2FVFTNNoIsS5elKNHMDEXko1napgYprIJs0Gcugn8wFRZzbd+iVIePbiyQqlNdgdcrDOMncTEsRVR7COekfWBpmskzsVjFeG7h9LRqbtyGQ9py\/u51MUW1t5OL57vuxI5mE5QqdNEvIG+04QdIa7A+GuZTzLvnw6mDif5RZvD7BLpYmvSCBNCHJLh7JYxJantlkz6YqBf7cQjHBjZGLvEnDLJ9zEUDj6A1r9zIrPG+Ds42PyPPpskOZSURGZdyrXcDBrU5UToyEylRi\/gtnHMawdHnw3VIDmmTNWm4ma4XzQgJM0yd\/AhZkqLGUWnPeNqKMIhN\/ZOrql39QeB3aj39yAJ\/+XYiRFeAGK+o865GFONaw68JjO8q7OOPADwbDGUn24g3oTtFtbDtjbv\/l8rvkA1wc+DQomK6pezGf+P5hkKQgybaxG1ryfXyaMQbv1hojwVFRC8tWbVOy9bBqGmbZb3ue2jt7lcXOtx0xTswFXzB8C\/EoKZQ0H9Wi\/HgswZ4y3SxepNzD2utrehnbyWVtZ2uyyOM8X+qT9h+98W0V0vF6d7TTX2RB0vtmbGcwIpf6SXVn39CZEAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifY0HazzPpi5jbgPfqO8hww7YnpWeRhSLkbwJPQ5hYZJXsXn1Ma8rnwpYYi8jfO1FJKBq0hid1zapJg==","type":"vvvgiftcard"},{"name":"Podium Card","paymentMethodData":"Ab02b4c0!BQABAgBzwaQU+Tg8IgY6LWZFZR765RW6ZQ2DZYU0DtHpL1P3XYk5TPwF7aG7Yb5nc6wFkt0kpUSyCFKNn0h+L61XtT+NoDCTTYCHfA9YtTwb34NY+YmZGdKeukR7TQJscKNPEFxzc7vdRXxJ0vTBuyXiLP27ms6db0e5BtAfgF7UlVHoBDhTBl0UZSK97b0CRrH3orO74z+H9UjeP141HR7za7ay9Jk9gXEtgFQxoEjacvjC+IuRu6MZ+rfrTiApkcFcnap95mwxYQdzPWkZH9ka2S9NFVSBTx1g1BmFopj7nNQBHnru8DXVxnF2THJjf9N9MElcFcKnMDf45szoYTQ6dW+0W+wTKcQEUL05yIaULsYTfqgFegKJtdHBadGgUZu6d53dCK6TH5gTxSmV8gxuOMFfJ1XKJcjJ\/WWFkgRA+9FJSd9vrGHxVP4ZXAEzt6SteJ8Ew76VvEOkAp9K3kASCLMrJDKifEV7t\/5VDQkPzg\/+EWScYpwtD0Y1HPziNaum4xEpHl\/Ivbr41ZVDSlgc3u3z0ET9VPz6sWP59oPY0pWy+45XyL5fia729tJCLxCPC6HxMTf9YR9DtneDA0fQWS8U3AS2sTiwYasVj9EPOY66YBqoF2A6127l08qV8OJaZS4enIvuVxtE9VGB9ZXVBB9t3GeSj+121B3fQpcvWbfavBCmqv9Z37f3YphvyLrb6gkEAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZqakCpG8Uf0AtkpxtcdUkLTz\/ij5cbS99cT58Cqwnjo0muipxwf1dRNtDIAaluVuyvM6IHNGfql","type":"podiumcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","optional":true,"type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Maestro","paymentMethodData":"Ab02b4c0!BQABAgBqjbzap3VEI1UTDAV+YAxi67UHIAXoXAQYl9pQDP8PGTVnvd5WGD8MFgUPYUSz3zjLiRomZirNNwEdxns3glOLxnbasMe9cit5CbEmP9gZu4MMCouutZg2qhhrPBLewc\/RKJJPetKUjW2W5gHXEUcX1tdt63sg2Z8o5g3y5+WqH2NnoHAQN8DYXZ8W3jAcltX+Uz\/5hIhV224RorNAOM8tgTB6ADAM9mMfAU6YEHHB5ADVdM1IDtRbg45c4CdK0nIihZx\/kIcDW8aygpWMpPCuFjFpO4f0cAtXW05N8KA2VjUAqjt073Hzv09fXZjVV4rLo29NNP4qiVYIm1GRQa6jQGfyWfVzYRCp3BM07YN4ISP2rVNkRoe5c0Tae0JHb4pUJ3gzr6BOXEySl\/Q0rSPPEJtmHGEdtmgRKG9UWhiwQVBhvU6MDDEkdCbfAeSByT0yMwmFgqHZVV6e++2ZSOxiMj46mj7x1e\/Jl8v9OuP+YoqYlWqZkdC2Cccm3NB1+8vkuid\/sj+x9mmjHfx63oUZB0WkuRJvYcDrF6ije8C0TdcE4XWVOOc3jHsOSSq62d0pssHA0Q85YP2w2RiOuPrPI7nddvr8X2U8C\/UhO9jHff9\/3TcygwEEBZ8TPWJaFrDPzHVhMTMQdqcWsMCOguIsrWReIT+xytzNbv31WkhfyRBKTiRvzxvH\/sV4UlKUv4+4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdjiFWBHVC0eyVNBpmJjARVoFkvoNhGDK4dId7U+\/B8peVyQA4VYtDRvcwUea06G++wmYTq2","type":"maestro"},{"name":"Rituals Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBDd1AVaDRsad2eK38Kfjl+D+sqlb3Jhz4EhvuJXUFSv7cO0Q0vxYf2X81UR8if722Ts440VycfZaLlMzlCHnDhqeb5azij96SubBEZGYVdrpup2WLI5TrPBPJlDwcqbK\/AYbZjvSD2lFnJnrCu2D03q\/RE+CiXudWYMOPwPxA5uazZ8dlXXEmvh3KacG1wVwNUB93jK0tIFy4T97wrNPuBcgoEqpzumVZr7GVdu5ZsKZQsiDUHshopdhTZZvht0NEiCeE7dULsQw0uRh0+a6YHDsjGfB+cnfEhkYDr2BtoJvvsLRUIGs2ph2aW6szoFs0HP\/37YecNjQIKPSRN7XN+WCAxUlcFoYPbT9DXUXjHQMzmGCghy8FiuLc+abBHfw2GOv0nUQveBMSkyAaw9Ae0ViCTxCv8VmBLdlexnd7T8AA8frVZBFD9nA4BleNwkieZ8Jmlfv2XSUYb\/tVdovh5mueSd7sdfp\/zGwtjX+CQSW+NlSaKja+Lyn+RDhVUnIP+u6rV7+gdXLgfaAUqfFWi\/FunGZFiS1\/kM9YJrFbNnyEf2Rr2DscAtgVpyaEpy5ynUIaVXvYSxyNqilxX8MEayJkG2HE7617sy+9QQ9wR3um4K6bbeTaUlM\/TPrKTrsCMipFYevgFXMv57Ra4eLBzQKOIyMr8UpN+561af25XXxBQulOAgBXuMINjKZiYcCG8AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdiOv0yNIw1pb7GKPw8hm4kjqLasknYB22lS1sjVFDm6RQ\/TkAi5N+4zlIbmeTFB6qENcBY6","type":"rituals"},{"name":"Hunkemoller Lingerie Card","paymentMethodData":"Ab02b4c0!BQABAgBOMjIh114zJyMJ3guhOub7m4v5km9d8vjTnuzgFZxUFngv9ioM0baZgjbHF1kitGBWUiWuffyLY6+NOXg5DRbxNZAIJbfW\/dxPkD8Vv49TuK7XKKXvaRpBpLiEVIzLlvqFC6KF5pohIpjioYTbK+VH9vzjGGzyyvG75QoXz1nZj2LmVrds83Gb5JjBxeBtqwROD\/0RvmS+wf3ybnoeh\/06SKaRAWz1W98PMe9AAvDT2s\/LFkPWjmFpGnWDK7mwKOWhIULLfnJZOD0pnb\/XorX3VPae8sJBEJdhuZgVXk+aox55WTAUpGKW+8UU+tHY1kda38Nn4ndRQh781os0v6edJ1EFxlFJp8cIcXeEf7kvuIoufCPiLf79DSHxJVCsEA2Sq7uKcTnlyaoz3uXWXp4JA6lQLfZKvlwrzcx04TdCXAO70Y8G1PSE7HMAV1bGLdf\/ce7Sys6VTGHDg+UZNLl4rY4PaGyvhrSbMBWjiolIKpfSnO+nn0U0JEbFLHRHCrM5ojth10+pLkSaaFGR+HBhKQ+uVaSzw6758\/yeV23TondUCl9uMETryEkpQvEN2OxgH0TBMnmB2R9ubwYjGY\/QytJZDnhwWBm9jbMJIoixEIArUiSZR2jSuq2pTtb3crGl8gnMDvz6yvY\/Wp7pWo8Ay62pB\/EfWw8yQkqCVisNehAcd2Pr2NCcmD7w2Ix4aIkKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXPaKLqHcQLV4IYHaD6ib2xySERpw3Mdd4CedXeAqGC8nKp0pPLQ46X4V3TZg5GLBcHk36UmFt1E","type":"hmlingerie"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","optional":true,"type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"UATP","paymentMethodData":"Ab02b4c0!BQABAgA+ir9YQzKM959cQ+mKHK\/ACCzf+epb7mwhJpeemAETLlPukrlz6cc8tv\/XEzHYcSDuBLD7quWFzkxWPTVI3q1XrexQk9bWgqV3GLdkzHnP0isR0JLEreivj6Z\/af\/q2IbbAd8c6v3Up2GLZgOPkEwiLytz0pmrbDgE+klCIoZ3vYKhNLJHDzAPaT5cyg5Rk5pjbZxz9x3WOajMut2HF5mQw2245mtaKYLT9SCcNCEOEB6PbRCLYYSGCvm0fE3tF1QsqptFoPReAx3U2NJw3ssOZ+C4W9H5qPR22s4HCvB40ZQIchux9O9x4TiQkD\/F8d055V51py3myBZyIXW3IHol483fYM2FsVs0PMkE+t4v++cKgQHw9I\/T4S4xpIxGhdxb\/Epz7i8QhxturHB\/3xFbr2JmktzFtLI27NJ7kdhfRE9WghQIMjmqulLBXc2iF63kuHKNyZGqsyr8OKS0mmGdWgyaR2GKEQvJh0kEBa4ZcbN5dWF7C+bba\/QGg59dAttGIEDXYM2aTI\/o8uKvPKyWrhtzkCmCtj0iMaDEKSiKVJVqfCQVVbgl8xyQXA8ChDbGo3TTPRgLUAWDllswkTfBfvbXtL8sNNUAa20zwo5xAMyw2gt0H8C3xnWBDy3jNmqVzEyeSe0xFvPXk7deYlKytZ6SUdUsbc83qaOqASv1NhBOL8ewqdnnYszv1JTDp8loAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffr6Kyg+U\/BHwUbzhvvBmSBEwlB5SD3xWgEq8rzCViQNW6TPdGagXycftIVUlnJ7Dmp+","type":"uatp"},{"name":"Primera Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgBr+wD\/5Gyd\/QR5Gd3nQfdZ\/wpiiOWsTDw+AhVQV7IJwyxacuJmewIRy0O0O81MoVvRc6hb7vCTfETXbBclLTN2sxgwWMJEAAW468XQPi7oVNoI9xrn6f1cscY2frgc3L+zRA93sCADMPVK4VoJ2BHkTCOoDSXeFcc\/RhLBjn7Uo8tVohMsWGuvHvDT0GyDne2V9cQeJ\/8Kv2Wrc+2eO0vJYfspLRPvFF7DitCYRqPknDpREwvimweEm2vZbfZO2DGrBizZyGIep1HK35rVk8\/d5Ep88WoIt1IXlXoZODsyx5Z1NkN6RSlPQtZspLb5An2uxmDGd1eziUsFJJikbpn2EONJhJxGNfdJjMbvRA6qdE+1Kx6Dlk+s9EQ96Bg8Ho\/19Twxvcnhgb2xJyoC\/EkE6dEA\/nwQZbwyTOw74PeKgBFcbx1ZvcblarESRTc8R6JB1fuEoOKVKJeifkpoLU16dvLZ7YBQKnUKQmskcwQG1H4A0qn\/kq2ztY1JdI8haDVh2ZBQEJEHhMGXqeO4kX96W7y0auXb46NfGhRzLmu+82I9DUg13U\/MvatGfYiTd3KqlBHxgxvx3DOFKnE2NKeoxiyF6bPRZFKvDNhDXZFSF55f8Mgjwo9CD+WCF8YbM7GlRxHVq7STP3pFI8CSLScNaPp+YsezSo6\/6gJeOdmw3RD1CQXCaSJeywTMaC1\/mlaRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVgriUMVq7kjHCRe8bocfRBC4Ox6x2N0IFlO7PWaHuFYtIoTGvSa2zyXKIDP+WrqyPZ1s2Hj408pibGA3Il5Gw==","type":"primeracadeaucard"},{"name":"Fashioncheque","paymentMethodData":"Ab02b4c0!BQABAgBTwcz72WQ\/rWZS7SgH2Vn8g7rWbGC8hUIDzjU2RezIuYG+QZc7dRUdnWEarKjDsnnHwhj2+bFRC6dHaG4OcSbbQV3Umfw6DKYzAQG237U859Oeb8hv4sgi9bsZl019pZ1Lu6eNCficLEVFklBNG7zOcTth3OY2fzrE8WwtgAQy3MoncJwwDtU7nY\/kYV0ld1yggEDG2\/nsg8qK61wXqkvpUxWGHeCZqjivzFdA66PHPB05iTj0WlsRigIoHQ6Z3NAri6kKe9oaoj1wOVpZ3LScUcAo87w8CpbYvSROEOnlXfLvOQD5tBO8sJQo8oZ\/Pw8\/Xz0UuAn3G8My4vR6wgYs+5bkCYpnU0yF+4g8\/nUOs3V3IXb0ylgoXO4X17Mb6O9\/zfWxwNBXiVOUFWPkBA527y69lJ7s+P1xrdBFBTOnLsm2nrSNu0o+DKHYS+OXbK3niywYaEAp5viCBAbbvm2ueq3Wvz8t6lt6TnQx\/RFxE2YS7wKJEZqWeGyn54xwrgtFKkXwL41tUInvOy3DNIQ+QCGAwDt3bAqiVqpmyeu\/5d2w4wya22HXs2vc4M1BQ0nEOs2RgOQul7LYyz0iOm8IpkZLIrGuq5Fh9\/nyTeKalYCYs1yLk01qn5\/RTLSzJDEeKO3IpBUXt95xY04Riu22XzdS0LaGZXXsjTihOUVvrhDq8gRHzofaaaaN1Dig\/07XAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQbcBV13AySSRL7q9jEJ66VjBiy1pyPT7p+5rNS1f6nFrX2yxwUAuIrtfRkLo8msxea0hY6+GBy8ntAl","type":"fashioncheque"},{"name":"NETELLER","paymentMethodData":"Ab02b4c0!BQABAgCChzD1kgErFNDP4mOuRgJyNzV50gjQtREUn9li1iXE9EHo37JVkIbGJoWIArhh08dqFhUJ02+GUJ39M\/pvwgTm0NX2i\/EoWJ8MSV1oNY2imOd3\/vB1qZ278DwNf8L2mI0b33DZu6LQomKOX+9lt76RLbeQR6ub2CdDZtMI+k795cNCTqpBNeUjGF+03GVfq\/PmVVIGwTeRMxoXICK8bMdUMIK9lf7RQKeWBdtVdwsCE\/3Vxo55m\/BSNMV1TBx9Gb3DiW947mYUXFp8dTHrTVXubFGD1ps6uI75qRzkmbsk\/W7giZxW6h5\/m+ntyxzG5QVMbwHYWlxMLD84AxkG+++4snsbE\/m0\/EF1rLA9a+4C9AngtZMjLugMRGt8fwuzYbFQPY1mY7hxxJsh5DjY5AHPNSWUljSQXR3Wpa4\/67H8RZ75XiKIF7P+B+R5twWFx96AHtTd23pusLHnPYl0VoN9eOiA257ciLFPgeyx3\/RUpfmPllsGgy59+7Go4fCe2jAsAWjDQcVRMs6HyFFQ1B+GRQZetNPLCBpgKVThhiiOikevHsNQ3R1W1OIRfdPe5Jt8sZMNWo9N\/nG4yqb6m0Wrq2FXdecjc5PQDkua6VfokjR4ikjBQ1UPeYJo44f0obmLH9d6amH1yMM5A2nv930VLjPuOCvyj94otuZz6jiAPhCdNAEXB+8IP0clv4vQtIWoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXOXG+\/p12zPuFSinBYaAl9PsoaBeSuADkiwhiK30SH0JmDstGNO3aHTYsorlFcraXafcoQuag==","type":"neteller"},{"name":"Adyen Voucher","paymentMethodData":"Ab02b4c0!BQABAgA4m3Fmy3uAkrABwPHO6ZuMqte1FwI2I46Gj7wYm6jAfz9CYWqYqAmiMdnjKlxjfYPBws\/eDmYwypyJzUmSuuQ0ABXtT0dF3Miip5GISHtTRPuY4PVc6rhd+faICXJq39e\/QI4sFwPg1k1xu6i3kiSZMG5qcOaUbCcmbo7sapxu2b0neAnLj7uoqJGt7wWArzEoJ1OY4qH8+D7f28Y2LFo8cEd2rva5DTBzTLP+tksXVpzqZW9pkOXT+e7ECLHc3ahwtqLmv3jJssBQi7uj2yDl64VoPaNfwhAOpEirY0dNenpOewqksAgdmvMVecekfiWPbeuM9cyrrAUzypnB2IfNmaIsRkRkmS\/UXRQclz+IT60QhoowIPlvGiZdoAbkh2O+6MKcSqhmddYLur0F+GTi3knseyff6r\/6Ovg6E8ZxUlGaR0gZ2b79Bf0INA3jYYZgWI\/mV0nTfMZ8QbWwanQFNP0BNyKe0i3qhdKgvapPHcMiVW2N8BQZk86umQTn72mZg5J\/D1D3rJ91TZbNqSSKKUdIcePlSpjd0hV9J+NUTWCpg3xOUyaAD3oZLBRsStmiFKEhFy3T0rw5m0a1A1fLENYq\/vg8cj5K8igql4PtLKfNVckEls9EvBLfW0vz00nqqXRoZMgmFh+Em1H2QHJpbEQvq1Co042ZFGx7wfZADBBhhyKK03Bxpag6b3csSQ6kAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQlEAX4IlhbcsGZk23cCI10LWUzOFL+evz7R23OxpQ97a248sf6C+osDDcCQu8Y5fQNRGSictAY55XdhLKNrS04=","type":"adyen_test_voucher"},{"name":"AliPay","paymentMethodData":"Ab02b4c0!BQABAgCf1auSGoTYhtg498bFc6haRU6NhnNLG1J3AxjfOfY8MQTk3r2R6Z4ApsTvCopJHVz\/SQzuanZGKuD9Eg\/1Ie45c4tVKgO1jlfBR1d9uMjKIXcSGpzt1Zbw1HRCdHfUKv9kgQFgdSm4PEQ9Xtob0Jr2tGjm0HWmEPFN01rseW8Q6wxvBbVk1RhJ74rwgmGGr7GZXw9zRPaiaqh6Tw5F93pILHz9MFi9R224925BjGeF5trdMM3guF2u+S9X+9YdFPx0E\/uioYPWL4iUqHb\/eqUMHL+Ul56z8ZIakje6Cne43bwAiv8n1XcXtiojd8pO4TAYEPEO3OFZId6g048gVzaBj3Z4NOaKpPa1hkricwbm0D66+349Xt+baHl0JOtPOR\/bQwRHWop7rALG\/hRjivbvrCpER8iEiKaPxNSZoae93Ue9btPL0VhnaWD0NpcxicHuvZbe9dKffnCRDwdb+oqKMKSrgSNGdkeaO+IoAPDhvZGD09WFGVdWFGwsm2reUVcOfeSkeAfiITI\/ZcFlXcV94JXvvYP47XgvDrTnubDVfwK60hfVLbzywzd1cV3+nf56ss3b7I782r8RXcF9GJyfNdlvI6NW7aeAwsBPHcQhHZiT+5VHXbbxyDd4qT4tN\/vcRXz+HP4qULTxg6wxIM4hztcW2X9aJFNhzFYNbvi1uRAgDu1+S5xChfsEqkutUHvVAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffDrYa7tRXGfbYA6Ge161KN7sgVl2oNzl3HnXezyndspuFFgDrhoiHelB1iOfRNcojjlLYY=","type":"alipay"},{"configuration":{"merchantDisplayName":"Adyen Demo Shop","merchantIdentifier":"50"},"details":[{"key":"additionalData.applepay.token","type":"applePayToken"}],"name":"Apple Pay","paymentMethodData":"Ab02b4c0!BQABAgC0zYM5I3qqo5UGCO0s0MdIxxxd7b29RLo+dgUPNfEFEeolvX6qNqKBHPjX+bXZGskIJFxy9YWbQQSZkEAEqPydtGr7rvRr2MIekcs0Q9jazt62yAypML6Oraktk2w3JDPZuKjzHo\/Z+YYx+\/1ZHOlpWL\/rGB2cZXSO1ZSx5EQKgfTmwlS1NkFfgQzl8sQC1htidsIOZGw9xPWbmscNhpqEZCYlDOfEzRHElu6Y8g5D0yHOXX5TVwXetum+LM8CvClX+DEzp9miM\/0TMV7J+3XtUTA3xcPT\/+byDfygb52WGmiHlEma7rDGdlBQ5Zz7Tbb8YW5y2XNp7f6RZ3ZWy8MR+V+BbFhnbvRP3pSsslI92uiDgT1j8Hk7N9cWPBHmp9eOb+iYa1yFEe9BkadGdYiDTlSrWJSG8goTRFBKRj15d43EvnBu4BXADSh0fNEXykhCktcaolHuusbFAr2CV2D\/TA8V9FwvuNXGAgU5szzvG+jMCztRg7EFGElbAWPMYyENO1EjUpQQ3\/76jS8qXBej\/OK1WtmUoCO0pltPoOPaF+swtitwsF\/t6L7gAEbmufAEpmBc4uhAhfSjh7vhurbWpbsWkeMWT\/i+xAxX75WzCc4jLHEmTW0dDoWK65aHpFqNhc9DnJMDNApF4jy54\/qmzZhQMdv5ZkOJ\/eUcZWybsBD2yl6FzpkIlHBCE+ZZXvK4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUn8cdiUMVFJnCsfxIFvccbkVMDMBW4yRrz8Qb2XROpsA2iEH05CECs8gLQYfrZbxIkjAOxMzQ==","type":"applepay"},{"name":"Baby Gift Card","paymentMethodData":"Ab02b4c0!BQABAgCUrswZjd5pZD1KaDp6qqgZyn3\/U0SZj\/slMY3xnJoJV+2FyFKMW9sobzu85X7UGm455G1HAsbm8EyIFVshnlD1Sd5ImzSgVn5dvjVytMKuWmQotUFVoyhg0SaHX0ZF\/+ZbqR3xaEYQvhAZdMJ2zlAObRs6CwHKA6xYPQIgoEPVxBhGCK1XLkFWRm0Q9+sMj68\/sa9EKf\/+osl+3R4O2ZB\/4cM4p0jvOBD3FYEZaDGJbONomic58+i3Urf82LOaU\/VBIfGCOLY70JwUwoleAR8+tLSiJRLks9ujxgf26naSML3f9H6OmjjG1LMe2Nt2RZZyFyMkGt84ACJ7k\/q\/gudxWskc5a7ZjmgqO4mrBmRmy\/DZxcPcWavLS+m+8NXaPZken1i6L53mvb+BryRtIOCgM+AhGyUaPoXQOF4XbLqhNqTHRh6UjH4MPLYJrVoSiWSvRsv2J1268rFTHyCFzvqu9v4LCGiP7B45AFJnKphFb62kr6bk5vmdbpc\/S9WUwq2avCbU\/dGFyIyn5rdEammsfp2X+prIEBkMdpN1arErttEpMoCtpKwMqytrvgrDzRgK2iPWAWu5EXB076VJXQt4FZgvWVH77p\/d2ZB1nxCNNp5cUj9ITvLwugnVDqJVwdt3Ze7m46dOj8F+AJAX35t9WlGhmh3Meoiq6VJwCgUSEBCfaieS3oR9KDXDCJYZ2a5YAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZ+JyZ7fnomDQmxQ9n8Ai8mE4Ud5mN8EwTSRGw3hkUzlflEBbmW6H0jk18hDxxxXoMoirYssuOCdtbE=","type":"babygiftcard"},{"name":"SEPA Bank Transfer","paymentMethodData":"Ab02b4c0!BQABAgBzYbCACvYN8F4OSxYlOtPC4ad4Ei7HCFdr0P2mSIdhX0Dl1ncNiKMZ6D7hynZq1IixoecALYJLKLynjW+GJOxzMzjLI+MA+7LwVWkCDP0iHnpLgJUzp2g4sOwr9TGZxz86VMzJ+LhfOU74tQnyF5QeFf1KT0vGRQGhYMLRsZ7ZMleWxglma8WDdFkakYzD4mLHmhYsKORTNC6wsBPUewd+NbZkEA++ajIcTdH4NWR088EyewAWij2WXxvvtE5Hzh7iEAqoCUNXcWeb0WkeHTYXOU3m7iXH8y18cxz\/ioTYmICcpG3tX8uvWmmhiZNFh0ZD8+pFcrWJAz5xmBHa3bCtLuf2Dra6NuD6DZ9i\/bIg8jBJ+Oxe7EVwIxuPMWJDI1evntEmreLWMS7ryEDHjwanCLNv1rzSypBlZIhiJy6WxlvjIjekqjFMbVJYnJNRoJolMSyOAm+qE2ftM\/e6ZmN3FfLlGLpqRIG7m0Q2J1muiJBv+A5FLAJ5G9gjVJvDE4iEI8pLbX42UlFmRMRAcCKNuVsilf8bW3a+Dx\/T2XuLdFE3jTs5KiQM89NVukVfIR0BJi\/YMZdGqQuXNxGA8YxbHz5T7XQfuCHgHsiaWvGfgn3X4ozTyddCfjguIJ0pOfDi3rUwjK2uH0eBwzTE7798AiVcjC52zUEtpZ6fDgKWRBCEudgGtV4Vzs+CPIpRNaY4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbOWG7Ib98uBx5r9C4Ki1MOyP6skIdgfqL0LR\/tMyQrnQjHGUVCNi\/tWuaF0ubq\/EGOUWRvN4dER4iQiHg4=","type":"bankTransfer_IBAN"},{"name":"Bloemen Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBYEjHQXHsPQ53zYpWNyDvC7SNlrLLaAhQpjEYQk8PPmdaazLV89dowf+a+xepP8tHOTUwzobDVj\/KU776tP57HmcE4gjsUikDXEfiV4\/CSmp6wszy+IKktTTQJ\/iztld7+uvlAtRw1mVPWofaA+B7faxcxduC1jZpi+Sx7ciKHQylGvUmSe9saoz+Z8VyyldP+K0RSzC2+Pw8CyKraL169mDUXW\/5FNNb4Ig8HRVSX\/5Lhi+xIckSNej3wWE5WBRcnzX0PUVKVK8iMO0RPVNmmBAu3egsDKf84F8YQJ08sYEupa1orFHzvVm9JkHzca1zjKD9nMA0rv4AKaglpy\/j85hPLBRMvBEXdJRk8FDojP4C7cXg4yxLz6YbqT5jOB4hd9E0xBfyRl6T6v7XV8vzXA\/XyMsQpH8F7q9kddAIobfNlxSrwqRmR63zPIXuXOudMinxlH5B3F3RHmG5s7Iux6wLE0vrfEJb7T46vn\/+ec6q6Xz\/ubFsE10ZffvIyEM45Nn4BvsgvnL+33zNryl3LEA7ZYCLczmtO16jkxPa5ef1ncYn6+nwPaytmABtJWV5LGAlnoCB8llP8lxDWFQmccCymO5C5KqT27Lirlwr2+9ea7mb2k2mpIqrkbA2oW06GXJ8vGrXHlZ4vRtxXiJM1SXNiU40tfjsY56dYTwh2ZRDooipnPrgBrgDtwnESO1YZAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVq4UMZnNJzezmTRqBzy+ZUCi\/kgQ8pLf\/wuWIkt+XYuYdBNjzZ4wgivSU5\/ixwXRr6OIqRmnfLVJQyQkwc=","type":"bloemengiftcard"},{"name":"Boekenbon Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhXa21F4rgq1PNi+V9vpr6buE7fMZ2vfXfklIHs9yLO0UwaEBLxDY1aLRDkrCoPX\/zixxQ0J+iM7WJMaRPj9Lo86q+oee4UJt1q3lc22KKlrOwWSsMAWQ4EvtFexyITl8jOqfSzstprJDMC6a6cmD\/Uuu1\/9u+EucT9hLzor7uTpvEB+qQdWhVOXkIbi3XgKuzHkZFZWC\/cXmeuvihyaFdS2E5N77AfElpwTUjjkSWdhuTT4YpEKvV7eGNcb4tknPkhtW7XNXBjOeFecLNJVRSPPs8zh25nibZ0LESEAxUVQI+Ix2aqT0\/YARhZsKWVkf7yW24eP5uLO+3XcmI8GBHyd7ysSDU5RkRBcieId7sBI1nLxmxgA\/4E0YRg3kcN0l\/ejyLKhndPshLpcbJsdQdupQtGj2wvK9iXk5PqxlgY8xmI73DrFI8Hj5KYq5BmT6C17J7Klu0olLa2tQPkq3y3jYgDc+UhuCjLESVt3rEe8LGdKyVg1NiJxJV2iF+wqONs6FJBMKh\/Dt8uMkt528lRWkcsPA0kC182YEYzjMFnWMs1NaSemtwEd2gOvNJbANxduIawfrXA+tmD5Vk6NnMcWfO22hlGu8Ov\/A2d1BrBa1210OPxWi5h36f4xOvCJZB1kZrF\/8LbwDNthGuIOUoFzX4s+h1jYGnG01K3unmaRAUMYsabp4L2sw5MU9ZtPpRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaO8DXOTDuEp12ZTJ17xsc8hPNMSd2fEMNY5K\/Bq2ZHktR+J1Sip6zl3AMAQJDedPMUNKhYJpRg=","type":"boekenbon"},{"name":"Cash-Ticket","paymentMethodData":"Ab02b4c0!BQABAgBsZiHDR0Gve3zcnmYtLxMOTZLS4VF3wWqCwdtspiwJYi954c0akftgKzKMMcXoFRXDPZpqJ1DeBbkZ5eKjZzRWnjliE8fjO0PBANuflbRoNwyHe+eVa+0rlve03uaZQp4VO66WjFLS\/YulZ1AJGGyhka3MVkhsE8AWdJeSADCTKFVJA8qC1lBJjaB\/eLA8EHerqPxHYpi4s+ykFMsfipRHP9pIk+5xULE+S6NtTmNVT9JWsD6F+hbDFm6BOtrUnEKx3FmlZSYMY4n9CT3paF0sH2pNqJ0PZ9QgIzO21pb9BhCBt+1rXjLNXp82kOzBI3YRVdRGCeSQ2Rp69ycAGhLikftZ1fwRITnrMfjtEhgdS1qbIiEsAhyB1GIBa09755Z199U4QINvMIhrFb49G1YOsPyBXMyzQHgEAUxY7L1H5CwLDo6skb2LzrseaoKXfF4BoqfESoFiRbnI\/OcD0nh6+jFswHIPXJcCRIhfPqu\/pvnHNs+TpWzJgwQTyPy1C2k3D0e5gH1I4gcn46xYpZ8IccL3U53CIIFFLaVwjn\/wUackQO++SixCiW2A0ot5tS+TVQs9w8QrVWKLLiqTSuErcmgyTi36Q0\/hwJc8YCuMzSEYiNxk2wxHTdlHG4\/W21a6EMp+SnCWQnotauR35c6nH7frYHw9x14\/UJ8RY6eG+xB4fN\/KW526zbNgJPLk4fAmAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifT8y+YkU4\/u8F9ki4mg7yPxc9sfwIjQ+eYihenv6i51RTsNjHTECoPrQzMH45WT6euh08tXFLEmE","type":"cashticket"},{"name":"Chasin Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAUCPrmfgcg1JzKH99DvGr8BkpD8H76IJa5X7CQlnRCC4ZWxLbr6sC7WQbYhQjZQ0lYdTMisYPl+8QjAEPr1N6OGsWSbofrBhc8oNe6Q5\/kaJkHW5JFqUgMjnun+jSDRNSyuLOdsPgOV9BcKOYwiehV7v8dvtmS3KW\/l0TMgwHEn4V6bixIsDkEPd7uNX5p9ubVmiKQW7qry4vXq+OFbbxIWuq\/L9FawvKcYbqFjgwgsdZlQ+Y5zmlaDSQ1hfV9Lfo44Ph3vXD7Evyt1PKrmrifi8hcDeKQfW66kBulfIxesI\/MS2C13Z8cD+WutVG0rbD0uc5cxttm89mjvZrBez9QqTLH3MBK31WD25UzXKRk8C25Jdb6iwxR5NTDrRFQwfBgtBdFSpv3jhd3\/LCj5ycPkVSNOKQUpiT0GIBNJ4f7uxY8+vTGfcSjF5jz4kqI8Xgr++1vFAKCN0KMqEoePGxPIeTszSCKZjptZioNxeR7uU0wvaH18iqZlUmKy5K8r00fZAkxC8aFZOuKSx7JDdzcx7Rbv+4fBiLrwFXLsN5Nuksm0WIQE7zi6J67SGXtlrXo\/bpnp1duZzJ43KmWZYljglXd\/l2usrIYC08dqEwc4DUHKHVfiYzZbzbW+JsakB5bU7iXkJyO0mQZ\/pC6fnVogb4bo8colc2fpM5OD5lnhRDeFz6l0F+msrFfX9vv24wkAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXSVD7Xq\/yT9JnfU4nQiMdrcf2pE45Hp0ed6hMf7e9Tg+uY\/f2i70QpL3dxpumUcnd9zDUWTOJc8ddqXfQ==","type":"chasingiftcard"},{"name":"ClickandBuy","paymentMethodData":"Ab02b4c0!BQABAgCpjBOy6+XhVNGcD3XQkmoZdhv9fam307qmGdDkdieV5c7BN+QZHV2XF8AzgRmmUwTtHGgCvxIA7iIaDihSypB5XjC9NFu1CDwFs5zfPS09kuiZxgQXm9anvVlUgDy7l001y+n4maQtgXhN5olaUMEQ93QWg2WKeLbAzbE1+hebus8bcjAcp300TfIwSD6pztJxjQfwRvNzLrhRgszRipi8ruiGMI206YxJUq5yjpV6cut8MgMfioh3\/\/PLoiVWoCjkrK0R3TjL36fRVwY4XNBslczfEUlHCTnM6jLjjCqyAmNHay3oLv93k\/UxaJoUo9iMzFm7gu+NM6V\/eruSvj28dypv+UN+4JAs1PIOeihxOQxI56Zv+jKTO8GKL2VDOeXkBNy0gQmm0B1+vyDUGSV5Imc\/Ykafk4qgXPXG0tz1LH1UHgu+bh9qr63zFpilRpiu8OkoMqHa8CkqyrYG+Au9Ql5Vfh3ZJS9RF9mu1llY2AvNdoue75rdglD6kJop2ng\/8PO8vUSt29Cdemamtct8zQXd5qwC5jukW3+93brD34tTdKdi9dlpQa\/Tcla9vwVwxEerqjiSKx\/grl+R6ojktZXT+tpo5Aeey85EmlM5L9\/CstOQDjA\/hU\/D+iixa8z8vlrGGUisSOn5Fqu3n85ib1KGW+RHNQAJu6u4ZRBCLhDUHY5qNmGJtD9K\/pvyP1fsAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSFcmmFsCSPTa+2JtLxC3d9MEWXmttbt85uKKpUnwwo3MD1lgu30j46g51TaVETPNu63LZYeC94=","type":"clickandbuy"},{"name":"Costes Giftcard","paymentMethodData":"Ab02b4c0!BQABAgB5dh0e0SvTSdZSqNYMMXtGSsTlyg4chLnvV01NpL+W7I9Mz\/KgwXYe+LYuP2yGoM6TAzQacDclI3AAnXAQJi7+5ay\/j\/a0\/m9ViKjmMcsO5f8S3mlxVApyIp1lKQod1QRWdnfGi2jsbq2DQ2hOa2WnU5gOofDPN\/ObZBAhZK3FyABfJvQ+mHMQ3yzAV6UMxPKR8VRRVBr3qexpeNsaSnT46JpijJUU4B1FAJUsIzivvDSzBcXzBNI\/9EKQbA8wbLb8VGVwKBHun5rPB5jD1uCRjvt7d0XuA6hNZiJ8yMU8Zv4yDc\/YmTEStNzZmy+ZjSZOHWKOzoyCDjfICJn3RnvhWJJDNLfbZ\/9KQV8NcPm6Mpm0fCjf152UZ9YMp2nKhGZhnijz+XLGkzUfAokrJB9d+e2EmiMa4CRubW\/gwFrg0yWK3cUV6+FsJT0NyTKkhv5\/k5paDvp1GF3JvIwXPJzpUEkYTolCXBeld+2YNcdjvVEWC6+YC+XJofqSjs+EanKcoG2giz6QXv9ESYwIOLQC7TcxHhwvJu7n0qEPWWvKUdYnxW57ZZKyZeAlwlZ3l6nNwv7d2cvEwxWI\/MSf0dqgN0mvNJTxpEpDb7Uv88IdA1QHBzl8y5Rfn\/XT88yXj21BN2wvqAnvCoU22FgtK41Ti6HBsRRakXeaakmilJf0HxDWh+wexHnojtqXGWZgQZxlAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQ6kqwSa+fIsdB1ujIQB3U3EgrGldRb622nuP5vCg9vZM5Md2djfmnYIK8poj1WQO4\/+ZpLTzxrPFYbk2Q==","type":"costesgiftcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"ExpressPay","paymentMethodData":"Ab02b4c0!BQABAgAlRhg2\/ZqSemwr8Ih+EPOdyII2d0Fqd+vxWEbnLhm8aTFGk5cJ7BXwBvNvp7+kSkK2+u61SeKzbYlwk8wZZeLW9ZnSvtFocxEHYriAwg0V6feWhMFlVNwvMwqZ\/649y+eA6KEX0eCxNJLJgGfzmgyX2IN3R7SEBzXoidFDI\/Bu9L1L0oTn3Yjq9zGjrgmlPBUV9CULM5bexH6atWZJoXvQdaUzEh6TOGGTY6myFl1UEVk5+tGP8imnzpAiN1NEGuAzRawNh4yhfkPpQ0Cjm2CNFCri4+A3x+23jXkRFSJtCsZIyl6AeXtbDdBEwnRk9XO0GCxqTwvoqMT1mIp8tr9w0VSiUQfO1YHrky\/N1DLjkWuAmuZkW8rkgO3XVhwrtclmH8+yVhj0Vo9NmrJIQ9I6Iqxco5+368N8plzUCseAlWMmihdlSjOJtQ2bhnBCJR2A+1KSYk92bAccae2WQMWU2cbKZxUIIO9IdvendoaLzXj\/OvpMw3H6OvSbzW+Z6BFK1izrNRilrUyPOG5yL\/bnmpHJt4ueoX22JvnYCQ4KOBa2Lj6EUFyQbZbyv16r5bTEqX8ksZqVpLnSHhvyx5kFcFm7h29\/+GzZ8i\/Zi+1W121GBt38+ZmmNTx4iwRRPQ7zcp238cPnxarzHOLpWHmr42VKrU8ra3wi9i2AoQhd0hAQ6gXAx5EsYBBos\/TzRTbOAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUtH0xd+yU6FqhdjryMG483NbCa8oLdhRm9Q9uNTwIBmqqaCWfAUrVW5+IIq37DYV30=","type":"cup"},{"name":"custom_settlement","paymentMethodData":"Ab02b4c0!BQABAgCT\/yAsGsICPsYIG7hiOwZ5D+b1O9G+K7GfQfbJrYmfFVPbjSqh\/XaKdZa+1mTi5BKwuUAV\/VlOPkPQ5yHLS9X6DqB8YqJVSeWEC6HsfX31\/ANJ7ZcL4HFhVq3RM6D0b\/V3iX4DoOQ8yHqPy\/bNHYxaiF43psUHdBjWsQyFVlkVhf4JhC4fJdPlOacag5twyZHDtWM8Qx802T3GFWUjJ6U04I0AigUBTMQH6BbkthtMnCXsoie5+vbWndD73v8luguHw\/5wh5ebwwsgmbVLzi0\/7OITS96hiAQqR2u8dBSBYKhX4G3zfJhmNJyp1g2z5BU7tJp\/IYU+LSDqkQJnmUeFhQGt2wAFIgFqjIqTrFDzYDXiwb2U2jygr8v2TzGbt\/hTTknv\/xVSAzU5DzADJs8\/nv7l0uP5XWAEFXfI7wuUHxBTySlIWPAH\/+uoyhu+QLfAT1jLW4srNTPgMnFlgiuSRVi\/KGPAlN4HO2O5bxWxUZ\/136Ak8El7\/BMzR8tjPRG7OUjZp+4ehhCXNeeBH\/OJ\/FykNuysKSklhbOE7Tg+N0pNZ\/fiEOgCh0OWam8FOrtLNO9LZ\/M3HJiFYnOT8jdHp9dvUIIZ9758N\/jG+EZrVwNL0bfH0thO+GhTKCPsfcO3J6rTYdOpW8zMijfLk+KCjVQxTD6oc27Ha23Nm6gfNhAPV\/w+Ptb9f4WcmQyqTuGFAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifR75XW+jn7EcYM0F6+owXDrbhi+60k1z1wlKr27vIyAzr8U91Jm14Q7EzlL9zrlbXd7OzeMVjbAOCdHxJa2MXA==","type":"custom_settlement"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Diners Club","paymentMethodData":"Ab02b4c0!BQABAgAo7InmjrgFwmA7lm1eSiENy0cDe92QK9eCftyZ0MRsSqugGYF0kNdG8LCw92FLceMnnljTGM5hhmlTnhUlBESSfbSOLf8d4ECCcc2W4gVCNoOxccHzoQOFnumjwK7\/Nw2F8gXIApCxRUCnzbZdPdXbwoJRaak5KOIkmgStEOBAoikvxvcckvOsP5K84tK6QlyavL7pXDSVIcwsiyKoxzW47wjC04ti7D+DkPqBb7pzhcx8Fu4c\/28AhXtinNMPLtDPjDFA4wkLHvVuUBTEiRy27x5wcDWbHOVEMnP5yqKmJuD7Msad09y9QxJPgn9u9SlbP83ZxPRNFD1jjx3z0ftrQ\/8Gu2e\/BQ1ib1ES1eR7nOG08r5aZ8LrkJMdbuxYK5EObCAv1LKaiJNN0EursZsq+0lLR3I6NdtvxlICrimCYS2pB2vNXohDF8Q6gfcFZgAp8fH7qVmMPnokuP4I947gbDTd\/gH\/sx5fxUVN9oRQWCmhN\/6y16wMCW9DV4vXvE1zUaTNDM4E1Exihr19UKyifA\/DrNKgfBE63SSav8nT1v3N46GZbR8XfXs0R6iad7nxgcrX978op4fRt2tt8wciszulAoDQp2xXCAFTcs39mBqBE28zh97wD2tv2ml4SjWU2HJfXwX0wYUAZdbc5M0e9a1RqLwM5blEx7veR5SaUxA0Z5dML95Lu0GjdnDyrTbQAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRjz1jnjq8n1nAh9RGubBrWwPJjLS7IhRac9SzrYauDeqPcken4Am0XpvzzJJ6O42bAUYmM=","type":"diners"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Discover","paymentMethodData":"Ab02b4c0!BQABAgBYFaiKDD9t3ppHHM12pcphfSfkzj5XQmBKyHFyTgXmRwgM5DCf5p\/qm83HJ0Rwv8++3VkytEGkW5ezjx7niA\/R7XRGPC4JFe5m9BkNUad4OJJKn38246IX5\/tCTC50aazjLDSRAYDfOFwjCK3iCy3jZdbHjsayq3Sxk0uektVCAfGvgOtgFRu\/qbKxfHYX5JhRhRD0kLHqoPy++r1qFoa9ZCAeItPwOOIiOh6y5sIS0egka\/z35JFIpmPgZA3T0F6C4+1\/33Lqf\/Imxxa1WbxxOK+hRFk9xKO8vWA+QLhsNKiGBDdwrrP1IBZu2\/3GRl4c4vTt\/aTfzBMsYEAEhxYKvdpm+HLv1uvY62FP9VzZc7+G6tLgzhELi3Ugk9b0cqW2QkQa3GjRc9oyCmlxpTg3aN3HW2WcDLNH5obGAeI\/KV320zNx6Dcp4QHfJqFhajbiH0kJpM0f14PJFqFIvkjryq\/3xx4rq4VWTvNYbsQfdkjmjxdpuZA2lVFbM7FWlfr6dujmw2\/k+Nc\/LNKocXLPMFqNsAE5sgnBCiaudtBhzMn\/Jqg11uuejX7PwuvhkH2IDe+C941niVbdJwATT5s+rc5MU0ve8lYbannglu7vLpa8Ay+dbViS5zyPTCYAYOhP4hUVPb4ISDJfMjaZ+7HHvTmBbp9+xGlrIOUshG8qkhA+h2IWHVsMFvPKmfBZSrlpAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZEDk1OhXuh02mODttzWBOOFbwWhn5U5VBlnQZ4pzEFgfDteYqOogaJ1hfiz5hC3ciAefezhAg==","type":"discover"},{"name":"eft_directdebit_CA","paymentMethodData":"Ab02b4c0!BQABAgACkXJYEWEQVGc1cvYHr\/PEToWbECDcX2D2SEXBnZpMLh9pCFet2Grp6Qm8BbRvR4o4eqXB2Fbf8dgp+PlOYeVpF2B1sKriv56YOW4+eJOx93BQuvFjhqcDAdnuA1WEd2c0p0VRzd92CLVEdAMeSJZf4+IenTJ1xqKgJUq8AEKB1N4F6LLKMHJzgnNKsimyLitKgW6DVprbambfKXL7jDNK0WrHo\/9OUBJ31eIXTFPWOV7COwv+22ZpRn+mnkRFmNP4OoO6LfgloHwMY4ZoVWrbFFt7UTDJw4HAwJaEiOMjH+prjEevGqKheo75HxpsmmwRic+P0DJkjh\/7LiNJuKAOQC3EafrRCnErTJ7lglYN2e2g06KsFTgPFI80mBm44\/5MDp2arnowl\/9kxyRuY2EOcVkmZkHtN+PCqdmHPdkKGG43IC8E2bMgBaKJzLr\/TL5oEB80fEw2MAd3IJMzn4Wec9Ihtp4goBH\/5svLh8MWGcqZZQH80VbdKJ40cWNqw7yscqttDHu8+DWERqpYpkV+vORLsZeFTAb3o5S\/9RHIzB02easuTBrVKHyVXdHmSH56J6Zj92Hqjz11ZWR8JVHkYW6DGqvS0nHI6iQfyr1gGOlSGAl8TZqr9tXm57lmSWc1PV37\/y2EW+xY\/PFWFx9rg6z+pZE+LiZpFGe+BKt5GhCOMWe2GSvn0bSAVwiQI4dCAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUDGPWwpG\/h8MJ8mwupRlOeOI6M86\/yxnR0wEHs0UxONfu6RZ805+qkbIM2J0P4I7gmdMlLPcnsCro4LatrBrF0=","type":"eft_directdebit_CA"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"eftpos_australia","paymentMethodData":"Ab02b4c0!BQABAgCvuSe+6o1SUzzcHzxwAVlkmC3SOJcaaj6IK3hGWSkfHMN7VTgEOJRSZefRN7PZMGF9BK2M\/\/wa7QZNERXeqPk\/DokBPZtA7Jir1ANKZB3Ls6EHKUMZvGviRVMt6yvg5RYkbP02\/CG90SYL1gZW66R7bB3o+7RM60\/+HCCIVMcgLmn3jIV\/D9DoL4lZ9Rdm\/FIVBXzxzhmXzx9FWGO+IjwzadF655idJkV9Fs\/nwE+nGyN8sM\/nYBzKMYYW1XxsvR8JYKqk1XbAbDf+euXRVNXiWmdNnTl5MPGXIwt\/D5CmVAZNPhcP179wX63QaC+3AG0eZhyn5Tm9sm3Rt9IMsnkexBYd9hSmSKp1nkq5mgK3R6QQJVs8yexWIndiseKpX6ejl24gp8iVHa4R3io1lBO2GbId\/EDhCzqjVspmT5089REa8DMC6HBVBnFROw26tt52NPDz5Ga752xSS2dV14gXDPpij\/qqXVkz\/rgESVzoBSvt2irWBr8tR8Xnl9XJOb\/M5MQcgfv4PlYeTCc\/iTPuj0e+GYzKOA7bsxmUrewVakmyUtWTAo0umEQn5ttzxl6Ro\/PYX6MlJ9TM9tVmPMIgV8pXg7sETJ5SZ1enW0FWbcuVq+UAkeHllhc0qnuYEXYQxChlsER8Eo3PNcLLGNHIBaMlSrxtHKx0ttsSmPMAuRBHV7wp6ZHBYoexL19bfn8gAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbcE2OmagQwrIkRbuPym64f+o\/YlUEAjA9iyzKP9zwogk+kpCbBuJ966fwwr3DOkqOQG5j9IojoMnyfGrTn\/","type":"eftpos_australia"},{"name":"Nationale Entertainment Card","paymentMethodData":"Ab02b4c0!BQABAgCjeMTCCWbyHkLqIzi6WhOIs0cfGy8ohqynOFAchP5uknx5zoGGlmnn1yNW1wootHnZoQ+DC2FGnBcok++A6EK9tpAPzDj2a15ZmCjxV\/SkQVnywWvRfL49xQsq0vfQSYKu07PVMT2Y0GWilXW5LCJEoV9Nj0AAaO05iTTwuuI\/LiBYwSLcJY0Gy\/nQoVCGmi0HRBS\/lgFzlZb5JH3f77SbbBDkHGuQzK6XR8qxGP5lU07G4pwJ2rlBHddEYTtemdJVS2j7SU\/5auXz0PCkgsgAV7CoHNbclYsL6FF9ZRJbWyDO1QpodnY6ySo3MqSuhSR+v2sJxqIYS6MNwiYbJPJj9Lnf7ZY158z1v9YfM+XLZEB1gt0Pu8TqSTJr1509zavS+5wefj2nm5HFW98Dho3dXJ9p76OT6N44+j5yn5B5bGuhSainoQkIEJwc5JM3Wiu1ZVgNLYT3wMqHyIEVArQh8hZlISVuZphxnUj6w90IVBnUo3cMUCLegjeFoBZEYHi0j9mGqMVgyTL5bi3wPH7nhIYuXk+LZlCcGPPMWbyr5ebLTPM4F2aDNdFZ6WtXkBVOZT37P27nNFXVw3ZY1T6ZhHV4\/NipJqWUTQwJ7bkf9qAym7aoZc7AyoyTKM6yDF42xKK7xU+FgNEolMBJSofshvnlbSsj0Fm\/PRD0NxGulBBiNC+IiUig22Rsx\/VYfF9mAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRG\/RN0dnQzhDj7uZ2fEMdkGldletkPTAybC8wYB6LLM45oVYPELjZX7YUjBzaoZ+cxKhMqGOfm+s+xh4pM=","type":"entertainmentcard"},{"name":"Expert Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgCTszJcLXT+uJxGttigZblCmXk1gAX20z37AeDCztrSgfBe1Aqnik7RXJPua6aFQhmwOdeeffC51Q54RTppmkaFAYn2+j7SDko0dSRbIvbh7n2do3rYWF+TYDtoa0Ebfbg+sbbjgJ8yXtv\/OohsN4uR3eUQWaDYkv7QjX3jDP4h\/V2QhvRYzOf9CY0qWx9rFmMyG97+Ck5vltpQHXAAjFaEZUAjJ9G4grUuWByViFBtfqcauN7a\/uZ2yaf11giCm96Yju27Je8whJiKgkq3jq1HrEx7nx1nqF6vS1z5JqypRsvXZpw2o6Aw7l9N5KSX5GEK+DGtf\/5o2X\/OPzakj7JqRIBd4\/czCVDpX2d1rh1F8USTEBOyTmAmJHMldg4PaVPTJnOQkXZQLEQU0fR058QDmUKQ5X6sO\/ssL6uK4HxP9iNrYl9ZjERiFwEYdJI3NZq8Kf5mcKtlgxYBSZvwlud2WDv5NNT\/OlRRrCJ8DfO8oykgRArtCO1gaFdhguaT9qWj+2l84JhrldUVdJbTgZtPzdC+RaMkxsEKENWIaPFSr7J8xyqj6sI9KO4Z0v8qtp0Xndy\/3LfEFJW7d94iEbg1vfJhDrp+rDDxbN1ufswcvELiv31DuBPyj3zYCDdruuGtfBa06jCR5Zed\/xdDqQEYzFTvw+mKVx30D67l0Pnx6hDHUvryfFE+T8FuaEkViKnXAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVmg8HpFTq3+PEOZ0boCkxR5E4l3XlAHYC7o2QP\/gU+cOf\/RLlNEd3pwMgpFrA+qq+LCSa71oCs6WKAd1w==","type":"expertgiftcard"},{"name":"FijnCadeau","paymentMethodData":"Ab02b4c0!BQABAgCyjxcgXJ20YmmZzakseod5p2QVS\/6zXRowLF1QOY8MLodRhKc\/tKFwqfUNmdsNe4OnZgoUZnUzqadPdnqGy1ermdQfv2Rfb5ZNttW4WvC6aVxFlTlCOFWM9UtWgH0O3sIc56Pwu3oCoi4F95rUq5IjTk8HuDV+CJPWjKVME\/1r6WgKTDK3CgIRlQ5pJ9gW1Jr44oGendVJXXX7bgvZAw4FXukcEytJdeFw9vW4BU\/mwYYRwhLx4ryq7NDTFTEtLQa9JMEtUl+BaLSgynKr+ChnH3CzrZHidRGv+oP2naYHDAMd4HGjq5+mjsHeuzM2mdAq9CQ7qWFBJRemYIpJ0k+9dCA9IAquQCCLn0tbdRO2L7m\/k0K1NxDttxBKWD8ZnM5tayyf393Thu4sVMaRKyqhnlYtyDikzAr20hCXQImmLmD0eZeQBJGqXzUCGm49byy0sXgDnvZ9V8PUXzWPFUDjca4g2FBrmwx3PZQKnyNxwr+YrrQTcwE6wNZDLb82v5Y0Msnw1vXENZHMyZ5MmiPG\/+cBGLmnr4\/X1YtOyz6ZCcS9I5qhJqohrRtxN+WyEwCeljjxydpF3iJA1wPeqT\/UIAq8OojvB0Uqo52opFDwExq7c87BBeQAGFVqd0FW4MV9ck8Rp3sAm4aQY2D5xanUoDtEI+2XnjG0w6Vh9wRMiBC9vi0Yly6XkwKihOxep5PNAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYs7Vz2paAGqPnXyXBtOMrU96V8rY+5icpFu1YXSvneWrazsOO3N+y3WudVeU9mQFVBlSFG1Uf6p","type":"fijncadeau"},{"name":"Fleurop Bloemenbon","paymentMethodData":"Ab02b4c0!BQABAgBXZOsuynZasy3ejqMVaJHj7rBBmxTdB+1QljXleun\/eQHtLB2w+r\/MOqEboTzAdLrYu\/gCLuWS2O7jI3+4ZevHWmx3KA0pNNZ9q1CNM6tLHwQ0nsGwDM1buTG+g5tRULY13M44YZU9o0QWnwlbm\/DmxAYtyAKIufwD\/TuXHVOhs+lj+UWcamJpnLJ3OqwgXuHwBWkwZ9ARn1\/sBAlVKYY\/Po82mKrmaly7Go9pJR2pS2ENvV6jYTSicPP6NI6tYnuddgk3T\/APxohNK+qcrx7La3riSRl92kK59\/7irgcuEqcEZEWX0zzlrjxPzzwlxS2PxRRzltnKyDLs6hz9PPtT9rZgiYyh\/VnPzIFxQklf+iqc7amV5WjiDOhKz2J\/tpYKMCLcbyIsKU\/TmLFORiurCwU5MtLWaIUG+MqulDKPNlGtwt9jYLWokXNHxTuWsff1M3FKJc3ofqtrbSChr07SoEX9aZDa1m8e91O6MA0qOsR2GbUsDUHdZyXOx7\/V0pesmC2UGjGZByJx6dCMeF0Fvf822YZL1otxGRLB4HLgSkXXSKv1XFN9GsX6dFarF6iO2SPhkcVJLUgdVmWvh6iQHD+5rw4E9dUNsxWgscCrO3+CUoZshg13yrCaNFD4nzHNtz+Zf01s0PawpD8ZwSjq1NrCvCbmiFrFiYEtiB3d4RAnrZSlH5YDLXTgqosLfWT3AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbOO2439Q9BfQ3ByJJMSwrJDvT6Sy1M+0bSVhmsqr6Rs+TmOr5pAZ3F11J+22AO0aSk4sLHTWO+GpqIMQP3oGg==","type":"fleuropbloemenbon"},{"name":"Gall & Gall","paymentMethodData":"Ab02b4c0!BQABAgAg7QkV+4kn1vULBkb4lRhi7bw0dRiZidC4vqbaHqkPPi1obPM6TJu\/twpWYhMLYppfvscQ56oUQThyN07N7\/lbwZGgoV6tgFtd7ZBtrgqJPPoVM8sdLBmRLC6nBU3d3U7Xu4SvtlX2JQmxj6t4g0zcgUqNhaLlMjxQ5cnMmbWz0hZ0ustLX1biM5gk7FGDW5\/e73vNgb\/rAkfQRPBWfbGLEC+n0+QBalDuSeVZs3XNdAp58mhchviEmIppKQMP5c+ZsCLyeqGYM9ROAv6QUbtXUKFihruXQDLkqPJABIReTpujZFxqV0N7mMyJbEeh7ikSXKqjQmqqtVZt+wciVz5kcWR1k27K\/3WV1Vy9HNT3Pr5Dda6u0KKm\/G6lf1oj05yaozEJhJkgdrJ8lrSe10oFfCEroNoj7bSx4xBoA8IKZ1F7jqzbRRCgbFak2OBgbOo155Hc3mQAxtgZ9teycjMfKAjo3xblhQuqObQURMp33pbvlCL+3ToUifz5ehydevrHLDYZK\/AA7sv44AiJAy6W+mgfFifXJM3+XasVBNz\/oto\/stjymaFMVVXEqpaYiWOKsOmoyqNk5mHMM5ZFFrfz8lFwojkkjOlQWCI6d8+PeRlGp9dW8wmKOvFJG+RpPmYj3c1SwdGT0pevQo91hZBB46Ypn5KXyvSg\/t4vatLrvRBaXqwwvCMKwYwTA\/HlsYSUAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifW\/eRKmjw8uoaWKOBol+hsc8L\/WyVZIIi3NlOa2q0DCbXCje31jkFLJqHJ3ls3mBT\/A6ew==","type":"gallgall"},{"name":"Generic GiftCard","paymentMethodData":"Ab02b4c0!BQABAgBHMmxoZXymjsUwaJug\/qfoTG4VC5Fm1vVTvBgFQDsUodpLkylC+O1zyY3Zu\/MhuDQMpm2mSImemAUeBq16uSlEBnJx+oQEdM7sy0DTfXGTaGqpO0MEzP9bBLdHVKvy9IeMXRJKkjTuOStL9BN1z4EOuSJqD9zEENPMBJ254lEMFXCu\/sUQBhYH4Z0qJZRwjtd6AdB1Uc8\/qwGbmntKUHx+Bxjk\/AKKHrmdFlVJ\/2fjavkqJRIc5AuCjwpnDZ\/zUqx4pDHmG\/Y3UItCCFmSZKFFTsPN9\/IFMkYhfKxipzv96eHMJXV7OAdEVhplHHW57gqENbAOcKvgTBzvtxokLtZTIQZNM45yHDBlkXN96T0fU4ZhdI8VmFkTk0kKWtked4o5BxhRhf9YsrG5sby\/XNMCGbXubTlrhdmsg74qSt82GHXyyMK7+1qFI\/WQzMDHcW\/grSllUvBR89MujwbHUrjVgS4Q\/qQNSFet07d53UY3maMspxdpjenYVP\/6OyMcE0SQnR1ZXNHm9OA+TA7NR0IIEFEG4XtdzhuDc8acW2GlEvSxsTWL44IaBY6PRilpdF8U5CJHkPEWC4criLpxeOpkX2ulgdc1WsFSwEJkzZRGdq4WYWkrWaLfVwj9Ihc3ftK2sb9928VKmDMg97gc52T3fh2NSv2uVRZGT4Ay\/wEpnBC8Ev\/q\/COqfzFp9HHO2Wq5AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeuy3dD8N58\/UWJfGCXfFvHmQFj8EV+Ams+QEs4c+dTUH1uLGiS6azxtNi0sZ1numoBF1FsBaTM4VDvsWxI=","type":"genericgiftcard"},{"name":"GiftFor2","paymentMethodData":"Ab02b4c0!BQABAgAVPfvRFY9o0RRAtb+F8c2kYHb+aOlojLUI\/ta\/6uB5W+Y6yFF9vCHY69AhGB32kH6EHHO8bv985AJyaRwgDs4QyzofNDevaz7zDb4ET3Ak+Q3sU2ObO7wTO8TAP+YCTOKgJ3jZaEKt+ExzCC8646uTWRuWQ\/TB7j2p5x4MEt1Gb3k2ehc8608r8oLywYiIQIx1XyuvfRVDHttWcNj+Lza1tRr2QTThFdLRa\/wNfuJPw1\/AYFk7HUzhh4AA89dQzSRYHs+3cglU0VdMvm3NEgvXYpYyNJGhbCfujfUgzX1ZfjHhy1mQP5sySPm5hXxjvF\/6deSM+HaSSZGw1+f5N36sVcrMNYPKMYlh5c6zy2KzdIIhxm+mEIiC5qlCm5Fo+XALpUnVZfuViLPWIvQCIFD\/mQ5b6LLyUQK3IgTvQyHmF2yaLihlgfOHt8gizJDmHOSPMNNPb3mnnmgBeIKvEN3YHl3gY\/P+L0xM6xh0DRo7gQ5PLXPGyF1D00Easx1hm6x3kEF+whefRoM0TI329Lyf9C\/DN7gRBu7tZyl3NNYjPWzU0mJfTdJOsW4tT4lrtvG9drC+6rk3HcPtvlsk5jl5fF1lwPtZ0rxJD3kLaUa3XRh171OaM\/ZiOlwLRoRCjNGUdkDSZg2yhJJiFwbFpGfIAXJpJ1kjxDw\/ScBEVXe6SRDRrvOxx8kRmGFnoWKWjf\/CAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSGXhyjG5k5Fo0wiLcQFquadA\/zmxoSfuiiT\/\/TplQlLn+nMDZbzPA6ly3gwTH1bVLkbgAiQx4QOJ7Y=","type":"giftfor2card"},{"name":"Givex","paymentMethodData":"Ab02b4c0!BQABAgBNifdrYoF8tGus92zPakFFXih5UpuT+eNNHDUxAOZi\/0HgqoH7Rqb1Y7IVQWzFCl54\/gDUokbRjp7KLQftd4eh0w0rKRZt9WF1DL27bGUWZLVtI0NNU9CWllxjV4VBPJmm34Za6BJmMhfQ+zLU+7HN7mVnjIa5ALjWDsJBJL5h8X7oKMA9TzTh1gG1iomGJ3nGGMdZWmNs5S042Fr7Q9mgspFmTV98ZdJAx9nFAQl+yzz9JTqziTobW8TkTOkZFVTBpGJL7JxZjJ7jVBWHoWgmJjWsDSdElxfTexaaFv6AmGO0O7jIEG1\/16vxkEIM+EAWfiK11GRUi7H5R6MA1\/ERdRVv27A2PsG4UliBU4arKzQshHVEjPuE1gqjYlz4lQzBCMlc5Hwxoxlql98l1iXbsx7MHMF0qIL4BeTM5HNGuCXsPF0jSIOU0Izcwsn9qQf\/fBHIYktlXEg8mRUpX4iCFXVJsKtiG2aMniwv+0724iQzTPIrBYctGIBGhIM5nxl3AuCId5ViZoaKj7+Pfw08jZDd9vyFCyiFKRCMF\/eUvjv5dsa7IfVVZGn0GSgggMNpWAnYRwKU\/xfgJ5ZHeNfTFK2jOFCdEnjFK2jmL6bvgFdh5PVR5tDrJOYLRS+4MBKfzxSoUO3BcaWvr6ehHNQuJw0hGW9S9HNObgVAjTVWVRBedGwXUWo6lHDTgcH\/8UbNAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVqIw13EMSch6N9oRAeH6yyfpolZ274j09YkRrdFoi3640E3krm8TOXR6q5PekQ6voGdKQ==","type":"givex"},{"name":"Goldsmiths Card","paymentMethodData":"Ab02b4c0!BQABAgAZbPAxtXPgyy+KpWaluDGh77hrNCi3vdeV4nqg\/XkG2dXutXteYcj5uKLfD\/\/dGP+ZUSolKJ+PrLdpzvAbkO\/JRQIPTBQY6Jswhu6C6vkI+mu6dsD5EABoVO9TiGBrnu\/oJGPUiJF\/uX3hUJU4+o6MiZBoNif12tOa2ZSeTYkxmprOvAwd+JMUJSssSg\/fRJeXJT4iMlobq3w20Myk3feJO0ynR42XAeiyTB6iSPOqqOVTD2XFOh4wMMJWNtJ1Mof2AkqzFtFrPvOYLJLdr7bIKsOKXFhPx4Twb2yDb6eBL2BeRdP9PsYujI3\/B1bUzmDgZhyVflxamQztiWGEYskPBjfbZSK3m1Z0tsHg14trN8JqAR08hw2cblX4eSo9eSPyc2W2lgINHDhY0QOmxHWDoHq\/qjhtbpmEI1owHQBwKMQEm8dj\/lg7v+38TNuLo2cONFP55H8vdG6M1gmruwc5KSfZWxC1wwfO2loy5cPwYDYkvkg9m53oBeIbzotPANzgxJmbciviBtQ+IdAe6W6+DUTd\/erwMT9QVeOP9+cJlngOLvj7Dcnjk7l9x2GQVUwDDUWacql1VK4hEp\/h5h6mpK+N1mDXNl4z4sbWeM7R8OTRvo8WeEcxKgkz3Re79uNmS73Y1\/f5nw6B1o6\/B0sEtMFEXw6jd1F6JNKsR8IhUxDY6liK9\/f931i7fHZqKSQTAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbQFTtA0xTDJ2j7HAvF0qrE3gj1c0plKkK6A\/cQ6jkgBoMXgL\/LjHifQrcbVjFFqXz7tzyLgSuYyY\/xk1w==","type":"goldsmithscard"},{"name":"Hunkemoller Member Card","paymentMethodData":"Ab02b4c0!BQABAgBSDDWiLp4lYErsDSD+XimeV8jVzJB6z25AY37kR\/rtkZg8MHvPfEf9+ryljyYHTPrg5bTUEj6j3Yxc5jd3db8to24UiCdrwBz\/JWRUaCPUIJvFrWOPejthgNdCfttgaqfOdVknMYyU35lKi0a+pHuBvkcpZYxGn7Enm9Y\/n+GHMqjLdsnjM7bkpzTF8NEw0JKxUHwLNKCJrvVpe1wP5s8\/JDpt6E42ne3WgHSKcLgmxsbAExj+CC56Q0NJUgdFULHvbF6a9CGmFvHSvik+DOm\/KhMsWAdWES9qkzEw5Z83R\/pFHEMzX2tW5FoZkNIS32jIc7HSaKwHMF67PmdtzgjjemwtLLNctpTBL9MiSfti4B+XcOEBzA5LKxTyzHBcFZLXCioeakxRvra5b3i6PrkexvHrNOtyRwd+71F0Wp\/E+gzpb1KRJ5pRxC5uHkIiBOkurdcKjPKtXoLgpL48NZYWb74FvMj3W50e0C\/cJAdYRZp7yNf0mCvOhLva2ORkJvmaCr6Jfoik4J\/YA4QrM5WPCil72Ubxw1NBcIdoDAkCDJb1IrjvDryvxK2gk7ebVVd9xwnU2y+u56aYZcJgLKJ4XEalGZ+Cpnbw86q7jI3YQr5KaVfFB9yyhU3ZwshPNI3XQhirD\/ESkn+j87lnZWp7hCmsnc2r33ey2PkQ96jo5xBU+luThZvIVTbVJdH897rVAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXoEjevtwzQTa9rY3bi+w7qKrNij6SQfOT43DEUWmCoS1f+F9aLLZMbCWTN7mLXOkQTMdVI=","type":"hmclub"},{"name":"Phone Payment","paymentMethodData":"Ab02b4c0!BQABAgBiy6A6o1vNm5FJZBNdGlULclQpPMw0UVyk5sTZA8wlFQvdHt+YvXKWzkNf7sv9lgoUqGXIvNxk0K3y\/7lI+EGPuQHu\/RVlz1D26kmLxRp+NnjJy\/m4vxMSy\/38NgBJJcrMoXtUghrcKFf3mQ4MQNyZEJ\/IXBh3y\/E7aEDkfgmsSy7UTfNzhjlLzfBVDtLhXW\/QlJzFrV0iViSrVblHKZEowqICP0QwRJS\/XU2gX1xY038LkXj6s4NpBWJka7mQ5WNsinpRWAGeR+Gl8FCReixI09jziI7eJ7tDln4P4JfJGlLC4C\/pG6xagpVO1hyMcu9+wT99sz0k3QmEzWouAkiQnjMNRubfnyXJC\/wa9AMHrLfH6YkScbmutKASRScHrgd8jCBCEIDQ5jAMbB6ZhaTWGqWdwlIuIbmW0HBt7l\/pEQdVAW3x7PBUQwtZMGXMvdFKR4YAE+Lhsc40G7FUSlzLxLs2bpfMc99JUu14qHncEAdeS8XViEvYyR45ZiUWR9z9Fxwctiqt8KIp5faZNP2QaX97W7ySL\/iJuIZcg1IxjKzRc9ydtoK\/NZyBWJu18ti3ObXPPOsQMGzsndigh2PbCEtvy26PXPsXHlY1O1DHT7w2rBfg3Akf9tG57370a56vO4Lus5LkZvZPmOPINxlpNNxtX6O18XwhYjcPvA9IWRA+BXqR3KbrDCFBfURckh9cAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVwWSTKtbn80e21yXRcWWxceN6SKo4qJNUpQTf4WGz3Caaxo5WU2yKF5C7Y7yImP3pw=","type":"ivr"},{"name":"Landline phone","paymentMethodData":"Ab02b4c0!BQABAgAVIhc82ur8irH+\/b2ZtfjOmtNeh68KXn3JN3HpG68Ag+HcU5+J9Kn1\/Vv4YR1K1RgSBCBSiB+o7JHhD26pdHIvhywtz6tqltLZAoEmETfSvoWgcPIzXY1JtohNQ0tFbWIDq6jyMh+xCqheiSlQL6CEdpGgcSFRb4D\/J0mjMZ2nEgcuYkyt0UpEMyiJXYcRac\/9GHql8xfEPAVBKD\/XjGUtz6Ya1tnd71\/6mnBbY9Dlw9nK+Q7Lrj8gz6VrQi\/5sDV5bqNENK9A7jovi6uameBvBzlVfwyt33q+qxnNr6wcE1J9VLWhdB\/YKfexye3C0z\/w0wP1J9a8SFdHjd5T2m4rLkqav+Kxrd9UsCEatXZtfOrq6HULAw\/fVkzJ9U9cvlU5pronnEb5hrWhGePaXU84Ytl3OZguqcSff8Ua\/wI+9bhKRO9eW\/Aeqf1JWSjs52jO04Paw63GTTM\/mXQcENbJfqqk3xEATTUNMVDlSgZEPrytAU4ao+LZJ77tZEnHdjlcRfIcWjaHEtr40b3BhEAc8vCSMbOeBzES81VSH4Fq1W+LR3J7k\/xkcsfeHluXGVKypmyoOLNCzagejubPCQVKVp3jZjiPUh29U\/+q2\/aOy0hoivRNgo6sojwU1xke9JyJE5oxDH+WTbmCsbK+OrJJqcCdCuWbsiY73v45Cx98cBB3wEK5i1rH3AxPiliiqy\/YAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffRSu64ZrMMuTmwk6B7cgd93x7q+0WNHKAGNvJnpC6YdyCShju+eNCwNm069YiPS5OvtvM1OxwA=","type":"ivrLandline"},{"name":"Mobile phone","paymentMethodData":"Ab02b4c0!BQABAgCuF64yixDh9VfjK1wPr86Fke6QAVX+FXvop9\/9rekLpDOVhkNEsNGFu9XlPfbVHEOl24l+0IJPlCbm8KauZMjjDZoprnoYk9AfpMQxeXIww4sIOqtFrX69SSBqrOorw\/22c9eB+Ak4jY0QV65EBPEElG3midzeekcMJVlQWk3i9moaZEPoW5APbbXVmR7+JDPPCtxJ1erbdg3ES0kvkJMlcYuSg+ZQee19\/xS+m3o9yCXmDa2V5nUpTIxD\/5Lf8\/Zf9Jn65VgupVm3cEj24ycqWj+mc7cxWFzdp67DJNLAcAMn5NJIxVExPb5MQ0dz6eToHTMUU27eQ7NyIn2jYmrUKZe5oosEuHAyJDAFARWO98j8CCi5BN3Yy26u7AG+cP4JEjRZkP7lNaTM24GpqI6T11A5ec11hfeSx6\/0c5hdhZQNQoZ1OD9g\/+vLRGb8mMi0Ih8K8Ulm072exvb\/1BRrkWWJCPA02IBFW2yzWqa8YCcuFMnDjD2eOHQoG5YZKITbsz\/uN\/9aj7e1ReF\/WKvz8uJHfg5Jd3G2iS4TBNgOgfeOk0rNXb0pO6iLoyaiKsGg+LNz0v+gWu1Z0B6kinjUEWGG6P0649HRCb5a9P9HgteQSMLA1r2I5guRi69O1Pb2EEEzYsGKfF7NzidyapkuIG6zLXAfoQkLazz+9dCtSxAMGYyaEApK6bnOMh4I0fpbAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTRJwnLsgKJqeB97bJOSJbQ9wWOvM5qTns+NZZs2uaRMsnAecuwmWyLuKPbA8IlCHFhqKj9z3+o=","type":"ivrMobile"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"JCB","paymentMethodData":"Ab02b4c0!BQABAgAEMTePvF4CZtCd9jbirjR0AqpOPWFCV25nc9lQzBq6NgJ\/BL8rbsbeYPEEWf7OWrSMdmiFjeJKZN9k6sxPWcb8D6AHgmVDklrKEd6R5qntMY+L4hNs0TP+Qcx1CzZY0zUFgrP4Gp5seRBKKpoxGUkAsBMgIeZRMQMaz4EUzttrZB\/2p1\/AjVVyULyw+mYl2AiRFCzFJ2HwUFAds3W37UNlOHq8QBcy4mGQLoTm6sjlIHpeudZtlkoRLnUhY98plBecpZYZbHiT9JClM0LOXwyoWPr+\/j58RROGfzcsITOPDbevuouswq90IJcxnsEdnbq7KQCminWgaSB5rZv4fGRWSa6zF5X+bBiQixLQD1zqq\/4apvoEoRcicEA5v6WVH3bpXQBhuD73HFVZ0b2grpq8Rq0eGV9EU4QWDB3mnkVaR1BzqE6BC0fR\/9SxAGeluSJn7HVXjuVZ2b\/XamQ0x\/4YHNPW1XtE5PIVOdtXH\/LKvDS1ceg5PtdEZ\/83Xqjx3Y47XZktdKTrzE+myWJnTD1Gzv1\/YN1k\/qOEiGkyqBAy3ympPI5U+Bu0S5xeilum0kjAWQR5bsGF9WsObAVJ4xPhkYt1V7p21td3gVTxww5QFDFkMSK\/6MY+qmk01gRSRIBflK0bntv01YTeG3iDL+MOALbnrY2StMQ3\/qPjJjKXIBBh9Ksfw+AtNheXk6K0CsdtAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifR6qJrtR6YnxrhZIBJsXHJDfTdPVNTDjG\/KdBq93\/LU+m2blUK3nlsH62gxSIeD+228=","type":"jcb"},{"name":"Kado Wereld","paymentMethodData":"Ab02b4c0!BQABAgCVaykYdBYOd9SXZhmtt153kzRwEhOK3aCqzeW7sdic8Byp5+th0EDWafwfIIG7LQLf33UFIsV5InlmAdVAvMkXRt2BAThNLqSwCR1+CZZMOz5okS2dFDKG9rdh1+KDB6frYgRViisaJ6W+bv77l54NnF+A8B1lPjKydCEnv2eN8\/3mi321AjMDqim8IHrdTYl2pE\/\/R6OEt1b1jALkhn+73jt6gXboMPwuQTpkNMRxNRP\/YapLkKX04A3Fzqnbep3BQhXBMf2YEXOjQw4ryVmDIojOpPjhk9eu8Umxs4sW96dbo0eRNXbNd1+ScDM4FZQPm8nQ\/BJ+dabn0uZwqsz64cJRx1+O4c3qwTsa8ztSckaCL4b7qKYK3rtYfzPfyOV\/wx4fyNHtbRW609eYOXV7ni66Rla+hSOpHFBQzhLu0SbK\/7pdBMA42cCvifn0CL\/gUjkqhi\/1XWSnU\/CiXV1P2BaOTLAW2rutEWMovg0bo58u4\/2MMPXKpcgGEYc1ooXWycZVxTvTBPKcM8BLJItjX3xABbEEdbCqJefPMSpPrvT7kFbvoxuIQhrMEYbhaCQ7i9\/LCXmqFZF1qKrUxBUMdB3sSAGvPyGnLNc6zCl9lpfirhZ73XdRyxsTzFL0R8txBXqxI4IiPFWMRt0+xV2gAFqBECY9FeoG9nMFFgSlAhBIGGTVTtPIaltT7xYDVKzSAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQif1\/rAtDWA05NbEtqsQDOvnXV15H4jQAlNomWkD4I0cdKWDRiXzV2yYt67F\/2zz9IhbLZJ6yz1","type":"kadowereld"},{"name":"Karen Millen GiftCard","paymentMethodData":"Ab02b4c0!BQABAgApYI2hbHeDfES0QE9l7pnLSIA\/MIKgTloS1thlyAFgxG\/AV+rYnCQoHSn\/w3vWtjgM0rydLWjQdIqWsYKKeRBCXjqLWDPrYB7gaGT+\/RiO5w8mI9t3Ol0LnI+TwL3NqXRhFDarMkr1wBkqrynHfvcpbEbkLVdKSYWe88ZoroIiEAg3+q2tpn+fLwXuCvtUXqqqzYk+Bo\/SYJ0mbxISRzFIsE3ZAaUnLWtWaJf7rziyJa6jzcsVDgqpItpMfenIarVFcLQv7Sif1E4Q2o1WoPRmhvlNO7Z2DluzSaD+1Rycg9b3Xi\/pjkKO4YooCrDKDVthYXbe2j6RVsZCyZFJe9v5Egp3MUpnT\/XwiB+cbaSyPoC0YacoT\/cnhJ2aHTtV6HVKUZPD8Eh4jBdi8qAPgbBzr3E5LEtHuSYO8rWbZQMYS9EnJB0gm\/DtoPM4nHUA1pb0ffSBZmSQgCeNrr89ZfLvJZP7itZI+tjfaFoAY0LfzzCSge3M0LrZMADvqG8Bg+h2p6bnMx5a\/ssLUL7vnlyfGpl2OlhWDbJTkpqA5yt35usFniOMxkWnhkchq0BENL3wXl\/dAioDkSTdVPxgfZaOy9FSVJZNR2gCFmYhth6Yk55FBScUdIis2tykndN1ahSvH3tF1j\/H6cLFdq2B2DLoHoq3i3LeWBtvl61I98EK+RAJMIEwtPVsWjrNHuCdWhmBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMife0jMycTD84D5BBKAd0mGMSGHRKH+iwhg\/G8g21qaX1vqxzE1WJnq8OKTrrgrGEf\/fBxFsiqIQqp58gGC3vKtJfq","type":"karenmillengiftcard"},{"name":"Leisure Card","paymentMethodData":"Ab02b4c0!BQABAgBYdHBN0+5U1mCMTmWRzq5wTWWrDhl8i6q6yiiyPcG1froAbrlmhntvHiAeeGPwwnIdjfOrthR3HcO87Zs05HNaTwm9mhxk+3t\/MVat+r142qs4o5OKdIR4uYRIBRrjDG+UhUW1dAnNvrCCZ+kZFuh\/v7Tzfxy53ReTO4CAOFmsnUAqnynazVvyX9lMIYoTsd0KXjB5nLGI1DV4\/y9M2M4iyHmCIB59BvF5x6bnz2ILtfwRZtQe9HoV4WCO3I9titDktmdOHnCsQkKl11JZSQAIWEibGmWhuQmiuTHI+VuTW9qKay\/Ya5j5Sfkh\/eCOA90WmOaqynJWCdOCiYsd9IiURwsQ6SqH7kUoBJ7tl1UM8LpJyZcLDTX5HO\/nSwA5KBRw93cHeryBtmHavfH5VXP60FFMCQr95WCKNFfJv9FCVydbgaQ3UiMg6D1yBJtJqwOub6aWyvb133KgIpJnhO522X\/KxkHzVkARyeauOvRarsUlidn0h6IYAmwX6JVeJD3FlnDYBOGoY+Ik2DzvBq35ylfjKrNMEntkFoYOQZjaB+4BIUp86pJSq\/bxukfA7+ML7VYrXs0G16iWBn308k0Jle+qyUhqXC3qevJMp87eG3mrgaBr\/Li3IfaBt3o7ItNdG9d1l914lajAmVjxeLqW8Cv\/tIsCnal6zwBksIE7HhCuIM2CuiMCRzlhHA3BBpZrAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifW+wiTHgcFa3INU7aod3xbsafozYBWij96xh6jiG2bD2YdA984ypmZ41uA0Fir6Wl1R6nGGZlyVdrw==","type":"leisurecard"},{"name":"Loods5 Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgAPp\/\/FjuP+ULAnqOLFwnVQX3pGuTlYiMmSXXg6EejxddbhxBf3\/CPBEzIRktYwuVzYbMeNrxbAMRDArExdZJMcFWbBHOp9pLGcT4mRWm2pmf+aRdKNygeS3mI85xlT\/l58PpHhW4oXOzp0kh8UE3dPbbQzbMucaC9FJa898di9kK7CHBOinGqGscnbJuzBrD+O3Xf2MshZ9JtJhFFNbIyLgbwcv\/YExyMkAvXddLsVS76TlrPjqQsCOCEyCU9+wwjP5GRaIHqMbwx+5vD1Zy8Yh3GB+fqmE2JBbrO4vStDSUcRJmonZ6eGmS4DP76lQ46AVr1PY4KwZO\/ME4Ku0XH4vK49EJKQISqklllxa+2YkGAh5DsLvD0tAswfQ5LvvvmXIEacKjfYsKNKa7w+Z41Bn7PZTwLYp+FBnynlGO6AmRYgmJSEag4rCueZD0qJNrgcJqMp33l0eKNb72wDQLZ5EsXZ7YihTq9gL\/tsVo8sgOrZV1AKWhnIYzpIwSNeJJ3clkqOu24Tilj\/v1kqiDI5+yn3oaAZO3crm+GTMWY7jxKmH3lY130\/jdCMHbPTugonAlJalpI6s0vfA6LbFcYX2BgO867Cmox9SSBN9EBG7a7FNB07Pf2keQcdeaWg1DwldGPSMCtMC2oDaMd2s3exyrnEOg3rdbh6Q39rfhOJOxB0Rv25Orn7jDkaBqvqMf3RAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTmdrSny1kEEHmJD4iRcu\/0ZPmgSqVodRq5eFhZLL38XWtH7T03GQC1BdgABBaUgDAjZ+adh2El+70f6cA==","type":"loods5giftcard"},{"name":"Loods5 Tegoedbon","paymentMethodData":"Ab02b4c0!BQABAgCXTxvpM5NovdKZ1\/8MSJMXmIDzrG1S35D2xRgJhlfH+rHlcAPdEoeS5E7CcUDK\/pA+NsqVXSKV7YpPlzDI2Hot1wK8+vhHh9g3hCD\/cCtThplaywBeAKWQ1YYeXqCiSbLeNAtTDWs1RvPAwsWpDbSFQ1VnXS+kR9vE\/T1gG8pthSrpV72aUg\/Mm2mJGNe3BJxzou+2eU0PEiKW45EmQNs+1QbZLKwvE0ByvATBb6+JvaXJqdZYvk0j6i10EoavvcgMQEdTiyI2eFwX7o+F0B0GFRo46ACCQ\/BDwekg3+tPfDsc6WLwNn3BrXCR6bHAWUcPQ0EmlCRDdg2zbT0fyHAGV+2q8r6Fzto\/\/NEi3xRJqC4uYvKg4j0COUfZSJseBuvwKaSoEZmVyni25Y4l9QSOeGC90hJZ+FLbbo2M5VqftJII8VUBc0o5bRKXCAFBjn6iDHa\/FzS8PLkehLkAkWlU1QRUV6qDfOfzMhAT6B\/fGoXVq3EC+wdwsEhZP9\/j9DmFTuLBZ+z8L2yyZcDmhKD5137ifvtH7StDaSfpOdZWBGSOTpuA+E8j8AqfuVjyuoaNCEopRAV1Les4mIKv0juyIhxsI+cgUU4sDfKqvDkzD\/smGGhloC80enbncgLV2zCgm2ysuLTORBlVhhZBKnR8aEA\/faDii0UIJE9b5bOJnRC4VefeFNVrTkgBpYzhmpNyAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSuDGOUZ1xiT9pv3ZxvzDjXdbJ0JQnc5EWVrs9HK6TTPDiBmRDhwvzvrVYOzTJjaebHY\/rg6+nzHLXMgRRnq3A==","type":"loods5prepaidcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"masterpass","paymentMethodData":"Ab02b4c0!BQABAgBvbRPkCdday6ekCo+Z3GBDCWwcGOq5ZiTrLZoXTWGZBUHw5QuXfypU2GIcEEqLfSJ2B3jtCDUT46b\/LqyOskbXrcfe\/SlzkMpgtjYyI5p5o\/fXAV2EYSagdIVYN\/tjWvTLvabQqxTmHObqbeSh\/oIkoe7XDN5gcTZeqpOuPe348uJNEhns3+CuTgfuh5n03tkopdKlPKSeFvaN71WhOLmWnrf6cT9UTQz2KsI1oR+JVzSOcW5YACk31D5BIkaUwJaiB1wzinjIbJA5hpg8jofvqP3pY1V202mpWSki5vGWXhgq8DkqYzg4FV0E1i1jf8PMBH\/jkEOAkwSV2CCfhQLGppXGjSX+aGQfhnzxuP2JlmCRVMarGt7xHOyUUglKS25S1xkKYuhmnwSJkfd2UuGIqbkESIVDV+8SXiz400lAtg\/MdWMmvxszUZwPsRkP0eeCbvLUge47dYKVXb1ebWixC1BzXeZkGxOOej\/b+f45JQYmHVOvoLkzEDUv+HHbT5Olez4AWCYUk5OuXM7ao\/jmOa3DGmzVm6av9LahfeiiPO9fYcX8kwoFHZbKcKRVhsTwyZ5\/Zy25VoCLnmYcDt4hkRQe9+nDd5BePv53YyIgkkyDGeblw5NKRtTjisLo6PxbX68rGnoTEA8a4La7s2Q01QghihIiUQY6QzkLnn8fVxD7U9La\/f+dChIwRItGZbpSAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXzgfp9PSVL\/Gx8GNCR2wS2qzDA67ZCQ3hokL7QtZwiELsB5krnOCZ4XyCrVUK5QwO14XEq\/o4bM","type":"masterpass"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Amazon Pay (Mastercard)","paymentMethodData":"Ab02b4c0!BQABAgCkDBQ3tGm61ichxvJBt0uLArsrW0pZ6\/ZUCT4v3yeMx1GUHVywYKo5\/SBT9fA14QIYOyBSEvDzHG+EVDKbsq8ZGGO82ArjEbcpjYbvn8f3t10es+3Bn+TzlxvJiybucfxm2Ix2d5yi\/MTYYcdGKSFZlSxGFTF9VNDzMTkP80rzRYApBdtrFuRTAPW4h7z+tWx996HBYUbiv0g015MHCHS0SoYh2jPOHhCm17R2xBnf8s1jcpIDnjZAiMj3VoZemVSzcYMtumbuU+R5v1oUaH3deAEj14pu91iCgpOmyTQrYiJgg8p9u7uUCDXRYAYgoLVkBIut4PeFma7I9Z7gWXqrSt6ffHTdvO2kMmO0Ogc7IlrBrF62koBdnfuJ20jDEjodF\/LaKwQ\/yyh3qxo06USQVNvYXl+J+E\/iUbNgw5FR2A94I\/2MAfxiMDS0ztdBbAf1QzaS44oJJ3uIS6zlCGGcenxfRdXMjOXEKloO+F2C8XMvctctJVDgY399VCogiZTLNkz9STRrjg4r5cwZIw4KvXMce7A8KWSK55BldyGq0x4de0n\/lj4ko8o7ToXj+\/PryBvtUjcz67+i52fLxvr4i8iqls9wSBkRLVfKD+VfKjJxnVznDdsfr5aDBa4hGwANGbIuqI4gv74KXCdIWbbJqTfdD9VA9q49dg+Iy9D\/VhDFlUAxdRLmb63kqQ26dgAFAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQr8SVcjGZnuArjQaqBsW1KR6igs7NQaTIKzWHB8oBhPefQXAmoe7TzdgzdRb4+yoAYJPcPYlnLcT08=","type":"mc_amazonpay"},{"name":"MOLPoints","paymentMethodData":"Ab02b4c0!BQABAgBIfzDmB8qDGajvq2\/hGWIzlhAAftTCqpB3RZLeP\/TGvZeKFPe+CMIFnX1zNtOhy4NP4CEDmM8jHy8xXedS1QelN1pGXP1nTko5vMr7qi9EFkQcvSvZpwO5\/Cz0njVYjFgZAAvJwK4Ytdg4osnk+3X0qrn64ZbsA8ibRGyqEEBAClvIY4AMG2cGXyqru3ltxwVqIc934NpZ1NeZdgE8zFEuNRLdMtGmAfigLDkRpRf3sOlPtpY9u0ge93ibzP2jRjUGy5YLUd1CFJNx7fhtff62r8mNp1Lb9SBCu12cnUNVkMsNH3mbAtK+q2Ck7Jvd9QKiIRHbJYRnPv\/LN\/nYAs+Z0sHBC1c78hT7qDayuGZ+haasm5eem3V80JuMpw08V2IWdGunn7pkGKJ4ldXUw0tUCKD7DSUuLa8Nx68eiQxyzWWRq3PUYGUns60C1ZXkOKwOQOhCfx9jsxjNKqRN7q+9zxHyB\/aCM\/fZkIBsiNpBqk9aTCMQ3TkSCxI3TsFoefDOKZXDqFWxCPq6HVVGt259XwVMIFZzT6AKCdC7OcWeoPw02aACQsj9dnkKqh6HDGhAAre9pr\/mPC\/p7IcpB3BDnDQRtCssFkXUFhMNVxmxxyb+JH8FShy5YnaCU7P+f\/J6Qn2Z8CNJyr2RZ77s9N+nthMhKxMC2D\/3CjwVI66TixAYIAkZUUhlX6XEN8KJq4ayAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbFQr5zEUMohN+rPBl0SdluHCYZWtcZCKV7\/8yzvzDoQYYo28JyLUvJ85vPAXh6Ii46M62I5TA2G8Kje","type":"molpay_points"},{"name":"Moneybookers","paymentMethodData":"Ab02b4c0!BQABAgCTBiPTMkm+\/q0GuKneUn7WEoPf1DtL4xj6+SXQxAufri9s8gesf7z0fDcZSqiApb0UaHPJvZKWIEMonp\/d5F5h4jHOzCNqMK0kiTZ1l7vw0s\/aCawT0y0P7Ymh5Pgg2l\/wbiAdtV9neFh4nT2M3Xb2c+Do\/yzIOU0LEVauTvCyCrIZfHvcfi+hZtwwZPxYWAlzJKyVpmD5RYlf3D9OHuk4nNjfGXY2uyaf7w\/0EIJIhukqPnEey2sizgxbz7qWgbMPAwbWmLynwczbqfGiI3FZpS2zyajTOXk46DcGJSifc9H2arcxg+O11JhObCp2v2Stwh8DDX\/uoZOhdLf42sjZyioygBgfKpOnELyaxuevhaeNM9c\/jEnYDdSL9P96DifoCGLGpn5fAGADskxHszLyoFMOP\/kRbbIeSnHjDpwE4Y6rFLXOpKOFJdjx9A1p8SyHSjxhV\/G1ylk6Pnan44fRjORpEH+sF2XfDINRCwZ7EU3lH85n+P5g6c66vRbZMuGssb9KtY5yX3Jc\/IAQmY\/kS7WLmbemqvCCy1vMTwyk7J2Nhg+DFhLvzEgBwrDnCQxV9EzreJXOEtBnQ1T9w9nQmrp+NjiPVcHnfIPSRE0enAGy97fff+nxxqvH+yzm61XuTVG\/BRBjKwqbS4m3nORDr5klpPK3NhuUtTqpuCpHcxABoFJFarRJiVuHipKn6DdgAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaQpyBEyvmrF90NAwtfp5vweigE4s433Fuo+TBuMzX7RoiC5Iby4MKfDBrdEF1TRbztiy1ZO5Ec64oM=","type":"moneybookers"},{"name":"De Nationale Musicalcard","paymentMethodData":"Ab02b4c0!BQABAgBMClK9eoxk3I3\/2Uc2XS3cNA3UU9qdSYKQWnqw9cODwxat\/NB2rqgl8VffbUy3m0ptFDomc7bU8jMHoKRmvGuQ\/eWI90bRT98Djqtv+uSIdgywfdxmO7vLq1imx7eeGYJqGCgAbJSHjxmy1yZtE8tBK0dbtNByCbh1cj0NFHhTma9S+2OQZ\/MXDZizQ\/nNywOCKbdwPgsNnWiUr8wB+qFfjUokSN9xQB7eUUCR4b2XUcXhLF4\/r2SKgZuf+lgnuXN8LoQH29d4S4TrM0Ta9UKRPoXdrE\/Jvn8an6HZfdhg7U1bWMsrVUV4aGGyyAprpncPN95g5jTZXconVKiQYqzwcwJhcMrL4XyEmvkkxH5pM8CxRnHGXrBWbXomKODH1H7fGWMhFi0D\/LYIDPcM2Wfa3eZuJvZbH7i\/tuLPI9BzjdfMFzQE6sZbjUmW3l\/wu822w0TT+BgcPTf293vPV7WX4ijf8JcZ0ocMtP66I9yvvJImjy2Y8MdjCcXiCK4HN04CZe+VEKWgfKCAiv9pz7Xj4LfP8ohxZg6W8V17GgHaG+Hc6pV+2GppVjf9GuEqpVGRpxCE6wPHwUJHTdPK9BT4Z2ddmQvmjHBUjfObam+6X42XbC\/KGdSr\/qSkPOuwbp5Rcv6VOZi0+DQ4VJFzPfsMyePQPbU7EEcXQfVBLC4kChAj01Xd33Y+Ap+GLlHTmQBIAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTZcAEoJQj9aNMkMYRkEpNwSVuZa27xiaZPz\/680X5J2Oj\/Y0egTvIkZhrq+XW7Dw7JOmpkk1DAwVw==","type":"musicalcard"},{"name":"Nationale Bioscoopbon","paymentMethodData":"Ab02b4c0!BQABAgAGKrzkoMjtFTu4fnBoLjSBEaMe2XxSmcMZYBoyXHuBL79m+JTEbU\/n5LOmpjeHaVqUxziB5Tej3GR55t9aWR5HXY9vCb\/mxJ4qlm7xdVjb6Yu56ByP9+IjpIW2sTViIOsJpH+44HzxJAvWYHeot4XQaUf1YF7Q9tgHaRVPKqS0nXWJp7i4Nx1ExVb2Lof6WrkGSCdP5+M7tPKxO\/DBpXa1ldCYcb1ubWTyuhHePgvvTga6\/rLdKXyvezuKftLOC9JW+a35AM5O7M3k9+Qes\/cisZWWnvkrNyaPShCBrGwIWu9O2U6qd+2bbaDBEh9qe+GJdUkK5jxY7EOs7F3MeUbWoZiiNkKvp5BQqyh3VoLVGAiZJQqDaPlOQtX2iCI3cqYbwgQhUI\/Y+LH8QLPaE1Sq2gyAeZo1CCKa5Anmgj5rhpFt81SPSR3h+P6NeVNs9UypRDfn0oMRRfONoFNPsl92bLeqi0GjVqmI1Rqw8M7HsH1NLt1MjqkV1ea\/oR1Sv1mLTX7aRnaObFjTgDlAe2EW7\/nSigcxwVGS3ZtqNcksCWojYzDlpu58Q9tnTXRpDy69LjE6KgsC6R8tVumcqzdIWXm9JwWCYIrNZsjb8VXaNH1keUoh2nJjhudo9HpC35gPNqa3J5yRt91qq\/XM19UgunGFBMF1doFJn+NY4SCHExANCp7Bqi4lrg+7BndrxnriAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaOHVpDdzaZluQ0EsExLisZZe9P8jj6B28SWNM5DRuFVIYeo45SKNYL491pxNOffZYGHFCeHwS83mYSO+aNSMjgRow==","type":"nationalebioscoopbon"},{"name":"Nationale Tuinbon","paymentMethodData":"Ab02b4c0!BQABAgBSdBjHAWFeVqdlSeSqA0QDmRkRKU9VRbtV30FXKabZ2HfdlbzZLePz36F1dcX9zXR4BZoWazM3wD++T\/lXOJRiudsx+YBJzj1WSQkOey5wV71V4Kq5WPo1lHChvm1HoYlEJ\/8Jnw70w4n\/Wiq7B2IEy37XIoltDFQfzepQ0Vc8C8gOaH7DhM8koFeASy7CYJM2zRMKDfYhsr+5CWHdia3hfmCv67g8\/8JM2xXU8sRZ5tNFqPCTCW+DMSGYirVEqe94C5TJosaUPQdZ34m3HgQW0dDde83vWPeHBD9qq60NFK5+ljsYboh+I\/Ko7\/qYkJkLjJW6XRjxFSsUytrWHtvUE+g47KLyQpg+wI0Kl7yuaCdlzXqrIDOqRUlzm3\/GvsOlQFnZ45FbvdSdF2tlWq2hsheDNgx1UbcsGlgR2xwDqgfUi1DYXwjHvLgg2oyfyCTjvWXZRpSX0TMYfroD4eBXoUSBHNsw4dcJ24LMlR\/4uDc7XNDATMHWcDd7TGm1eND3hl9QjeQpqcdVpsY2ag7EHrufk4AdEqcgCQwz5jPXsWXwgZX6SIZfyGtE7bKNxDl97kJ9FQhSv2QnhAiPLAleg3Qrd061MC+CAjqOHxCGWCs2v0\/SR3qlRMkk4WFn1FHfz045fSfRRz14x3cDcMkz2arEv1aK\/OHmpNs5Ki8+6RCuHNwaTlfgUy+vZGMZA\/xnAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWnZH3JT\/GnQpJQAGmVDZNXUbNQ03jywRl\/Y8cUDt2sV1z46Y2z+hLkgfwjd1mEQy4RAXTPdEgtHP5txHGxx","type":"nationaletuinbon"},{"name":"Nationale Verwen Cadeaubon","paymentMethodData":"Ab02b4c0!BQABAgAOvsGqCDu3E7De6XOZvDu3GAadKeXW9pAYVtP+w1bqxGPUsNpOvkR9VtnoswfuV9vmp1BPUhOjLx\/ntsAIA9RXqrzROCo8n9p7Pv\/zhcF1sVSecN4O1ae2HUoFsHUxn1MHWdOwJygEWEvNZNroVe6z7S6e8oK+CAaJZLO8L77\/wMMYtnXG0l2hIehWEqcw+dNR0hQO6QrLz2cnekzu13A6DR3pkwRrZ1oyyfGqTxqb8JpSS6xuiXgryPtFOwKccmnWH4nHNu8qc+emuRipL++dlIp0bS22YhVyseUuwBBR+heYgXL6hnmNjKqCD2Qos2XJ40oO3eNT96hxy+kTPHkERa+LlPnBxb1FFh4iEir66COeE9\/YGmnCaJ+GyKGw9BWIF0lg+qsNxYjDDHQ5JXnddzVc1f4mtjaO6cyR1zSNQshu+IXraPkczhvGI4K2BUJpEOp+9zCCWv00U7f7Hj6k\/7UBWM5GQUVkBiMXXJUmxzqxTyXhDL0AikNJy4zg+QvgIjQHtL8TFdGd\/vH2lyKtkDrQNnHfLgyGM1kftBlGwn71BpkBgHM\/S0q0laFnHGlwMmOydhWmy2dBg34VREea+8wcz6jTKeCepRp4QZRAyibXdoxah8OpL5AfNqxzXfTR1Q5wQCTceimL9Gj\/mNQLOaQLxnkDkDD8zsgWn5GI7BDiepPIoM7gdgCyVya5dTzMAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTzqh8Ewli4hyfJllzYIZ2tLPPGyRVA6wXaTcI8+3t4S3VpFjS1i+gGatuMTftnuF0xFr99rBCNaoVT\/AWKSjMETKiqDdp0=","type":"nationaleverwencadeaubon"},{"name":"Onebip","paymentMethodData":"Ab02b4c0!BQABAgBKxnRmdq4ct6jF4AMU8YvlVD6PTAZ8LGgOaj7Kvp7Ty1jZpBKgQE+nWkFVMxLWSDVZV9YbxhXa1Ux676iU3KdAvarZ3SNUMx14Cf9uWsfNbD3eStRVuri1Rn\/a\/rtXQiGgBkl9MPII6kQbiRLoHf2VCyYMsaazdZSUVcq22oLOHUcoL1Pi0gZ4+nGWzUWKgYh3KjqtavrpUEo91vBbz6MA\/zJ8o8DnKjhcbK4SgHYj4EdrN+3mJ+Swdm8FN3t9WvQCFcu6ljhyYO9qeesaJo5xhgpeMtrGweGiJuoNAxE3k2l2Yi\/062I6AorN8tfP3Ndx8PPhqmKr81hmRhV36nWksuCz6Xiw4OkQ26Ra6xQ3O\/x2Xg+AZbOo4Ifug80UErQZrApNCe39tELNy539kWDMrvvbWDoT86DwRgvyGiWAbGrDBMIUUamTc\/LOV3HLK9v6NhyQQ+HR4w7W5\/Yaov8EjK4Uf5YygHdJfw949TbWEnYISutr59FmNp1LQ1U3FfucRJgciOj73lsvumNl9sbWS9y9vxPGBfQyputojHifrxyOJCLUCO47vMc8EWbr7sY2Jp4D552w1mfhpyJ8ZNC+rV5G0YlKqFMLvapomqmHoKdxAY6Zq+PThEZfmqc+CCeCbeQuOwoDs54u6DbSK9qYpSSQ7S1JxNVxZUlqb\/+2zxB0Ss91WpOwJsz+iefTsbBLAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYQKtCYgKMO+AOBDbpjGbqKyXMBtXI8euZBIzH1RBRZOjQq4QxmGtQMvhdwTHZSerMybSkw=","type":"onebip"},{"name":"Plastix","paymentMethodData":"Ab02b4c0!BQABAgAz0XP3DwHY67V8x1Kq5j4lUIyNcxhyYTeFvi+o\/GsDs+\/CUmZOgs36zBOxZoNQlx2oZE4gX1CIvJW42O7l46QO18yk76FjW9z2hEiu8OUBuyVx2LCOuoGbf6nCpLHDbptCJeWmUVjvvLrEp5ecXJZEF61LJRnsCVBPMYQGC2HZg+G5fMwgmfTQ5GflgSWvJJNhYewaZEt67kIEMkH23fEWk5fcrwXsK5RLCdGiPFtfroryjT13DLimjis8cn51wAeypTdcBLUDb3YDVRB0GhTMcTBOUawfga5YA+j7iXUBOTZA\/s63dDncGLRAFvMADdXHIwAdfzpcfXp73P5WmUy1xVfdFL+yT8thdDbsimGMFYW3B+DgxIST6DHvdYRQcWeTWHaeaBbxBLSlssgXZ\/uwZ1l6F\/U62jq+lvp0SLCL5VV9kNjYL1gj6ILq7Q4kpBlakMUCzD5HyXFzJTBIO4ppAnNwQNXxV9CGWWejaJ7CXKtvkMhMVxQuYEdudJuV6rjkgfZ2TaHtJ8ZDabSQCSlHwgNTbC+NmESnQM8NiFWUmRUuDp4bj1xyKsSgTckTKlGeYVExV\/DNjLhVETP4z2nshwNjKljFFU6tswU8fLlNIS5bSrBbntbDQpz9EyXSxlTGMn77KUBHsfj1snOMIn+IyXStUMhy+EukYyAs0Xm1oxBzPVY6E\/USD37p1Djfz7E+AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifcImGyztGTi+gJ8yHHByRjLvwsi78BpqhidrN6Of1kKrk\/399Y1IfZp1L8TkLTL8CPE\/j6ZA","type":"plastix"},{"name":"Pluim","paymentMethodData":"Ab02b4c0!BQABAgCpN9PgB+5PbyuCmztxgw6+aK6ao3WDV\/dDAYA4yaeYk0kSzCzSd0BScnh5Qou7ii8HijCNxdlLKa+KOfRTK2kUey4K0lHKqzjVBWg93+ls1WdISaSlwN6pU127jcQy7ayLhtt3Gay5zASPvNLuQfbQQUi0BxlbpgOyYN04gOyhdbHsbGvRqYayMNOeXLg6kcPJr6UtNvKvkX77\/FAu\/q4UujghWe7pY175G4+kmdYlo6iW1pqdNjdFJvHizzS+MxXozRckbl2rrxrw4PTS5Spj5i9EbfUoaBfoNt8SrDyxBroh4cUqPkNbX2gN8SZMHZ9Xp5EWPK\/TlHNfTiUfgJKAqXiN+9NTmDowtNOufhtckm679r1BZlhPQ9w9Wqw4NmO5lMv2VfQfO3q2QKM4DTMzOms9EsGVTaXixB3lf6ay+GzQZiNQpiB+PtCkcJjkRtAkuIR83Ru4MSTI9t11vPSY4sQiNw2hOkxUPzXtDinSAJQ95ddPfxS58DTNRIpIgQ08puopzECpWkB\/JXk9E4ZPachueVcLvAm4eOhBUYggtbQ1OtS4ifoilTHUISmgMBia+GeI7kPWfPjBumAvYA6RiGTP9I9F2XbNQNhNPj+A9Xz4Tv0ezu6Xatl\/5ikGUjArUkFUXse9WMrAQ8goojA2zl70rIsfD8FApqUGBuviPRCGzN1z8R7ZetTAgE8mqbdsAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdHayxrlLM4RXYxNWex0cVNe\/l+mirjDxyZHFbANdCJUe5MtnIPznUnI5Kd\/ODC4AMbU62fupTbSvwU4","type":"pluimgiftcard"},{"name":"Illicado Gift Card","paymentMethodData":"Ab02b4c0!BQABAgBP8UNwgXCInrEhB+jYdTLk5ia9HzyhVcM903mjO9aU+YI6HwyqK19e6kzOx14TPy4uVwC9o2ZSG9jj+Q4P9crDepL6ltz7mEdBo6I1d4j\/dPbg\/ilL\/I\/WONbzyQuYmBBzZI1f1GQG5U+iF+d0XM6h7RrVS5xU6DZLkFkn8cY\/QPMu\/U+CDdjJKHfTUCyAnNlkBhM4olMHJK9QKYsxDLBbVRC3PeobNU6mP39wCCOqEGph9xqayFnIZnEI2gw0axCg\/m1wCAjKgwfzlLXt2cZE2qy\/V9xHxE+OZ\/7rEyAg7YPUYN69R+fbXfRNq7hvxNeZ0D44oYeEhCOk2k8Ue8AgnyUT9sx2gehBVw3GbvRIQPdhSN0DQGVXiR1MDgwt54NqvyiXEqR+gtgyR6\/FcWV\/\/e1g9g1ZcvAzLaFT\/CB1oepfOyhIXe6A2WpsCgXZ+ivz4sUKNRcZ4gcX7cG2beBWsGz+w9FHaXHmY0PxygmvA83PkAK8bts3ZM+1Z0B9eirW1OoX8xUkO+UzesCuHW4pcu+sr2wZD5YDSt5twGzzcbcpmSc4Y47TmewJOYl\/VuIwDd4l3DwsscQScoYQY\/1eBjC6IBOlhrmsUbL\/yq9917Ij9ScYEQ0g2pLiyM8MZY1lLHg143+ypIsfkTzIQtcYr1Bk7imHgnWIR8vqf51EkxDWYMmtYA2KtCSBqaI3nAWYAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWGCfN8Hg6fIIN1PcOKhn5oAXs30jSfkeuIABFhakzz4Ik6vl627\/JIlF1x5yta1+FUrbmuIkryal7ZE\/paOQw==","type":"prosodie_illicado"},{"name":"Rob Peetoom Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBPrkGi1lxsmHWAZ5YsdvcYyX5gSxxx1GKvThlarnANnNV3\/5dcTI3kfq7ED+DIuscvS33bMGGdZB0zWWk7nEOKodpo\/QmhQpuqsdy126he55Q3ld+CX9aigM6eFTmCqy1bQNYqPJDzp9CHl0gKxRmRjHeJVAgVN8ixQ0NcfmcJlyk4cX1unuuI8jfLbpROYUij0bLQbQXIC68sgBM2WDaJB8vymgN+XAJMBsRLxNe\/7FKOaXptqv6L3HxleCXdV7hYbEvQsW5BVH4jo2u2ECmC7eqeU0YdQ8qrdXCXj+TAtI7jyOhSrEN2Dy1K6dspL2ralleyHpm3jmrhS+NRDr\/ErlvEKyLB1+xkrgDyMdDj6uGHNb0g9UJ2O1MU1\/+bc7GfeGp1CRDq24wEbRp+YtNbZ5e3sD0h7o4E0iQcCDpowZ1EsMqUsy1ORCtznaz30tL\/jK30yfhhuTtNhXC\/xvdlm\/jkDiZHYRUT+1d\/GHc1Q3HxJnpbqkYTJBrK32gu7\/lG9b8Pob9n5CnbN3My9vMLcBQ5cK86d\/F+0i9hSmj+TiHS3cN\/11FY9TRH9neNHLnaLmdqjSfOp\/unodw\/Ug9L61QgOB0V2d1H3BUM0IMWs8OBLFqZ0NiDvVene5COcSSEPIFfO4+Wq9Is7OworoKwzaizc0QelJPzbw5gIIccXRBuPDqtnhc+xY7wD8T79IMeAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYBTWBV0iDuGH9uoF4QDbEGJ6Kdg1kmTtSAVix48HVSEXHf6AR8qT19UQOL3PSAaXzNdWzP939pCbZ9b2LzVD2k=","type":"robpeetoomgiftcard"},{"name":"Shoes&Accessories Cadeau","paymentMethodData":"Ab02b4c0!BQABAgCamYFI8NGAGQRFMz4zD9ZaMmORJl7JgqyH8MSEdmNSgVNNXCdjwxq42EpPta8vNYIJxoHwocOIZCR8zkOP07CMS5\/tJ8\/GPz4LSMwBzc8cPxf1iGec+7SwpetVWQ+PrBhcgGN\/zhh2G\/XZT2VufjZyy6xb3H5BZRtzsCNLjAJvd9LeWjh\/cVymCuKnZZ8po0BxEiF7D6HVvHqOt\/ien96m8iAhAwWj6\/bk4GdmhWaqA8DFqb+qTbDQ5CxjVtCVB5nFvbquIuFWsuA+vV0FcpmJUUXqRi0T74qLCpoiavztSedKK3tCs4OxlOocgX59DIiTdnmTSW6RxdF8QUavk3xyX5XRhO1qGlNRLXVXkEjKhwrMXHUXJMQt1yMQJ1vd8gLCgwNtJbZOkEr83C6H8y6LazXnhFGDVWKKZ7KCS+QTOQ2mtQj\/bRa6DKTenJXitXYoKFKMAvY\/MuNPJZBj4np8KnzMDgpnJN5sLOyrWQFczdYEVPPD8oYzBagVRxVBdwB5+7I0h6hxsKfAGZIdbW934p2Lp72b8SmXMPZval41FS\/j8wJ1x6MbcQjBbAcz75cHIqBpOXRF6j4dWVndwaKcaxzBgwz7162rI6OsMRVrGHNak\/4FSM68ffeyUHdf3NA\/zTE\/\/weNErLmxjzvbNFu7Ghvu+IhOtDTyi3ct3ewGRCP9b+BccSXwIsgJ+NkAvDIAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVuHpmeLlJGlRnY9U\/6b3rWTtSTca85zykpddNhov3AIQzlrdIgACu9SOITAeyv740R3f0t2L3fy","type":"sagiftcard"},{"name":"Score Giftcard","paymentMethodData":"Ab02b4c0!BQABAgCsAD6QS5AWxVyPO2sJyskpyFh\/tVIVCByXM1cSTo5bfw8SypTWe+4ZlPHPc0ezt84DhXEr6TOfsjXS9ASKFkanm+AQvEvWvLLfO+l+T3RpxbmOQTGhzx\/y0Z2GiPtvylE+Hi99Zg5kAqwW1U0B+MrnN3VQkT5UGScY2\/oQPtpDGIxM3q1pOJ1wmc7xU3TRaw+C7r+WQhGmXvAyRqYd4KWlRkNNzaG\/CRXiekrp3dMp2h\/FqMetJnUyodp\/p3gfC+JtpC8UDrijl7enUJ3pN4VLYeeAlU0XtXRFjqT2vT5Pwb21ZIPvY0ViLVS75lW5b5t4zvGH\/gU0t\/0MuLwBEi9NzfH+zKdIBxldODf2Daz3fAMfo56ThHC8UuBncFYHXYT04bMaVSbkwfFgxxUXTv\/LwYZYKgnOkU4IgK0ZCCPjMpH8xLj24fUEPVcPJI2h6C1fFWtgh0H2lP+XQ4b4qOMa7b2paLyLNEFxI\/V48KKXBFOtpkino6vXzKEpYWjTalwA+8K9PYfF5FFOXym36jNY9dhijiBoA9\/qoyuQqZmrmQ94HYkRnSIR5wBfkx73Hr0U6stj3fwsd55M20JiGKp7bY2z81VCc2z6mpmjRyhHJXG5d70wX3ieNqKFNStHyW5+lkIeaJW404Svytck3kgchxou6CKVzvaSm6aCsGTG\/RCFmAjn2Z6NdmHBaQrSXcutAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTD4OtVWJcstgpTY1+ZIpSrWXEOWsSqSiZuQwnq6u95IdDrYQkulLduW+sOzopMVSSmaRLGtgdS3Y2AR","type":"scoregiftcard"},{"name":"Premium SMS","paymentMethodData":"Ab02b4c0!BQABAgAEOrM9BagQAJYKZQNCiGHVFFsCC3VuzYZrfoCCn55XO9TnTaROMV0h\/bGll57gS7TqiGuoCeK1l4Y4V+aNv5OC5c\/wAUBYDw114hWAsetFwu6pXLv1br9RIJRczpyvJlmRomRLPQpaN7cls0typ5WoFFzp9WpwKweFBC34ZIPLEyrVyZDWnxVrq+kP6p9BfLwGaxjE0cxoTq7VLPYtOpSU7Pxf0fDmEd2Jmb0ZBq6Ed90TYs\/EyNQX\/UWEMjkZstMGB86zCbroxBMLZBmF5GErKIIeyAuAylvyA4LrfTg7T00AUEyD3X9viyHFigtxUkhDGWpvK8iS1cVmygqUK3h3DXHvzKmvFOdfmeI84TEhflFgr6HGCNSXKmXmYVVZV9ZJp0nDrNWGvIUqfBCfOc4N9d7gMFqJsUaIW8eFqpwpObivqnqtN5ZMzpWp5Jc3Xdrbwa4N6e+aer17AqrUQrRqHSr52XtZiIWtVs0S5XJNQJRjNU\/Wvc7rg4Y+smVcfpBJJmhWxn4EPtNunALAoMiNRPDxJSOoJnM2aampaAQlmc8A+EGHsykWCG4xUjytLYWcvOn33lyEIAEui6Vphq4sdCnAfSebf2g33BuMZrjzJsaapVhjtARxH+mT33kdgm40D0WkE3RplfCCAXL7LOQgErWdRYoJfTxqkRHlI4bwgBCEwecph+cqKikCuEyH6i+vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYo3nNjRHRR0bt+z9AiaiGKI3Jq8ondSBT0URcHGdoA4Axf1iwA8xF6ux+c0RBBUoIM=","type":"sms"},{"name":"SVS","paymentMethodData":"Ab02b4c0!BQABAgAeBmmIFVM3F7FmI7FUeX8E01jMco1k+S3CS+awh7A3cCfpKvVuolk9y8ot0HN9Z+RnZnVzRj2khOGPL4ArHUHJmBjCxknuuP7eVEZqbAR45z+FOl2uCHw7508\/fLLCLg6F+WxliWe\/9zf6\/kLz2rWgo2YIjEM2Id7uper4lCvXZW4pe6IRMABXnR0owxpv3ZFyGY7pxGst4uLiQ9NFmbU7\/5Q8T5s6tSvoTTMhQ6jYsQQ1UQGUxS1DzPaI+QkMiBOxB6iRPH5hvnLdfjnsEBFZqFwDxqmJXokHu5pA8ZcPD3gOasK0yxkrOnJsvIYxqbgNYf2v\/366osBNzspcwHySDS+6qJY3ELOhr3iXu87zs\/JF993pdxvcS5isDXPZCUjx2zt6gqvvOSmmUei23TXbz66N+ESdfP2Z3AeYbA5U9T9f2T3QpIQeas69oQk2TPrkqeC3uU7Hpebbg8tkE34cWCRxWnwrtCfhZqt9DWMDc\/yZEPz\/P9AvpfcDb+hRe+dlfjPiVMSN1XB1Spc47amAKQ40f7FJqqEPfTe7EpgAoykt3cOPnH2DBQdkD7+N9nJWX8586qRXy5iqF4eBgpce9PhNYrkAOgAnKINAZt5sHmXqyvbvvAtw0f\/IViyz7dGjBmCqgVzA4wqpEyKi6SPmo84cJz1aP9TmVkRl4z3HKhCf\/wxj8atKh+FTzLWQrdDGAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUdo6211\/Wzc0dqvxJR3\/jWN028MVDDJ25rQjkrVgftRgtIjiWwm7vIdtV0o+QnEa+g=","type":"svs"},{"name":"TCS Test GiftCard","paymentMethodData":"Ab02b4c0!BQABAgBolc\/4\/EGNHf1pMDEsUskyzhi9KYN3VJ0l3+0ZjemuURepWRERtEhwImXhdl5R0+cnJbs5jefQfLVytf5e563aoA4lwnadk4XJS\/H0qrhBjQ+9uC8ZFwxAKM8Q0Sv8t34aidyRAFl1IxEc3GjbSE\/ujiYL6LwwCoRNOZB2GgojHGZPm7Trh5Q3WSSm7d6LspS\/qgLN+P5QdrMHg3395mh4ITHNll4LeBePw7tFjuaOPB7\/MuDxmauyaHDs23knh8xwRKFvydDikDNjANai4LWhNX\/74YWBPiQmI0GZ2glGiWUeRfyaD2VhHxAiYdPLQT2GhcDZ35o7Th2wX4HSg76TT60fL3VXOEOAinunSOTQo0dcY5aN55O2CQ7CzK2XxBRc36Jy7J0gUKk7fX+Qa74eG9YGfHGYYzN2QIDCpFK787syWcKQ0Y6AMyQTYbcIs\/iGkzZ9V2URyBh8sUCda2nhpBgLq05UBRjPu73Op3DsS6nU6VxPg\/BjGc\/rbt3JF+cHbFQDfiJKiFQTOTQ25gzMZ9fwW9pi0ED13Yv4WCGVTbbHGoGePSbMyopjzcwcqhSb1LyPmpKPoGeHS3wnrBRK3nEZMWUJ6fNkX2SCCVB3\/QeFxK9Psmr10\/pYrso2Z2lD\/SdoMebrdLFWRKHBuI98Z0vHs1yyC6TJhJ\/AQOfjxxD+4nyK94vO43QSq2eOfs0nAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWfqRm4x6b1yAPMGiiE\/SNY05neMsJjWAP73Niv3rOlQnzl+TRhMwVGR2URszHeFIwAYF95evu7q+h7Ui5M=","type":"tcstestgiftcard"},{"name":"The Sting Giftcard","paymentMethodData":"Ab02b4c0!BQABAgARZxSi9l0bosY++4DiKLjUe1\/\/9X4LNxVhzU8cuZlqFg6AKs64qmU3Jz3ckBYIwawAQ1UoRP1EH6l87scIb4E7IuQC+Yy+D86VuV4JgXp\/8blzq6Ix7uruU7TsGbCMiRv+aI1DWSrmjk\/PD6yElbE2D6wuN1zCz5u9K9FAH6gh8TztyGqnpj07fuxbJZWGd5V8pi703k3YfdSDAaycUavf\/6aKYp2oMGKxDngbxJ2l0qwoQfOrwwAVFAoXIIWkGmUmk8Ez+bAThUzmOzJ5X93le6sJUPQpxN1c4Ak5avVko9DK8VWtamkIGXBoW0cL\/FQDxM\/yfvIbcsL64oCAFB+5LUv7+5E5W79YY7Wf1f7U1ok1bk9QWgFvG3pr8PqxoITc7LpcIlitBeclfsBD8C5Z4KajJN5k64ECtcoXUdaGtE\/RmbgfWDWGjIcKsCnpRcS3fHWeTFGFatbins7XL\/v3LVzKVPkZpF6TNGhsXtqqgZeV+vkIkCq7E\/GDddpljLkspqqSVvayYEf2HvKJ7yorY+5s0DMXaEqE8ZIdI5MF3SQXDozK2oqpYSlOY5bPAA1t9bR9PbvN0NX0gtjo\/bcFKs\/steFeNY\/CkXMkSq8VBnV3L4xmOBo3fNN6UIOFIehmrZpjzTl1xuLzL6TbW10a2cvfHCxn09RiFMeDeQrH7RCCTI1cd3NmyITBNEieuinBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTU06\/CT1jKoO7oqHjl3sfhGodXKB1a4l1iTtGs9B3evGnR3Y0sjvjFzH8+ucdSZuWJxSE+1lOP658DGh0hb","type":"thestinggiftcard"},{"name":"Ukash","paymentMethodData":"Ab02b4c0!BQABAgA5EDRTW1MJj4ec5EAPY1ATwMYvsgnwLTbirwaXJCCGiCe8I8CgF3jXymhiHUku2JYCViZcRK\/tCz7oAMUX4wxjbZghHlmZqdzP5BE\/KDwvO2Vsxr\/qmSotuFvbbNigiEmkeBj6LoR7pQGvSVTjcsp1W3mL47snog+rsn+jkj0pXJhZ1U8\/aXrbB9wYuyaPWYrtqeDa1PL3BcHtf+Z0wNpdaBP+LpSpgq+klmUARH26RgaJ81EwnCOxESR4Uyj16bPzmAJUTxMaZkC2jHughbG5tAJn8AHFZyVTMEYWOM\/1aYZBJ5v7KkJIN\/Onr+oYhQIaEvJH3OplSAz\/DW7z8+8jJ0+5Frv1\/RCApVUSfIUOlN3q10OtGkkDgGnQ3ku7zMQj6AMrI3KU1tsmaw0C\/B17ZZ4z1XBSgwvUcRiz5M9aNCg6yNs5EUvdYd6hrAwM1LDvrioq+F0gWlTW3f+8Pzydx8GMLC\/xcYG\/CJ8KWb\/Qwi2JXhrG+ZR\/jE+VHvzSt6zuWaWnFP5pY5lr5L0tki1fbq3tT8EwLP\/TdF4LX7Buk6uv8jkQMC6pavHTJ2zSfmB1OZC6VJs0KbSaphSVhe9ka5SPrrzH\/beuNQpgIosE\/tKIVs0YDOepJvyPHV0fXO51fOX6dwl0XSSnmVnpv6Ejf7NNPkaqrHZ4TFMamIGhzBBC5PaMxFRWVoLbpQ+\/zanlAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifd+vkInPycf\/fO8hcPcxypCKMgn8r6bUoLJ6gYhTB80iJ2SvRW7UelG619SZCjeiejweFw==","type":"ukash"},{"name":"UnionPay","paymentMethodData":"Ab02b4c0!BQABAgCyuA6AzYVuq7r0baj9TvTCObZzY34GhJXajSgYTq5YtvuqCLGYU89mEwIDl8WJeGPmeeoKLKwGr9D6K8sinPMf\/prc44smlae8cDbjQFVyHkA80aOICCEVOaoj9Ku3pGf+1T3\/MuML9yxaI4LFziZS1oTw+K4ca0Lhf3anHgK0czR3jjwpyywkku8am8L2nTZTBms8lwo+2yZTBmL\/vV+WEZhk29daHZWMKsMu8luX5tgW\/E+UHDye\/t2riHv4cBDBns+bV4\/46JmR21mGYqyH8UwtbIFiSJBmR0jo3\/jiXNrwZL\/gE0KKoDYFQ1BecK+2AT+0LkyFdzepqMEL9eMLh\/Th+LbGVlXFttBy6vNZUHXxHbHWdW3u3RgBCpxwCdHy+fcSGfaOKTfUBuSB3Nwd0pHsS\/659ocRfoRxO9pKOGVIqye4twmX2AwygEI8iw2maF8r1JmsvVvTliiSt4LJLLvs51R5atfLqG4yFpjN1Rb3WXtekzncKfn6kADN9nnUHkI+thX3Yrj028TyOXpcGSjhVLAF\/YUFjHnTQuc\/0mY+JpyqtOBamq18DGfFIjwoXAq0\/rRiJVsPwTccI5jS9MAqZwVOl70Q27fYYG3ujiwbwW+REZlxGVOgCDu5xznDKLICF0YBeAi5+3dxfLepkU0n2WIJgXM2cX5pgVyqLhBUouM8o96DqR+dzPm2tuAMAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXLVyNJDBr+PMaR5skK\/WCNJ7GraYtn3IG53OlJhFTvHAkSpSXjr7aNW0fQPF4V9sKyqY9eyHQ==","type":"unionpay"},{"name":"Valuelink","paymentMethodData":"Ab02b4c0!BQABAgCXS3+Lg6LwZu9l\/UIyfkrHZrwgOEU7G1xft73fqNOT+WzZ1qc6RGFxgbgfxp\/YT1c70OUKbO6skjYBHAygugKQRw\/VR\/C0KeRsmP2peysWmHeqTr2goqlz9KBd4vYS9SWMO7gZyPs81M2WvNqEECIsA2EidAoKNtB\/gY8RTXzoXMP\/ZdhDMx3jOwTmJwngiycyJA46d8oo6eAFeiO9iJg5d\/VfC9yN65uc8s0hBmFmOqdMg7u6m+Qg52pob1K1U0uDgnxkWdcYwndFwjwz5WmFZGXYOA1U1VCt9n1Wut9L\/U4Ninrw\/E6VxHKfAgHHYLyLhsFgLQ1DLRv39o8EzHF6EhwT9VofcqxOXxff9DxCvQvWwZHch6SSKqDLLCB3p66r4RxAJ+UxBhfmi9rm9Tcs2AcFjEZSWdTYLtABhlTxkZBg6GlzltimC1RUNInnmK1Ne4LQIdg7uJno2PLvPzIXFgE1MVM+E5Poms8mXJpwZEmsouIFfZc62Vn09YmOwPJWiDkeyuQ9tdyiOI17hlPgcsDZTRXQ8Fj25RB\/L4NoBMakD9XR3fqVsoxRW6eWmhjHEEQTvwtEoPtQo\/BR8105pk8fb3L8SPjxH2jcPCGlF9svIVWJgt+DUtit0SKfRKvb8icQoNzNrFGTlsfIAhLSTvcvu3DDI8vrLJwOXwE+TBBRrXSqOwIRPwEx7ifaQEd8AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZvexSg4zbtYaHe40B2pdrLV2LDz5V\/XHItrgI+22VOX39R8C9vv4skekFaHgZVxkstbOzkZCf8=","type":"valuelink"},{"name":"V&D Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgBXdMKsMJE6QVzKoo9KqxS\/uQcqEhtL4e2+W6p8fP9l5tNvDC34ynhQfI8e+XPB3WawOdSnwNB1HTeRxN3JkWLm\/ei0nZjJObQFqjD9YeS1c0cuPSRMnGd3kogfOsjt32SFt++BC+NM2xhglKqLewi35NSIeFpEDS5TW1VuIkLSUsDay7rd7Nxgy2Ob2qGyI5LpJgBIKhteDfLTW9Y0v1row9fG9xGfOaGWdSXLpDii9ymngo6ap\/CDvh+nIRmr8QXtkb0jKv18NVAOpF+Icd8jbNCC+0RIXBDMSFiPE3HQ6Rg5744p\/3dFkYU90t7FnG81y3IVvlPc2WDHqCC37hNKBxcx01PuB+q0g7384XDdt0InGgeoyTsRnCiVj0dgBDCCwc58tmLrGJOCjXXUEfW2fRn\/P6ImmbfqSFEjVo5jYf6fZOoq8eRqbIIDrAPKEyS4fAmvFdX5XLwsQ+9VZC1DCseVTsf43Hcjtg9dZbFfEaCQ9bi+jlgah5Qt7Od6X0ZLrolPnlxnEKgLqVo+Bi2n4ByeUgSPEzWeKyjM92C\/4Xz6mFvY1reRr5FOyCu7Jso2ev0p9IcIPlx4PR0SUndKhNRayth+2mMmUnQnFQ6uLdh5WFPOwXJtvAviJEg+Ar3yjQlqDoMypKP7yik9oCNE6s4U4f2VbEUTG8CilMPh4BB2M\/bd05FUVn\/nuRXJPCIaAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifS\/x+tlxsUkQlFOB24V+5fVdy5RAOSJ4MqfntnMMd5C9PS9yyLvFpMpl61Ll5XZ6h+6HMZYTR26H0S8=","type":"vdcadeaucard"},{"details":[{"key":"additionalData.visacheckout.callId","type":"text"}],"name":"Visa Checkout","paymentMethodData":"Ab02b4c0!BQABAgCRBzsU5zUnZKcgmFhYDAXqzYkmTbNDzWpSQ8WDlMrVK5qNsuWuy2ZaXnD\/Wwu8w86\/0Hm1E+ftEtsx1S3puWyDYsn0HkGsn7LMf22QlYTapAzVKfMfy04+ftonzfa8\/F8CwoPrwWZpLDU3fHuX3BeQiZJnNPJLBx2P6Q+R\/jLnOLqNZLJQpn5AgINh2PMVAWFs40Rj4bVAK\/ZKTLovtrvOTv9q3DrbfA4Yi8FCe23kojjTS+L0UeuQ9UqaFsDon69UPlLBgQCae\/5mLBjq5+VnRp8g0Rh8F+8ubNtYuV5CRg7eVv2EmvKru\/HbC3MXr6QLk3ZE+9Z9n7ZxoS3Ka\/KyYEF2ezr\/3vtO0Ow1z5eTGChZbH7nnIHrrp0oYSrm+sAzuNbzcom578Y5yfHs+x95OFOiWg2EcrYgvhiy6JWzKDkdkiPbU8VUhiW\/WDO4g5UZU7Xz5l1dAaUQ0u181Z2erZYG8uohFHaLaCoWAJ7q7ALJGhaER3YoMhyIvxF5PDBHo+PJL9fQi7DBJ\/4u0VN3a7JG7Cl51VDn+2+u6mp4yYIDyel8AG\/dQTEQzI8goqpVhmhbztIYbtuy1Gp1bzpohKinkaz85KkeSjDa4zrgWeE4NcVFXolUBKCMr8lbop2bC9e\/ad5vIgBbQmcoSuvSI5vneZHVpLLmf2fx9vBlvBArh2yuY60lBQFujwx9ZqRKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXV86VMveVKN6bFBc1AViWY+a8zixARejUFEeswDbijtdg80oiA0iK7yixQBMmJp88csCWkz95KSaOQ=","type":"visacheckout"},{"name":"VVV Cadeaubon","paymentMethodData":"Ab02b4c0!BQABAgBuWnaPEjzVEB8\/NGLFT1i3XrlDJzrM+WNb\/Jlv5tb4pJctyyRwbUtHE+Yo+7v9XRANk4DGTuuMYL5BbaqbuUvs2k2JbgnlWHrqqcjA7cEz7EWRDEm2m4jWnMi\/KO5buk0BbQ+Ki\/7YNPsSkuCgUXGrIXAST5GRPzIwFYOS7M80DzlyKi8R7TdJAu8nsnpihktLBVOHBr9WrNRMe3S7p4Pd8a2HJGD\/CakIL9u7LXYhqYqgfkxfdvQrQFaz31p2xU9s\/o3kSWXT\/gnCJz5MuUhqXiudI9mNroS\/AYbUuSZIFFnuegd2t35BW4j8jzvgOZyoPRojqCGmAYUP6aAHShe6XB+7PN6dAIhJkLXznSpIKC1BtyUuG3HyUOwqFyKtt66E1\/ICJCmAAfiZkbJBFaSIUFnx1EM0hY7McaHS0+gfb1dQvBhJP\/fyBDpQAx6SaP2JAG9yivmzkH3+fMNoP6sxVyCX5EHnblAsXQEWxnJGZWWLzB218sox24jDHj01c7ZcADh4gowAJDZYsspaTgddheORCW12ovjADJFQKGMKEtpbFNVZ2TQl+mwBss0cvKspm2kGAPKWX0DjKa0HHvYnepEqAHwT6Qhe6PXORHbK\/3VcXdezEH8uyC6W9SsjsDO6GVKpWWItfOOfCqs\/\/3ViAbk6p72shjiFn4Lu7+B+HBCaAFBKqrM+zvXaV\/tH3eP\/AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVRLRyVt83jIBl71hMGKc7Aq0HNbfIAVFcPCegIt3jqjLySlfdxuP\/plZq3KB4f7vBdLHdqQ\/3WVzro=","type":"vvvcadeaubon"},{"name":"Webshop Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBw5gIZYWEh6Zd7RAM0RcpQNhnPRtUAHANn0tEb+FCguWnzFfqRV4thObH9oySVyjYp1vbALAAJGnkR+Xbm4KLf\/kWzz+MsMidMXC+FWs6hz8covVAtzRIIvEXlRBB17lLCeH9yJnWau96Xrm9l+yZgk0EchvtQoBmYeqSb4sQqJYkQdFQTTJHPAea6JrczKFcheU86s9QeSbzKxUOzI\/0ORulFOQXEsjk3Evm2fQ59KL3oBtcJF1GRJfcWQJ7zZ3JRhkyH9g1+Sbbfj1UYtsyl8d+CTDwFuqWmZyA39biI5VYXBW78id4DuOVKdzv\/Dv4zWy0dXDM3Voce0oZIRwQBC6lg5N2mw4RGAhp7IcUL+4DpZcrTOK4+ED24EmWrlpTusUkHNX\/SaV6Hs35PTK065jXtXmn++GvF5BzA4NTAn+shTTHCsl5sv9rhmmwx3+3BCzIj0cMAiFMTsVZ1Tx23+MnUXFIqkljRlyD07FnIXIbKeJoGtx6t+B9EKHCqEuJDnKWIEs+DnMRQzhiuaOh5n\/G0f06Q7FG6PYAKFGTe\/tw+GSKK6j71dYGgWycNzZeHW1sSNFVRL6pURb3S9RBMjOpeda3fUKChbIPqhjqF+wKl6q7XQvm+w4dKXHyhGI5DY\/9Vs\/DX74vRxcTtutZMhTGxI9JKmyYDQToFhwEKSxDXjdC8tIvsJDu7LQ8ve3nWAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQNrhANo5lS82O3KSvpHQtFHz\/w7XKDsG+sZhRsBQY+N+1Cc49e3d3xeejiToANWLbh9llsOy4hRUnTFUeI=","type":"webshopgiftcard"},{"name":"WE Fashion Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhMJIQ8zSZ6B6qQsbRyoLzMkLbJnIcfJHIMLS7tmbn3eRoZKTRWbey8PIxoyltacmUJkU9Hktzqrcczfx7UZdEmS5XumukT4NnlvUeLQ6iBNiTm0WNqDqgL8P8Vzpu+6GJsT41oxrPWQUnRIkh9ZBjqkq6Q+RVHJwsYTIdZpKGihaZlI3zNBgwSLs2LzlLnAqLARC5X93KvfNC9WifdaPentJQmmJUx0U6qu1Uj9a6sHB8GNNWBRZW7sV3HhSUR6Q\/FXYxZXmufRcqM9rYxIC\/Ju4EV2bJ+jLaoPpXu7PtOXiT39VGaZ0aX02gehuSgVQ4hjw1i7O6kjcKUm6PXXp0JYFeH02ysL6eUBuzi0ULP09PYg3CyFukvkec+RnmEQBAcWCQmzZ1orHgtCYXCwl43lI5c+NwO4mbNC0FL4f5Y\/UgDy79VFKUd5l3w8LwAEint4h21nMLKZYCJx1S1eCX5shzx+cCSd5GAqWUA77nXkUSwDBXXPmIp+GKQMkK7IFHgG9qTJ9rFvadF52PyEv4bsWcjeAyz6+CWOFBwk5TtEvSKDfKLAqU9+me9DfTP1QBY+FJYiBrOBW\/uBgv\/6NufzaDBWds4jJOVpo8S03\/yNCvM94DTJPIRfibEwGamM2qrERp86e1wjr0ao8B\/Zlc7ZX8QDzqDmpTCHT528mbuBDkq7A9lwTJVNkf2laeBxcqAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeYhP3EugLn\/D17cS8QOqpBIMSUWAoJfWN7rKm4sTQWjtXSso8521xeQzTTR3j4Lm4b1JeZiM3Bv46gVcq79Pw==","type":"wefashiongiftcard"},{"name":"Western Union","paymentMethodData":"Ab02b4c0!BQABAgCCqIHVjvWFfoO125G0Qi\/aWnkQVzmVVDCo+XpJXABFD4JEgSxsq2trLYLqxixmrJXEy\/e5RS1Y0KD2omwavOanQ0NWqkoerbCle+t1SAC3rpMYodSUhBAQluXCSvMRXNFrzFpxeK5+SzphqzTvgvLuMCN3Kyy4fBzCjXeMJwQB5o2DraGMt6w193\/\/nD\/kVGGexOhMfFNitRypd2g0ILs1S1O+rLOh2UYvEKczLbJ+xOqtCckSbE7t\/A28y+fowJxyqbDZFn\/Di1r+bK2Q+B+CvAcvdxbyrRJeJDQSvYI54rz\/2qk6DvzLS+yKu7uZmBaFsd8GF1Vc0CJWVeLZ1BF\/ShquUwXWWAwtaK3zYMy3C37QEJizTsOPwU8LgQ5xvzEn2W0h8+YrWqhAHnLLSfQv\/QyYlYuSa6MYcp0CfuC5Wxr0XQdHtDtdTDx0ixuCvG+bV8Tey6pEABFVDFLtRHhWWsDSlFJi35EMawzt9qBQ9ri2mIBjeoTZVmYNHHPoQSU7lTupadcQnPauOy0gTc98ChXlDQaYIxgXjoVHoQulaayi5+HDNFH6FgJEltb7+vZ1chT83KDM32bigFtQjob+vb7uArSqC1QZofwA4brnBmitCTuFFsWEf93x9kzru5cFKnZZCu6LYeFBqifpRDnTM+8OcmKjXXUv4OpzUKy6hxDOyQJZ+vzZMa5eASNa1ISYAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTr1ArwVsfDs6+p1vy4hzFpiQEO1qZlAmr0hJBKvgtDG\/ormHk1hx5CoFvjgKJj\/g9ORllgYAkavtqg=","type":"westernunion"},{"name":"Winkel Cheque","paymentMethodData":"Ab02b4c0!BQABAgAuGTr7Hb+sS9WhMaJbxMJQhXv9kpCTqWbc+RpEEcDBam1sWPzqrAWeyEpqPp5t0Ts94E3zW7RTJ0AyEvhVS+KpGQKn+EI7jt0liVbDaqFAG87xZdNdtFVXlfBwMk4DLWgr1QOYW1AABoVcVV1+Mq2hL\/8sv29dh9ORkTf8fFv6BuEGFoEc+Yze7k5gLXnLrRkiBVh7WhpZR6TXMZvebgAjBQ26W0erUSTjzzs4bVl5ZqsULqmHmjj9ZrI+MZ2c4orYMK8SJXb+qKZ697NGEazsyMZZRmOG5NBYzOEjdK9\/SdnabgRgqxAWhy3nSQfqNgVArpvfivFbup14x\/ZM\/P2P6xBFyNyK0v5PN2k9f3gFEUtvM0Yz3zj2p9qAw66U6+ug38u3luiIwLHXFv8Mg87ELftuOJwruAYurvCqyvDBY0j3qgBb8fa3A6EULfXU35V0hVo6r9SHW3efvsocd6vjKQogZP2Tgf4e++kIF81n1w39xSPaTaSHNnc9HEtFcEMrgkmFlm7+MWAIf14xWi+jDdPtJtbSkFE\/lDqxsyE16axJ+nCZ2914Eiplrs6Fmq\/f3T0QXQGXsZwTXMwZV8ubAa5xv5Sowoi2ZGVzDFRhqxK3PfdQIVNyS\/U0zqDTJ8Dco+0DnlPfS+\/S3dLHixJzJDJegh1\/cy10Vz8QUrBzpRBOKwDnktP8pBxNeO0dVr0nAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTRFBBd7HtMO30hv\/1qeyRVC\/ySeAXdYL++1P5WngYLi293p32vLL19uakeOYJbh0acNqVNS9uERfhQ=","type":"winkelcheque"},{"name":"Your Gift","paymentMethodData":"Ab02b4c0!BQABAgBwSzkAZFP62rf9A9s1eTR5eZelvAMGdp75eyxk2\/054VREmax\/NX6bgGYg6hvpRuE78ATV0+9jI4LcwHKCMuXsZWWqj9Ro7hddiMuc1ZDOVmCAchKVnlR3X1R4I8eb4U+plSY5C31VqDBC+tGAdsQjm44Y0e9e\/W4kF6SVU7UIvh8\/ts8McsFMcBNc\/gvQ\/fTTSgLyjghJaDc\/1J9ZFkgtVgAoTSqgziytCwx9J5dV2urWfAX3sIKyI4tIMgH7C2zOvdE2W6woJlxuMC\/bhxUmt9zM9RUWJVzkwaVKpo7RCQzquoSpO3M+koHb+kLLp11XEk4MMV7jVbqLYl4dOS5iP9kzcce0hx+SADNlENxL14W9EHHODaQaeSPrueBGlf4l8GZMny3IQv9UzmSS\/xWvq7lOPov1uFyJKXFI2jILR2dGA6FK1+CSuqlR\/nkyQcQo2XFufYi9g2HatTFfd4MXkUSHF4\/TpdFAd8AshyabLjhOmjbXZG1zukWW3o8Lo6\/rELOloFpQpdadsXb0M5vZVkrzKIIjHoY+EvGB1urnbZNKUzah2W+2chqSC69INtIcGj1M7r0Tt8EaMg4DVAKMXsMnYRIwp2h7g1NiWvNcEgENUCDpuuWENa09yA4siPR9aWcLm9nukW\/TT46erTG3VMhKF++tVp+GFBeFTr83XBDPsKLjXgj3XpGkvhHlmDFKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifa+nTY4wbmTCGTsoOuYLTfMGaYM7Hyyz7AXsLTj951IZvDN7doNuKw2PdTY9Ed17dTickZ0Akw==","type":"yourgift"}],"publicKey":"10001|BDF03F216DE358DD6AB214B74BF0F8BFDCDA9F3EEE0B369DC5ADBCBE0FFAB2A4FA1E31C49519BCBC7241824EE45F7ACC5B04123446D105B713135897F6CBC82C478DF3B26FCC0DEDDFE8BD2F29DBAF35AE66ECE6AFE48C985A08591CDC57EA2B35F2551CDEEFD3ACFB912E0530B402549399C93C2C23CF74C444515FC6A6E5D267A4A2E51CA97F304608FB564DE70E1D683CBDAFD7E869123C91962380D38AF740033D52DC2523DA80CE72097D2ED7D1CAE33B60C91AC2F6307795808D2D351FD112C283E043F1B266C2C347DEE31EE8D606D512431BC5C9C01099A967532EFA06698F130AF5005ECE0CEE3FFAC24884E2C7F6FCD48666D64D40056CCBE62579","sdkVersion":"1.3.0"} @@ -10766,20 +8897,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: '074516' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9SJ7DN - pspReference: 993617894903480A - resultCode: Authorised post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -10796,20 +8913,6 @@ components: holderName: John Smith returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: 083996 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9SJH66 - pspReference: 993617894905481G - resultCode: Authorised post-payments-card-direct: summary: Make a card payment value: @@ -10826,36 +8929,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: '036240' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9SJQUL - pspReference: 993617894906488A - resultCode: Authorised post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 0edcd1dc..f6ca3855 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1019,22 +1041,22 @@ paths: content: application/json: examples: - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1045,8 +1067,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1054,8 +1076,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1063,8 +1085,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1072,8 +1094,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1084,13 +1106,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1131,8 +1155,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1140,8 +1164,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1149,8 +1173,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1158,8 +1182,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1170,13 +1194,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1213,8 +1239,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1222,8 +1248,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1231,8 +1257,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1240,8 +1266,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1252,13 +1278,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1317,8 +1345,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1326,8 +1354,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1335,8 +1363,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1344,8 +1372,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1356,13 +1384,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1424,8 +1454,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1433,8 +1463,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1442,8 +1472,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1451,8 +1481,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1463,13 +1493,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1527,8 +1559,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1536,8 +1568,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1545,8 +1577,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1554,8 +1586,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1566,13 +1598,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1630,8 +1664,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1639,8 +1673,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1648,8 +1682,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1657,8 +1691,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1669,13 +1703,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1734,8 +1770,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1743,8 +1779,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1752,8 +1788,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1761,8 +1797,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1773,8 +1809,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2512,6 +2548,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2985,19 +3029,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3223,68 +3254,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3613,7 +3582,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3652,7 +3621,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3695,41 +3664,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3925,7 +3894,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3970,12 +3939,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3991,13 +3960,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4011,7 +3980,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4022,7 +3991,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4033,12 +4002,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4048,7 +4017,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4063,14 +4032,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4102,7 +4071,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4196,12 +4165,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4217,11 +4186,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4229,30 +4198,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4468,7 +4439,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4509,7 +4480,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4530,7 +4501,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -4666,7 +4637,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -4824,7 +4795,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5309,14 +5280,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -5895,7 +5858,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -5911,7 +5874,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -5949,7 +5912,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6062,7 +6025,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6243,7 +6206,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6259,7 +6222,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6292,7 +6255,7 @@ components: the transaction. type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6303,8 +6266,10 @@ components: > This field is required for recurring payments.' type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6368,7 +6333,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6406,12 +6371,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6427,7 +6392,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6452,7 +6417,7 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' countryCode: @@ -6464,7 +6429,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -6478,7 +6443,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -6489,29 +6454,29 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -6523,17 +6488,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6541,7 +6506,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -6551,7 +6516,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -6566,14 +6531,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -6603,7 +6568,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -6664,7 +6629,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -6681,12 +6646,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -6783,12 +6748,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -6804,11 +6769,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -6816,23 +6781,25 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -6862,7 +6829,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -6913,7 +6880,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7019,7 +6986,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7035,12 +7002,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7048,7 +7015,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7059,7 +7026,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7084,7 +7051,7 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: @@ -7099,7 +7066,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7113,7 +7080,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7124,23 +7091,23 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7152,17 +7119,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7170,7 +7137,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7180,7 +7147,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7195,7 +7162,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7269,7 +7236,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7329,12 +7296,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7350,11 +7317,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7362,13 +7329,15 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string token: @@ -7378,7 +7347,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7457,7 +7426,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7577,18 +7546,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -7672,6 +7641,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -7984,6 +7956,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8067,7 +8071,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8082,11 +8086,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -8613,7 +8617,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -8734,7 +8737,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -8797,7 +8800,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -8805,7 +8808,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -8962,43 +8965,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9016,20 +8990,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9038,17 +8998,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9056,11 +9005,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9068,13 +9012,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9101,15 +9038,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -9127,39 +9055,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -9200,6 +9151,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -9225,1867 +9177,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -11228,6 +9366,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -11244,24 +9391,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -11309,22 +9438,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.3.0 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -11360,20 +9473,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 097963 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9T5R43 - pspReference: 993617894965500A - resultCode: Authorised post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -11394,20 +9493,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '024236' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9T01IN - pspReference: 993617894945494B - resultCode: Authorised post-payments-card-direct: summary: Make a card payment value: @@ -11424,36 +9509,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 048531 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9T2PF5 - pspReference: 993617894954499J - resultCode: Authorised post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -11515,23 +9571,6 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: 022966 - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9T0BB6 - pspReference: 993617894947495G - resultCode: Authorised post-payments-giropay: summary: Make a giropay payment value: @@ -11543,17 +9582,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgBdNcOUwhrokraZtM/nJSduq+zXt1Hub2wGGxDvL/j8D63+t+oTWtpsKPus73V1DRhbeEsPDRc6MTCmNRFNlYzRB9+Qmedoot2ccLZvIeIp9JFNURi4eLi70MEjNsT0Me1nkbkkP8btIWrk5UzulQbYCPHUurWCXgIG84Nc5/SQH7t3cpVLWiZeuXDKTUiwFjOP05jgS96jWzZ9w8WYla+tJyOST94mC246dlveWuQCDb70MxoPVi9BcVdppUBtaIXPIXYAa4YbxLAHyi3lw5STnhI0y8/k3tc+dBAFL+vezYDWLZ8czUdl/uqDzsPEe/ewz6TyS9vXZvZOAjcJhJ4wDRwZ5AFQBRBNwSANMswOBXCyh/jJsp9ycJSAT+ahWmSWKaU4oe1jlWBmQ8rxnQNOSWkV9/ZpLsrN36eLCPo6VgQnNKhWx5zkkR5xMS0pVx+Ff7ZdFeKtl0Trc4OyON8lBHTFNd7Pyhl74C21dlZUNGxA5gIc1xNXNFOvCNJQvyO9sR2giM1dEAKXpOm7Ez2u7eDvlpQa2zwPxulu3vQ2xSDVmqboSPx6Wp7ywyiYIIJzUwphVu3IulMjWnmHQOTYatiO9l1O50tqepaFB3/mwdesPw1cJD6UYq+v8kshrYya4w4ojMmQy++0L8UxUBHis71ftJM+nIhXZBpJ3cXtehBMZx+06hofQjgUgsuP+rKKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffpA9iAv0lzUkDkBzjQG0XzMpxNd9Z7Jl1zf68QhTbJ53cSWhqs9FLu4XbuwyQ3ie/rNaLX7uypr+FmxHIZgehW2wSS0XKs7qp6b6z9OiTbZgcUEVtsyZ/Il3HrI+PZnavI3MB//BC5kjX/KE56BEIytAmQIovNHW7i+4YRVCjpNKAuBLr/DcSkLSqTb7HwV51btGbyhB9NwwSqO2rHUwjl+2WScEkbd5b+EUxc0jN7gdc4mu96Ak9ATN/2J/AHoiEdXDaZRkOBU6fSYOEQKpXw1UW9SOJdUji1+T7b8uVuC6gXAzS+wUXkA4ZsvW9UM5yyhaF6UgF3jY700Ufme7r98pjdBydAGGWSNVu9BdZmzDEiUke0eL2k7rYv2IfxtVvyacVNKnYmwmPpWRqvxQF+PJN2KqcVEWbNal5fleujujNZ6LACeSO5a5eREJ6bmdyKR82So08hMEwV9Ky+Sb1REXAMXY3o/FvwzN4HwHNaqi2pYNw37JkLEQTEIeWntLyC+pvc1cVhILipMx2bbBCx/CijEFGJSxVzma1mhv5Q+RJ8XtaqyzJoFOkoIoy63cq6IVYHEy47vgCfKjdnK8jDFfOU4ONDjaTb01vJYwF3XnWxNFspb7oq2ZMbmBtLDGkERkMmcrZV4XIhzF3uhbo8PEjrFhjMepOT/gB1/Tq5XkUAIViviWYaFgGByHjwzFPufEdu4ycZiG5KC0MFJ6Y+T6YrF++U9FRmeJpbdfF2oOM5Rc4jqg90YI3fi7FeKY125Dnl/uGKJhI07uaf5SRt9R3xwJJgUsGadj/AL - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmQ*AuTBD0lKr9ylvSsHVa8vlWs2gBpsYhsU8utv4XJRVVWy1tbMandm12*KiXIrS6BVo2THRpv3SoHg4wwmRWa3oHjNhFlzLnthaA7a3F*wK5kKA5VippHCMWMHdHuXbH-8LPLXb8lDkqXbLzMHUBpvGpArncEepv5AtVGNqD4QplfihhlGVys3dKN4FayCIPSXyTXnd1PR3aPl3W6qh-bIwH0*RUXH63W2yZsz33VPskh1anmbF7L-k*mkfLT8Gxttt4AG29mfSwixFegi29HamM7y11gRz0FydqilNojEJCYI8Rr4u*yNrmXXgUJEgxoaDhqfv-6VTQWXLTrJoGwUcIPM4P4vd8m5B1PL0vJvPw0b1X0ct*WFah4DakNqUoeNlpPA5SQRwyh7tcCGHROjg-cMOo5ja9DTrJ-YoSkbM1KPeO6CBAsS526IjtwlhiB4sS9epj0pxqc90QQLTcrA1u*NmH9G1785g*dcVhGFURS5sR8453R49vPvYRkPY*LV69MrL*v6VJC0OO*D4*6Y3O2SCsaylH8BlM7anA post-payments-ideal: summary: Make an iDEAL payment value: @@ -11566,17 +9594,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ= - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s post-payments-klarna: summary: Make a Klarna payment value: @@ -11684,17 +9701,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCrbmh+OQiaXUY3sofxY5aXEujSd/zIwdZ/zDiV440FsfTI6tfDuXPzi9jOQgmGr5UFM7mnTNjHY5fwFD9FmKQre5ewthnSTsBVmC0RxupWRh7OeHYCcLp+G8+vxR680uJwp1stzdzq/lXmyIinV6aC22NzapolomfBvxS3cANwHE4IC65sXt5eyzItZbHIxJqMC7ADM/dX9Qw9HolgxLQXZlmjdHjfEHEmTvvPHXe5cBv4cfKPJ2gp+RH1J4hds1BJxKwobazQ+a/fauTj5N0a2uotli9I+06B5Y9fR8+SFyOIT3X2jHVDrGMMiVTjBSVDYB6/76A6q6GPXUv3cPgLBRdYOxKJewp5o7raTYs39Tp69iZTPF/9+E9TvmSIjcc5yekrt3kUUxnJTITAN5EJa2AnmfdJBro7O5c0C4OQ43MIgMhiMUKzBewWb5rDzfDiUCQKkSdWEbJUWDEZSS3TPChvP6smI8m80rbgig/0IXgt7Zc2UT1GLdai0t30AoX0gcnbZJnS+4o07WivKPI9aagD68dYJZy3VN64p7Q84vzj4IzwftzKW3lWDf2gt6Reo3x4Sgo2KzznEfCeSRB3QtK8Tuk5ibgVgjkCx2p7KaxKtj1Mqdi+DgA63sM4juy2IAf/23TA4fu42OWovbF9DmXf4v8aSvLmCw3NYX0VyxBEf4xCIC8T14KfCMGbP4N9AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYDX5Nt00CX5QJ7OLRtmg5wXbL8+ctpyuEOjPJt2DpH30H0klwHPxbTfbVgctpO7GFGrUgl+mqy/pTDTlfKGmt2SRWGbo9cDMbUTrcKNh2MiEI7yOroy4iL/DYnvqbqQ3kQTjxtYtyM7qKI5/NbPotypE2Z6UlscFJnMYaaZCXenBnXU7e52p4tk1hQ5KkdZTbkjdZvNkEL7yGvoVgBNRPmTr7fZJib0XPyrAK76VL5yBq0A3mcwSMChj2Uu0ri7lp/g4yO1JNljWTxtEwaTCxGOY3tDF3IqnqELIHtZ3hyqG1n80muT4wVUX6kmCc5zeHybbZTJhPG2Q+fPAqvNXA0y4Zg3JOC51gGRhmN3m7L3eil3ks70Ejx6gpNzLnLZWpzZy/tff7coZGYW1Xo3973NOJcDkEA1QjhKiPycsHy3ZHZ04ShINLc2UssmV0o68FQ0R6sOVbjOevBaK27EySDaZfQnUjDSfgJdtIFDIEVzZtVyUWGo6w+cYLUYZCpeE9VQac1DinR/NH3w5nqHKyTBf9YqoqYZh3CuOA4jGbwadiG1HhAmZg6TOY7GZ+91hB1yOs4fsDfR42Rj6MEWOaqoH/yggwtjdNhdyeSIc0z3vfjsWJCLy4Uy0haQ7ww+81mqalJBILsTJuS3cwpuGuai68o4ApraA/8sXd+wJ7HBuCqaqJ1r9ZdPppgK+9QbZzGA8xvc5IzHqyOgPZ9oRCTbYOmENJO1grH15TyBHBB7N1Eu/76ojkCsdDEK/hu69T/jLin+x7X+aNuWVILJ4Je8HOdI8ddtr79R6WX88cU= - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmS*4YGHXEpbemmvR6CK8lIZs8UoiU1sg0J*-RmaS6vTSchGM6vdmVlXArN6xWtI6lYAUWmF2b5ljUl6IYCRcebSMjePIAjFTC0J4T1TSQFSPV*xG5kxBY3AquXMUmMHyeoxXf38VRbvD*lLmmer-1YOIKS*Ew-d6Bw*YJoPiVRi0vNFqF6wO6xwEsd2YIdR7MV*HLjx061m0zZJ1W2bTf7juHfbZVFc3i77cdfsthuPxg8HStH51XupTvn5d1ca7p3Z4fEI2txx9mYjhEwBsszXCVWqM9yl4dzr78AJPlAulUYiFCENEQpkz3slKe86EBqRIIaWgNS-r59tM0b4UbvI4TNlzQz233bXmmdQlNeGe-9P0Frd96gNJxBzBFqbpiZ1epA-CfQnifoYeS8WemCH2WjpewYtyzIlyCnnN3xo61aNiYMce4G8BYoKO9CObF8ffrwzr16mHQlMph0lqW40KQNT6vcxv4qur6zBsa5rCIMwDO3I9axLNmzd4imoo2FMHbo8v5Oa0nOJsvLy4Z3Wp-RxnTYw1jX-A42b3RY post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index e5b05370..c1859b1a 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1023,24 +1045,24 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1051,8 +1073,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1060,8 +1082,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1069,8 +1091,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1078,8 +1100,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1090,13 +1112,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1141,8 +1165,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1150,8 +1174,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1159,8 +1183,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1168,8 +1192,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1180,13 +1204,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1223,8 +1249,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1232,8 +1258,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1241,8 +1267,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1250,8 +1276,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1262,13 +1288,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1327,8 +1355,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1336,8 +1364,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1345,8 +1373,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1354,8 +1382,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1366,13 +1394,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1434,8 +1464,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1443,8 +1473,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1452,8 +1482,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1461,8 +1491,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1473,13 +1503,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1537,8 +1569,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1546,8 +1578,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1555,8 +1587,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1564,8 +1596,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1576,13 +1608,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1640,8 +1674,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1649,8 +1683,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1658,8 +1692,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1667,8 +1701,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1679,13 +1713,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1744,8 +1780,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1753,8 +1789,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1762,8 +1798,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1771,8 +1807,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1783,8 +1819,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2522,6 +2558,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2995,19 +3039,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3233,68 +3264,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3623,7 +3592,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3662,7 +3631,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3705,41 +3674,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3935,7 +3904,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3980,12 +3949,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4001,13 +3970,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4021,7 +3990,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4032,7 +4001,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4043,12 +4012,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4058,7 +4027,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4073,14 +4042,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4112,7 +4081,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4206,12 +4175,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4227,11 +4196,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4239,30 +4208,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4478,7 +4449,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4519,7 +4490,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4540,7 +4511,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -4676,7 +4647,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -4834,7 +4805,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5319,14 +5290,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -5905,7 +5868,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -5921,7 +5884,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -5959,7 +5922,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6013,7 +5976,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6076,7 +6039,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6257,7 +6220,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6273,7 +6236,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6306,7 +6269,7 @@ components: the transaction. type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6317,8 +6280,10 @@ components: > This field is required for recurring payments.' type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6382,7 +6347,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6420,12 +6385,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6441,7 +6406,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6466,7 +6431,7 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' countryCode: @@ -6478,7 +6443,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -6492,7 +6457,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -6503,29 +6468,29 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -6537,17 +6502,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6555,7 +6520,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -6565,7 +6530,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -6580,14 +6545,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -6617,7 +6582,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -6678,7 +6643,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -6695,12 +6660,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -6797,12 +6762,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -6818,11 +6783,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -6830,23 +6795,25 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -6876,7 +6843,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -6927,7 +6894,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6978,7 +6945,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7037,7 +7004,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7053,12 +7020,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7066,7 +7033,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7077,7 +7044,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7102,7 +7069,7 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: @@ -7117,7 +7084,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7131,7 +7098,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7142,23 +7109,23 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7170,17 +7137,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7188,7 +7155,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7198,7 +7165,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7213,7 +7180,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7287,7 +7254,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7347,12 +7314,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7368,11 +7335,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7380,13 +7347,15 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string token: @@ -7396,7 +7365,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7475,7 +7444,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7595,18 +7564,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -7690,6 +7659,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8002,6 +7974,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8085,7 +8089,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8100,11 +8104,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -8631,7 +8635,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -8752,7 +8755,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -8841,7 +8844,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -8849,7 +8852,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9006,43 +9009,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9060,20 +9034,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9082,17 +9042,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9100,11 +9049,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9112,13 +9056,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9145,15 +9082,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -9171,39 +9099,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -9244,6 +9195,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -9269,1867 +9221,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -11272,6 +9410,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -11288,24 +9435,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -11353,22 +9482,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -11424,20 +9537,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: '044410' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9TI1O2 - pspReference: 993617895005515H - resultCode: Authorised post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -11458,20 +9557,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 089261 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9TJ8Q6 - pspReference: 993617895009516B - resultCode: Authorised post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -11492,20 +9577,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: 037284 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9TD5G3 - pspReference: 993617894989510B - resultCode: Authorised post-payments-card-direct: summary: Make a card payment value: @@ -11522,36 +9593,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 034933 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9TEMAE - pspReference: 993617894994515D - resultCode: Authorised post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -11625,23 +9667,6 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: 021498 - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9TDF8I - pspReference: 993617894990511G - resultCode: Authorised post-payments-giropay: summary: Make a giropay payment value: @@ -11653,17 +9678,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCthN9/C4DNJMIhc+OqEtrOCtaSH2tFqeA5EC5R5qO7VGZzu21y8wnBMCEyfdOfLaVP96bpaif/3MZ9YM48N6HgYZ/6KIATkt/UOUjS9wIOnGIT8pxqh47FSjCOqmVQhWV7p+gB+w2Liyifl7gBCzmcewgp+NDMAHRB/RQKMzXkBT1B6Jv5DjHCVciK33seD0mxJdZ8xKzYr+BaU6OfKw/pm49D+Q7qCH6zjlTq5pdb137C/y4Eq+gglXZUYFblOFbP897GRlIWu5S2wOnKS1zp2pXVKH4dGu79a34ji1IJFLwUfRLfsojvjU2J5Q8PrwbSUT1Rgk+mklImuPH8t6dXO2nBk/Jky3w2JxrXIioovSlz2+slT28di1hsVUeDAnv9yKWagsqYvvUrS9MDoqO1xfsy62VlEEJTY/MCzqtq49nv0cUHoEKQ0xZF4r8bbXCfhV3/ZINynnRxXWrK5YOFE/ILVJWiEhq+95nqRIxu0Tc2cUEM4P0f6IskIVGqgF+AzqvQQzCgEBJiAbf/paGHeqMz0RX5VCPBq6kFt1Urhx0viuWPAo2c9epK2Wik8y3Q914UjMrtJtuuk41/hI7of7Wd8/zNshHf0gn8h+KH69bS2jZyo2ZtW9hteqBiYtHJlqDl/vO2D6Z+0WHB1ffUkI5Canw2JAUc5wwq3l5mZBDAVDRdCyZlexvkU2tZXkDHAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMife0UnvTuC0KkmKfgI1TES6l5nFhuOPE4VSwvurNlNe9CpZh7tTf2Hv2sS2POMgmoU43DvnOK8tSFYGqbtd2GHtBQJvxOlS5pc/2kreFfccgsd24Y9agn4XmeRdeRvk9FL4v+iB3an850gsOOXiHibuVTVCeZ1A7EZZFPm5ei2sDikUNsKdv12UZGEAggA1O548RtUFRopbDRpWvheSbz7lhsnDw5r6YO4NgKycoLtNho5TVHd7iQ4hK7bOclgyUU8CdGEo3LExOieBEt4zGahgKPMBuJPhNSmI5vIuz9BxdUMIGsTB5jhtHAGltJkqxjdQJTNE1i6/a2ZajgT/9GqRWZ7AFsxok7nvBv4qO7oss0grUiZDh+h4DxwK6wQ3A2smyuHKsRpqB/wcWjab2Y/NSyMhVe7ub4hiK7tyXCxU41HcPko6twA65ntb6RZgxzTykYZNPR5ZUh/MEorfpLVJ7OWB93NLk3aAH0whcpAEi4A6tMRdixVZLpXb2CTkeY+czRI3q49FOzTDHNr+SNzn8U73E3ILb5vn5OnDLjfCpU2MHHP2AyO0dbYPJZWNaEvGbhqzC3VdyXgeHjNdBoN5cWBZh+KeZobkmn6+PYreIWtgozSV8k5lUvOEJDIwk+jbdIelOfy07LkWdkNz8yhWqmoCagt5H+FlT/uLx59zcIp9nYJ1FFWI2OZ3D7oN3i3wTlqQDn2Zzm+dwGI6drzDeeapHrWE47zyzWrnI1nHG8PbJcldsrXcNQn6OqL4P/8YPF5/z1UW+QPLWEtM4rS8o8OD1IMULDC4ibIw== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUstu2zAQ-BrrZoF6RI*DDoatJHKdxlGtpPElkMm1SNgiFZJSw3x9KdU1gqIAsSRmFrszuzzImpOlIJA1TIquNg7upQSOzQTmVem0IDGtuV5gLHqusx0o-XDBrmTBNTSy1kxwV5sOsuV9vvz2WO3e7vLveVks-5s5gFT2zkLvSpdwhLE-ZEpLxpsvhO4lX9W6ztLUi7w4ScM0SaMIra85P1iT3b2*7reHhKw8MOvweDRh*vjCf8WE7bV5SrZNu6Hr6ml1KvJZsHKs5RasuXby5iGEHAmqKjcZ1bqbBYuZf2vPWeD6TIXSFklQgiyEKeCT6LWioutAWkSBHBgGZZ-bP2ULjkVrXZRAmASsLTN4f8tdch5AU0Fmwe0-g7bqvo565kdyGoHVZqlRnW10Mwq8GSXaYEQv57ZhV3Pj2nsCXdd1FKhxzs-1mRGmTeYj35ujcI6SnRdZR1Pw071z8TLuSNZ43FGW20KjMnDUifHpV3T9wR1897KGOIrj2EuC0P0shp-Bbh2RZDC5Txcfb5hQ*lGhovo8hu*b9-x*kzdgCBG-Acrp2a0 post-payments-googlepay: summary: Make a Google Pay payment value: @@ -11688,17 +9702,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCNzlrqgBh3IfW+KEiI5mSYZyYhC4qmvk6ChrTHxEPRFGTYu/8zQz741YsRCVG5LZ+UkffzhZICh3v1yZE7CDOd/xcQgHMW/nExCEG9aGuWwrLYAI/mUKsD3l/NcTS+KbHExyc56HiWWvS9wjcceKx+l6vb8H7JYtRQdRy2dHktwqpigZrwjnbNcNCWpozyVpJe/DT5eNowle4OoT4ii9EbEwFvCIRT9bbob7O5Jdy68nd90XmStFMshZL3MVNeuFATrSyWuoAgMSJkfy0N/SvUlv9kWJxMvmFcPDTcR1uYRE7ugC5iwLZJuBF+zDb1h5tWK2XcBkK70TvzmLFrFsDn9NTeBwN0SmiPFOdxGVcEjEMQDK2yuGzUMOsIyvKhSFJmS3FVGujztxngvVA0XTcV3mVfh4JSKc+8t5i/ddV1f15wcYQmS7WBJPQAY2junKZOWZSMi7Dx5ViPS61OLhkrTcyS6PKsY4s7mohU5qEdiHqF8WRfdNag/5FRGGexCYGf2ewouGKduFtrftnUtQ410jN/TGYI/QS2Ay6eFpGXwH4WZEf2xpUXjHJnpQlPCQ7UwJUVCJYGd7mONUJ6MGJGw9CV4NF0nvx82hKdshDYfIzSWP+HIdBA92XZiqaQijbiTKSEduuf/0uBJ2aJM5k47btuc1aLAZQlrDS4dWLmFBAJANATc3sWIaOKbr/5X8Y7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifV/rgRI3Jh1fp9Tm3HFJWBK2LFjzVvFPHkJA6jPys0NuLLgzjEsTretHY+dBKZzr5WDJg8wtZz7j2BSgWAggzv9G32BQxasKiRIO0O14LPLpT3EAr07kVPOs2xTu5URyrImVSTQN+IG/uVuWhiaz6U9eqZkQq5OhSOMpsHah1ZaMRRE8S69RwZFYnak7YnjAj2SQ+epRLrq3PN4ixU7M0RZakUWHsqclQgHCxsqqE8jlfmV8YLcO5aNXgZVnq5rqWc3Pvg6dce5B4RoUKO4ZFcyW+25mnQtRGiwEF88UObsy2MgKboA7+PYoS/M1nmAPmKq/f8cUOxuYnBxBBu82Hgz5AJhPiTuH5jxLK2iN8yv6U3Dh4KqRHa1/sornSTtMjNhyySieOwK0o/lheD17m2+aV4b0Notnfgce9MTb7Jg6cbr0b7iiUMV6k+cSQcN/gVtwZ7AxxEwZPhARhu42oEFNArmCzB1y8tnAFVx9TY3DH923Bv0sXg8/a+cjdBeZ6ukctpyMivHI3colbqRR5fIQQ4DCrbWHuQY/2JZLgcfd5vPff3X/isV4EWCWHJItvGTqkKLneb2He82KQuqcrRgXY6R3RPVtYaeWuiJSiRdsUWnPe5lkGXDaL7y706hAbDkeY/8CmuBNkfZKal+iSpVEwmntzWsM1jdjaYOuSqmD96ht8y92BCYq+qA/hjsbjs+TDiAmS6pd+k6o1VlVkc4Kyz9kQbrZc5nAtgTaKj+O0H9uQOGj2jPW4t8cBVFnzwB6GVuXDS5nFJCeb4kavw/paKRht4s= - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUlFvmzAQ-jXhLcgGCuTBD4zSlibtJhqmaC*VY1-BSrCpbVjpr59hWVdNk6y703enu**781FTyXPFgQgO9OyxQWuQbFqgoq48YcwAuuQE4wB7HWjWUmkzxtQgLdmDsQ8X7CNZSguNplYo6dupB5LfFfn2a71-vi0ei6rM-1s5gjbOk*jvlApeYGYDxFgtZPMpYQctr6mlZLPBMU7STTQHcZB91DyJhpTNz6nP1GG74Wle6afb9MDvt9svp*hxd2zjoxhyxOKuiGOzCq*9nk4dOHHdog0jhDwNpq52pLW2X4XZKrhx76wYPbfKWIekKEUOYi2wkxqsaVXfg3aIAT0KBsaF3363LSVTnVNRARcamHWZEf9pd6l5ANsqvgpv-lm0Y-d51asg1ssKHDeXmtm5QVczwauZojOTGvTaDeypnHznF9D3fc*Amff8nZ4FF3YiAQrwGkVrlO5x7BQtJsQ-vIuW*UaasvlGpHCNZmbgmZOQyx-ph6M-Bv7lDEmcJAlOw8h-L8dDuL*PeTpORdBmb8*Mt*1bjcr6-SV63b0Wd7uigYlz9QutjNyJ post-payments-klarna: summary: Make a Klarna payment value: @@ -11806,17 +9809,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgAvIvdVPQD6ljxrC66+FwR0FaxDspHFSr4AyJU3Ceh7lGVk4YaklDVlkXziS1wmSkEIHV90bRQt9tggc/UH1Z9m0uzmx4ZqPdNYCd2I7/l+w0Hstk9/Q5nPTqF/NJUqBPOULOROo2fQRQk9e1Nwlk+hkF5+FBPbX+qfXbIjX2GGc7h/rHXEZJEwWe1gz6Cca3Kq0eDp/lY9zA99MnI1qpZxw73trRe4OgSYXw36kyUiUb4ik197gvekCdd7cjwDzP7ZiHAp+qPKDJPzjjNQNAN/+RWdMva4KdOkycUA7W18L6b5PCk8kddUU5eKQtFMzNoqBPhVvBcPkrsPPPVj0Z8n6bzT6vFdJu2/SDM6Xj+mx1G358d2SkKS0Q/cILxt4pfCVFTFWF6zy4sirG5Pc7Vo/KIUyZxAFV7Ud539NaRVNCYY65KDRXK/ANIcvQSxp0tqGUYzsvAqmp4KQ1MlfZzcxA2JtR4MdAa3SSc8D8q7PdgPVsPCTgN/TbfPQxDalOgY4zJAVoVre8GlvPd7qKjU4Ct6q1qoqcf3mQqYrbTWvLTLDlpHu/btAJrbh9aVKc7JRGM5xaGWPAkclGz7Zsbb/WIXL7i38e/icf0/oWtwXtDsmBUZcgDD+I+8zUW9+3iTeJtXzPjJtlLoJiTWCePpO2r149fwG+xxLi52d69cwxDF6d4B/LTFEjDsyVmmmpP7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQmQ7pxA13nYmt54YOm1sEPteTnbdkD6S06nPPQp5kpNdnJrkdFdZ2SsnXIHDNk96S7mt248VYMOpL/y+GAQEw2PBYXRAUMEm3737bnbPmro9cICPuj6plkXLkQs3ZFchEQOyrNIoG0z5u1N48bDie8mnb9p8jpTNw4wxfQpN0sINQ3dqu1+Wt1imG49AjvP+7yEJ4Nv8DDpXwZ6A6wQZnZYuP/XTcbsIw9aJxRZpqyp7nLsDry0pPCkMXfdF87GYYo3xzmy4HdhhbEh2jXZUwbEVW6onalQu4StL0OJjr1WM7XwG/SmHEfZMvjSvUcCEPT3FcXCGA8vaDkyqD4dS+16qlfkG+t4YWf32OVFCSlLDie0BdeMoEePXCkU63qWCY8qGde4NVjoZCt68HyOdYhOZ3QL7ssBYfiCOBYWDnrPUK4sXxBaToEt0Cf+xHnCfJ0CklxMXsh3hEhKLyCbO53uB0T/eYaKEqw1SnoMECNSnkA+Qk7LVfrDZTnFO9c7op/wr1bTjSW0r7eQQhiuLGwwmGSGiueKB0FPt5VVUfmSXMW6s9KRqYFUEjDyKv9g+/ZaiRIS+4L7P7YWuQu+Lo0BvvMPxi2EbCfPTv7wRsZp71mSnJd1Igpjip9itzeF+ZteWFkmvMrVT8TQmxl5AvcAAnyz7yBXgH5sVGV9Up+Eu/XJ/KkzF6X60hcFk0eMLCFA/tr4ejMoSS7Wr54euCmlP7sy1Fv16SZtZkaO/Hp2EaCOIZKhIHOiVEV8tcq9+LZIcYvKVf47F52/nAjc/l+8+dwA83957v8WXhQ= - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmS*yYMfUEJS2vRy5cLpdC*VY28BJdjENlzpr6*huVxVnYRsNLPanZn1URLOVoIBZo0EqrMj4aeGVzbtpQROx5nLysJuQdKacJ1SKnqu8QGUfrxiNzLnGipJdCO4o8cO8OouWz3sy8PzNvuWFfnqv5UDSGVuHLg3uoAXmOYDVlpOev4Rupd8TTTBy6UbuXGyDBEKoijc3Gp*NBXeNvs*TNb7P6d9pZ7YWQTb2CUrkXX8-qFPL22aRE9BeFHHk*Wv7Y6MLRhz7ezNRQjZElRZ7HCtdWf5qeVtzHcWlJxrobRBEpQgA9Ea6En0WtWi60AaRIEcGgrK-H7-aJtzKlrjooCPlA0zuH-bXWseQdeCWf7mS9BG3eeoLS*ScwRGm6EmdWZQOAkMJ4nmGEUvF2ZgR-jomHsGHcexFagp55-k3LBGj9hDnrtAwQIlBzcyjuYjCH7bVy-TjiSh045wZhpNysBW5n3Mr6Lrj87gOdc1xFEcx27iB85bPvzyD-cRS4Yx8*r09Zmyun4tUV6*vQSX3SW722UVjIyJdwEe3Bg post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 252b03f8..e70475d9 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1023,24 +1045,24 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1051,8 +1073,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1060,8 +1082,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1069,8 +1091,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1078,8 +1100,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1090,13 +1112,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1141,8 +1165,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1150,8 +1174,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1159,8 +1183,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1168,8 +1192,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1180,13 +1204,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1223,8 +1249,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1232,8 +1258,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1241,8 +1267,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1250,8 +1276,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1262,13 +1288,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1327,8 +1355,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1336,8 +1364,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1345,8 +1373,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1354,8 +1382,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1366,13 +1394,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1434,8 +1464,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1443,8 +1473,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1452,8 +1482,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1461,8 +1491,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1473,13 +1503,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1537,8 +1569,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1546,8 +1578,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1555,8 +1587,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1564,8 +1596,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1576,13 +1608,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1640,8 +1674,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1649,8 +1683,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1658,8 +1692,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1667,8 +1701,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1679,13 +1713,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1744,8 +1780,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1753,8 +1789,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1762,8 +1798,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1771,8 +1807,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1783,8 +1819,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2522,6 +2558,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2995,19 +3039,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3233,68 +3264,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3623,7 +3592,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3662,7 +3631,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3705,41 +3674,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3935,7 +3904,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3980,12 +3949,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4001,13 +3970,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4021,7 +3990,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4032,7 +4001,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4043,12 +4012,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4058,7 +4027,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4073,14 +4042,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4112,7 +4081,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4206,12 +4175,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4227,11 +4196,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4239,30 +4208,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4478,7 +4449,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4519,7 +4490,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4540,7 +4511,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -4676,7 +4647,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -4834,7 +4805,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5319,14 +5290,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -5905,7 +5868,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -5921,7 +5884,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -5959,7 +5922,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6013,7 +5976,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6076,7 +6039,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6257,7 +6220,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6273,7 +6236,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6306,7 +6269,7 @@ components: the transaction. type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6317,8 +6280,10 @@ components: > This field is required for recurring payments.' type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6382,7 +6347,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6420,12 +6385,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6441,7 +6406,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6466,7 +6431,7 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' countryCode: @@ -6478,7 +6443,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -6492,7 +6457,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -6503,29 +6468,29 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -6537,17 +6502,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6555,7 +6520,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -6565,7 +6530,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -6580,14 +6545,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -6617,7 +6582,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -6678,7 +6643,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -6695,12 +6660,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -6797,12 +6762,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -6818,11 +6783,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -6830,23 +6795,25 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -6876,7 +6843,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -6927,7 +6894,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6978,7 +6945,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7037,7 +7004,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7053,12 +7020,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7066,7 +7033,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7077,7 +7044,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7102,7 +7069,7 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: @@ -7117,7 +7084,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7131,7 +7098,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7142,23 +7109,23 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7170,17 +7137,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7188,7 +7155,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7198,7 +7165,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7213,7 +7180,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7287,7 +7254,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7347,12 +7314,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7368,11 +7335,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7380,13 +7347,15 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string token: @@ -7396,7 +7365,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7475,7 +7444,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7595,18 +7564,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -7690,6 +7659,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8002,6 +7974,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8085,7 +8089,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8100,11 +8104,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -8427,7 +8431,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -8639,7 +8643,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -8760,7 +8763,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -8849,7 +8852,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -8857,7 +8860,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9014,43 +9017,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9068,20 +9042,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9090,17 +9050,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9108,11 +9057,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9120,13 +9064,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9153,15 +9090,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -9179,39 +9107,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -9252,6 +9203,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -9277,1867 +9229,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -11280,6 +9418,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -11296,24 +9443,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -11361,22 +9490,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -11433,20 +9546,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: 028422 - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9U0CNK - pspReference: 993617895052526G - resultCode: Authorised post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -11467,20 +9566,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 035999 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9U1A11 - pspReference: 993617895055527B - resultCode: Authorised post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -11501,20 +9586,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '001656' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9TSNHF - pspReference: 993617895036522G - resultCode: Authorised post-payments-card-direct: summary: Make a card payment value: @@ -11531,36 +9602,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 001872 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9TVP6M - pspReference: 993617895050524D - resultCode: Authorised post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -11634,23 +9676,6 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: 028065 - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9TURT2 - pspReference: 993617895046522E - resultCode: Authorised post-payments-giropay: summary: Make a giropay payment value: @@ -11662,17 +9687,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCnd3nrbhA7SggOHNrkA+kmUK+Inw+iAv3kN5PGTwb3PVrpo/Qjp2xTh0HGwViCU1Rd+7jnTO+KcKQJw8vKrVu0DkOajmAOKP/4RgE2q4VBZfjtLyPAUSRdkzAEn3JR09jjRmIoeI+dYN5l8HP8cMoUBklJ+bHAmC++c/hdTB8d3JIAttj7qrjR0/MYt90SW4Ncbdy09fxwn16FqDzFkHK60be0oUXIoe9MHeeuadibcDT5yi26L3jAhjk+L7j6nk49UmYXk+7/iRJp7AufX9cXecr1MuaJPD7eMw8eK6lotHiQfvu0P0O5TEqoX0pZERJUat49K0qUESUjqoYvQU24Hss1yA5NLulBzRExOuH4DjJGJYBP74hHDCwy78pO58+dahMp2Pfwt/HQaE/X/THmSm6kjVE+gstURYuk4wcbG6WaE5x63f77xvBD6gabCpgc9kxK5twspn8tfgu10EJuoDfSDPE/TgM752u1j0X1PLOtddIzVKdbzrjGLb0SgXp2k6JMcmVIyJQbkyl3c50zK4tW6TV+pTaPjB9tsbIXjZ7f89I9eb7xYB9koOKwx7rEz+RSytPfABUToIyFTs34G/7mVvz84WD98H9PTAbJayGST8+6NoXQie9ILo7DF5Qa7/BitURng0RataHwdckxRlq++HsR6jwisuqd/mu1eBD9dOxH/pkQDL2lNNABl6uZAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifT4RAUv3gmWaOf8wZ5jZ/GcdmZDC2IUb9oFmkx3HlArQhey9K60AaGwGA5dYeG54MXcIvslrfnaiTG1NswXPMMVTplyazDl3Z/PzjvS77WEyUpVSC+R0O4krlCvE4ZEEbVXN1ukMaIq/W5FQGlYYCz41DKi41At5ACSy/nBCoNC0wpYy+lJgfxiNhhUmQC1U86a3PXLBkuxsynQFySHJ7yJffasHs6TDV7Y4hmhjN2jz8ezpik8ZCWz8Fc05rWfpLzU5lxaXrjy/xcG765nEcG9pv0H6nslcGdTbU+JKEDJ8ZXw8USAlpHF9zvHnTPfn/u69VdcwQDiVLJoymIllVamJzNPrP96vCnV9MYXFWt5RMTmjXVptZDLFCQrwKH6nbqZ5f4r0q5JaE0bbhVMN1mrvaxblLj6Eu/XWoZUgGwWkMSnJWLqNckzhdMzKZ049aflCklUWY2rTvI8x/2etdne0EXU2flQJSXBICut/3LzyN69/Kd3X93jicdq41yXT2D8StfiFnM11QVnAr8Vtz9geCMsTW/hYI3UAFllfdGmoWnasa4NKTPMOGEamxu5EevrkiI1KX1hV48otTawDy3cfXwWBjh3BlL9iJhExAFF51y9D8T1bd0+U+s3uXnJscvgvl2xq1Re4A5lMcOe6jCJTy2xnqV8/cKpy/TV2z6MFpQW19vYZpJQeJ9wDc6UAbntxpOlTQ4puksN+fiexxUM7EeDyIxnT0JnMTql5Yq3iw0Wn1GTEe7WB9EbytFscI+dmc9yWrad4MLA3m8LG0ZKDPacqt/+pucBJyMg= - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUttuozAQ-Rp4CzJ38sADSmnCNtmuKGQvL5VrJsAm2NQ2qPTrO7DZqFqtZNnWOeOZc2b8IimvNqKCuG6l6OlkskFK4GxawLTMzQ4kayjXCWNi4DouQOnDFbuRGddQS6pbwS099RBvdunm4bEsnrfp1zTPNv*NHEEqPGMvuNE5nGCuD7HSsuX1J0IPkt9RTeP12g7sMFr7xPWCyEtuMU9tHRe78zE3nPvfh5-q*3ZXquz45B8dRLpH-yHanhMOVKmkDBNPnjzDvTPRdgdosFv82YQQU4Iq833caN0bboKPcV0Eo5dGKI1IRCKCEGuAncWgVSP6HiQiCuTYMlB4-fYnbcaZ6NBJDlUrgWlkRvtvumvMAXQjKsO9-6fZqO5zuw0nkEsbUBtSszos5M8C-VkibpMY5AoL9pRPFp4LaFmWqUDNvT7SS1u1eood4tgr4q1IVNgBOrLDefN*mVcv85wkZfOc4hQTzcrAVOeWLz*jH16s0bGuowiDMAztyPWs92z84RZfgioap9RpkrdnVjXNW0my8v3kve5f090*rWGqKvEBGEjZqA post-payments-googlepay: summary: Make a Google Pay payment value: @@ -11697,17 +9711,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB6BPOuzRMSzFbUouPQm0rkDcsOz/ShiXL+9a/G8SHUvIJGDRCPSuZsQkEMf56P3cGm/3FyB0C5J2SRcc1uTDrRMhagQoNpoTqTpBikufYTwHBx2jub+FpxZz6m0GKu05f2stJAS86Wq8FWH9QWjOyHt4UDsn4E+hlZiL5wus1caD8G+0qOrTS+wBOpigunCv/y1vqjLDGG442BAsZKCxVHyYGc8UIRDsXcA25w8knzNDGTUsNnqC2ixtWICjpV48u5jrbZ32MG6Mpr5eH8RkidYRgs+P8Bz49HYs+vEKIqORrBQvxR0D2qOaIXDPD+OIZ7MLUmUKhoco4mXDNvz6+06Bx6Xz/8hoTheBtyF+UA6f/oNywvPdy0J/vkTVDH+m/M89TtlygK6A7dxIOu8i07CpqRXsUNE1v+XTJFwroGC8kBu9Un+1biigP+UwPiiCh//GHZcXYVBVtNY95IyQGSza5fTAc+cbR5VAB0G6yfeun/yEwnK203ozs6j2IRizVbY2BW4BGIRIVg7aXmJR7c+jEOcWhQcPkmuk+n6CDzr5KUeNqKhwwXhXQ44ps76cH3ri7JhiSdXRJCWsr7WRVe2ceyxFHzzJVvwpxmA8J6e3rxqztCE3et0TU5ugeHWKZaFDJk48qfdbcoN+Rc1csJTWZ8X87kJvbCuInYY7wu1BDDIiKDwTm+q9Yo5cLtF0K6AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVeD1kKJyQisqaoEe6NRfK8FyDXGlod6FvxjR90eXGa9cYfPx9XPNNWrxB9zPbE5HpGP9H0b7+l5Aavws5V5GgaOaS02jz6IuwqXbEfX5yYfpiJVOw+No5NeEMzo2VHWv+WslfyAAlUCTb9W1rskUpjV3EqNxchNPJoiMGLwEMODChGh5Sz0DQBfLuREena8IzExiWbAfC1zTP4fZIy+FKvk8MqRNgL82Eq86tss4jvP/WbZqG4CFGqUIE0lVM2KeFl6n4JIAaAb2+eDXWn9e+u23K5k9muGW8Y11lZhKSdDmY+U1cs7C3Qci+4NMP9qIaI+SZP7I/pXx4YArwmVNHVQd/c4RkNk6GitZg22G1xTPbRcVQkkHOT0No/inmwVOau33/l5SKlill4t2EDSC2VmQ+45P5zre9RMAXDLO/MMwrEHhdbSevbQQcKqLaU+Ndrm48EZlTqWxQbBOVXOiHzxwYaBu3U4yCghuSHgShsFZJKzjScBRGxFvVXC/x+NBVeHf0yXYBfQq4SW4AZz4kLDUAaIfWaTclGLCn9gZGh/PF00Sxzc/Rh19dlBB8xSByiwMyz+iPXONDLjnCu9PmrjooaXHvgNSGyupXsR78kfEIBticRzQDhgfNoKlWfvOZeAEaAhGtKZKAWQK4dbwb7bI0enGCICQe54inFhZ4oo+fFyp7V3SI22MtV5Lu2558JJiMfXyZOLLaFDiXjvAVyslBHBUPePMqsSkELcqQ+GOybXpdOOtxvCNTBBq8Qbj8+80a0DmKIA/CfzOIM6NECPTb4TO6yV/Q== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUtuOmzAQ-Rp4C8JAgDz4IRfSpU2yLRt2276svPYkoCQ2sQ0K*-Ud0jRarSpZvpwzmjlnxm*aSTFXAmgtgB1d3moNkvdXKCsLtzamBZ0LSkhA3BNoXjFpp5yrVlq6BWPXN*xO5tLCXjNbK*nZvgE6f8jm3x7L7euXbJMV*fy-kR1ogyeN4jtdwA4GNUCN1bXcfyBsq*WCWUYnExKTJJ2M-SiN0-HsHvNU7*lx3G2i9a*YrdtJdZ4t4pcyfXmc7aKDEyz19CmMLpvFj8nyjM*85E64cBvWnwANnq7*iO-7rgZTFitaWds44RRDcR0VZ8dKGYtI6qc*QrwCflCtNZVqGtCIGNBdzcHg9fvftLnk6oROChC1Bm6R6ci-dLeYNdhKCSdcfmo2qvvYbieI9bUNqA2pQR0WGg8Cx4NE3HrV6hEWbJjsPTyvoOd5rgEz9PqZHWtR254GfkBGfjTy0y2J0RFJcAvS3*7NyzAnzfgwJ5phokEZuOZQy*s-ado3rwu82yiSOEkSkoaR9553P8Pt11ikXZ8F1fTyykVVXUo-L9930Xl1zh5W2R56IdQfUJTcug post-payments-klarna: summary: Make a Klarna payment value: @@ -11815,17 +9818,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgA0E+AKzHxD+sKT+0Z5agx5dmAxTdj+3Nlc9Uq/2vXU5QjEcAdsigMc3pZf6zcsiXr2FfbNBx0fLR2z1pjqPx0ubTObecUYf/iZag9GcjF2MiVvRFTKveTylXp/rZ9hT8pCEeE9B6k68ukdYV5iS5e5ByriTqXgNJzKLVAuTIdUQ/ZjUQweG6zrCDDiC59giRLlL3bQBJdZoi/i06W1liqqZwX2Z9dQhZtek7awoZNsh/a7zL9nO+ORhUmucgzxRN3ICeY5hEGBrPjPhEi8WsR7vS8LRhCqCx6aU4NvMaLYQQZMDhA6/4wvoV9q2or0F+mdGnQFP/Uj1dor6HXqgnCQmUHLejsR+uKJ/4bPc32xYCBUSlnZ8hC3Rb+SO+Nwxm+VDqfJJC/UQNIdw9v9jH4PAoVoJcGqAw6b/ObNush8p/iTvnw08x1/7S68tuUBoqFUO1WKi/ldwD3I+hLuKVClvuKsFsD4fBbRYPPTxpi+UccalNeBOq3Na2i4by4u8l3T4dxDYn96YVpqrigjv1IISOlVk6ijQ4onnnwLxK1TfyV1NYrDuQPHEgBVWx4U7X9dqjXlQ/NvZes8Udy4ShFQamYYRPgVM8PgfjXRe5QycV0ftGwkkFRJDq/QGGungDvYL4Wp/SqujhCkFMow5Fg5ytW8HxL5KnFUHqvp0w1cohChqmPg99ConXap6QxJPRC/AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifb6WqW7iXMtVX/eLf5zAMcvTtwRWv9BMdAXbktk7amecV0FiDoq+TRYnuiYSL94cLrQZmVp1ZRgmYOXI+/39dzKCW8ZfGI/QDcTxmLUIdv0rlb8/3alEaLKb4NTS07WHwc4yG7QWGlFebhg2byR1KrskyJY2U20q0nnP8VHIhiWzWifkCHfEKTfmUjST0nQoPTfAL7ylf7eBoE9g1yeW75lB9v6OIFvXN1uXLfyktpF+/oID835jren8XXov/+HBhOnQftVMROsM+WqKjYT0RlUSW5YzYoWA/EatGLCyJaVg4MY2vQMQgVY2PqfO/pEpIvpTxVZmsbabeVIKn/JrzeBli3byLPOuJJaaQ1dQ4R9qwv4e4DfFQg7jRtmncxmlZWqY39TZSq2Vqr/2aWPdVz4ypqC8T3WXT5vS0IiaACN8cGph6bJNcVLZhz7MiTROsUE9CL6l4338srPHYukzdwMdvJ94VR63fj67cM3QLjATdvUG7K0Hr64rtZ/1wV4pK3mM7AKkqAfVGqWAcOIW3eu+0MICeJe9m2ZDzlFekaF+o3K8U7X52COKLo5kM0qaRUuh+pu6JW17HWCgh+l61To18tm7mqP+jSlMN9guRr8VCrnk8vhxhEqWhNM6u3wKThktBz8j8HT9ri2lCMVCtfD1AYhNKi24vof1e6bDmwUn4uvIz6C1AH3hovoXnexJphUcdPj5wlbL6IWZMLDKIL0wDnmUzaFxj6YpUfbxRVjb3BRRhYClAwL0MqpQOrc28VwyVCm2H9Rob5kUIwQwrhnO9Kpx/9CaX2fQzgSXqQ== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUttymzAQ-Rp4M8Md-KAHh5CYxEkaCmmnLxlZbCwmtoQlQUO*PgtxnU6nMxpd9uycPXtWW0VFk8kGSNMqYCbfUvHaip3NeqVAsHHG8rq0D6AYp8KsGJO9MKQCbe5OsTNYCAM7RU0rhWPGDki2zrPbh7p6vs7v87LI-ps5gNJ4kjA*wyW8wFQfiDZq0vMFmF6JS2ooWS692EvSZeRGYZym1*ec7*2ORP7jPrr19FgdIUsuuOVfMe-H7wfLv8i7TC2bZH1zv8EXr6ONNvGjFVzaHR0PgC0e5g4913VtBbouN4Qb01nBCllw7SWjey61wUjqpu7EzYG9yt5oLrsOFEY0qKFloPH67ZO2EEwesJcSPr1GZPD*0J1y7sBw2VjB1T92o7q-Dbf8WM1GoDaEJnVYKJoERpNE3EbZqwUW7KgYHTznoOM4tgY9uf1E923TmpH4ru8t3HDhppUXY0deglsQ-rJPvUyTUpRNkyI5Ek3KwNb4S*a-0fVbZ-Cd0zCSOEkSLw1C570YfgbVTdykw5j7fPX2zBrO32q3qN9fwuPmmK83*Q7GppEfgFvcYg post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index ec43996b..5e2a327d 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1023,24 +1045,24 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1051,8 +1073,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1060,8 +1082,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1069,8 +1091,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1078,8 +1100,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1090,13 +1112,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1141,8 +1165,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1150,8 +1174,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1159,8 +1183,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1168,8 +1192,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1180,13 +1204,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1223,8 +1249,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1232,8 +1258,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1241,8 +1267,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1250,8 +1276,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1262,13 +1288,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1327,8 +1355,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1336,8 +1364,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1345,8 +1373,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1354,8 +1382,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1366,13 +1394,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1434,8 +1464,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1443,8 +1473,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1452,8 +1482,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1461,8 +1491,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1473,13 +1503,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1537,8 +1569,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1546,8 +1578,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1555,8 +1587,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1564,8 +1596,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1576,13 +1608,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1640,8 +1674,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1649,8 +1683,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1658,8 +1692,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1667,8 +1701,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1679,13 +1713,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1744,8 +1780,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1753,8 +1789,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1762,8 +1798,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1771,8 +1807,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1783,8 +1819,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1979,13 +2015,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -2530,6 +2566,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -3003,19 +3047,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3241,68 +3272,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3488,13 +3457,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3565,13 +3534,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3632,13 +3601,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3655,7 +3624,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3694,7 +3663,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3721,13 +3690,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3745,41 +3714,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3916,7 +3885,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -3927,7 +3896,7 @@ components: in India. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -4003,7 +3972,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4048,12 +4017,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4069,13 +4038,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4089,7 +4058,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4100,7 +4069,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4111,12 +4080,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4126,7 +4095,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4141,14 +4110,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4180,7 +4149,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4274,12 +4243,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4295,11 +4264,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4307,30 +4276,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4763,7 +4734,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4874,7 +4845,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4895,7 +4866,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -5031,7 +5002,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5189,7 +5160,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5446,13 +5417,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5470,13 +5441,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5503,13 +5474,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5531,13 +5502,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5639,13 +5610,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5714,14 +5685,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -5969,13 +5932,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5997,13 +5960,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6027,7 +5990,7 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -6037,7 +6000,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6069,13 +6032,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6314,7 +6277,7 @@ components: PaymentDetailsResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. oneOf: @@ -6338,7 +6301,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -6354,7 +6317,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -6392,7 +6355,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6446,7 +6409,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6509,7 +6472,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6606,7 +6569,7 @@ components: PaymentMethod: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -6696,7 +6659,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6712,7 +6675,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6745,7 +6708,7 @@ components: the transaction. type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6756,8 +6719,10 @@ components: > This field is required for recurring payments.' type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6782,7 +6747,7 @@ components: $ref: '#/components/schemas/PaymentMethod' type: array storedPaymentMethods: - x-addedInVersion: 49 + x-addedInVersion: '49' description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' @@ -6827,7 +6792,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6865,12 +6830,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6886,7 +6851,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6911,11 +6876,11 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -6928,7 +6893,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -6942,7 +6907,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -6953,29 +6918,29 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -6987,17 +6952,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7005,7 +6970,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7015,7 +6980,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7030,14 +6995,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7067,7 +7032,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -7128,7 +7093,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -7145,12 +7110,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -7247,12 +7212,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7268,11 +7233,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7280,28 +7245,30 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7313,7 +7280,7 @@ components: PaymentResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' @@ -7345,7 +7312,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -7361,7 +7328,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' 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. @@ -7407,7 +7374,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7458,7 +7425,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7517,7 +7484,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7533,12 +7500,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7546,7 +7513,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7557,7 +7524,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7582,14 +7549,14 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7602,7 +7569,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7616,7 +7583,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7627,23 +7594,23 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7655,17 +7622,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7673,7 +7640,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7683,7 +7650,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7698,7 +7665,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7772,7 +7739,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7832,12 +7799,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7853,11 +7820,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7865,18 +7832,20 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string token: @@ -7886,7 +7855,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7965,7 +7934,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -8054,13 +8023,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8093,18 +8062,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -8113,7 +8082,7 @@ components: RecurringDetail: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -8194,6 +8163,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8506,6 +8478,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8589,7 +8593,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8604,11 +8608,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -8891,7 +8895,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -8900,7 +8904,7 @@ components: description: The payload you received from the Samsung Pay SDK response. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8924,13 +8928,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8947,7 +8951,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -9178,13 +9182,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9202,7 +9206,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -9237,13 +9240,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -9290,14 +9293,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -9354,7 +9357,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -9376,7 +9379,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -9395,7 +9398,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -9413,7 +9416,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDSecureData: @@ -9456,7 +9459,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -9464,7 +9467,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9493,7 +9496,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9503,7 +9506,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9525,13 +9528,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9604,13 +9607,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9645,43 +9648,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9699,20 +9673,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9721,17 +9681,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9739,11 +9688,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9751,13 +9695,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9784,15 +9721,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -9810,39 +9738,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -9883,6 +9834,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -9908,1867 +9860,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -11911,6 +10049,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -11927,24 +10074,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -11992,22 +10121,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12064,21 +10177,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: 039171 - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9UGIA1 - pspReference: 993617895104539H - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -12099,21 +10197,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 056319 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9UICT3 - pspReference: 993617895111540G - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -12134,21 +10217,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '071717' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9UCJBM - pspReference: 993617895090535B - resultCode: Authorised - merchantReference: string post-payments-card-direct: summary: Make a card payment value: @@ -12165,37 +10233,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: '034052' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9UEDUG - pspReference: 993617895097539G - resultCode: Authorised - merchantReference: string post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -12270,24 +10308,6 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: '026523' - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9UDGL3 - pspReference: 993617895094536F - resultCode: Authorised - merchantReference: string post-payments-giropay: summary: Make a giropay payment value: @@ -12299,23 +10319,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgB0GGL0YONwvtT7avYeWcADNdByJj4DWcbKRhIcKNkM6pNv/qTpAj2bVRJpBnbMGC7PW0bf7GHgiFlCIBEoLbokvwkjZkjFpYjhRgdAd3/Tu3ARSXC10Z93sXC8ARJNoS9nAYiJ0sN2A+YUb5Re3H3PAf+JUww2RTw8j5ewpZS7R7SoOdWLRB6wADekDKpF1pEn/wZ1iggdVDUbC6yJu/kMI8rHSpXMXGt3mJwICndP5pj2ZTZ4oZKQuW8inIWioHEChnoBluVh8vR5v4O5m7x1qHUI+KMKmg46XCRz4HSeyZSSt0i/YEtmAc2CvJBOLnfNBWjEU9Q9wz7XUaqhdyJSLhxfiGmNqMXlOR5CP3hIWoWzaSxjBGxj7EHyEYH+APgTb6DSTwFcwdUrRKNiJbXT7TcxvYp2oWy6+8euOEyvQmBGStilH8HlZ/evPw1ETL/gH9vb0cltE9g8BXtT/zVftwgElIB8OUSHqSajwbr1ixz+84ceFB6qxWkMKaoA8exrOv4xW8HkAbD62HQWkORY3CWW6+Azn/1jM60VRAUjFxhOJrPGRjR6huaJuh8+B9+KhofihfpwTPQKA0DniZmkL52NFqPW6wHI3siWycd6bgl6NiMUm1Ay1hnMGddfFg7/mijYOAGxHloCrxGa61VdLJRDxnTfKDUzWXqv39hMwxCg7iZZe7JoYWSfeJdjfo+PAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeBfB4hwExhN4+D+GEuR+ULSZhV5dUQ+HOIC/Bzwak/E1AhOZr5O+F4SyYt4NMhvm89xpP3yiFEYDyAE3kLjBonTZupkZkgmWmOmm1/C+ta8/tykMBVAusTSQ+1GeSmPvO7L4a9AtWek8OjEx4TLd4779HQpTGIWCqY19x4dh4OJM6vTqB57yS1fHvp/Y8RHwgrRUzuqCmZ+ERPBG0+3kqy0XeA0mwKf6MMy8yEwlYOAio/9qO3+XNofeQc8TuK/5vuGxd74nf29o9vugQWNShqKt/ITfmQp+uO/kSynDJnE/RVRLf2MldQfEVxQd9WKGX0bCkJP8GKPo7nWfzwBQ6+OqxdRT00N/tvi6ondb8RRH28RPktJGDfQ7GH5D6H7V4yXWhQWp6CXRF8mPaWwQV3lZje5WYRk4kgmGDKTja2ohNR1YFroQbg/TA8k67TIXqFqYyGdH5l5eGWKVPDJawHuQl0ctVwDAL5TCieqE0IcOHxEuYTsZt3oqw2PetNxZB2QtSHiB1az2jydwh5xv5KAhi3sOW9XdvS8JbgJuzRQpS50PEc+o2S79pv6q+XrTYma9DWNNg14wwhCTxZJQ9vAgZ/1wQwosMf957SKq7qaL5y0Auhan+HX3IbQ1qcyIUP/fiR1qAthLqvOu8xPikV/E7Twr+e7OBGeAFNZouJEuEr4DXLLOey6QuOBeTNaIk/sGur51RMDZ0FptsKGY3HzkatxcPmGBFxmcdPYjoxA4kiMcUBywdXnxRB6BKrKR+Bz5Lxkcf5fCEl+DCBldnqe30wvuOLnjQs23hKC - paymentMethodType: giropay - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUttuozAQ-ZrwFmQu4fLAQ5aSLdt0t2KhTftSuWYK3iY2tQ0t*fod2DSqqpWssXXOaOacGT8pKupU1pA0XMmOjhbrlQLBxhnMqsI6gGItFWbNmOyFSUrQ5vqEnclcGGgUNVwK24wdJOllll79qsrH79nPrMjT-2YOoDTeiR*f6QKeYeoPiTaKi*YTYXolLqihSRw7gRNG8YpEcUiCzTnnN28SSm82Ls8DXzZ35raA-J6*FX9Yebfb5UX37XhP04cgruTxiiy8CwstHwDNHWZvDiHEUqCrYpu0xnQLb71wN3j2ktF9K7VBJCIRQYi1wF5kb3Qruw4UIhrUwBlofN78K5sLJg-oooCaK2AGmcH5KHfKuQbTynrhbb4MGtV9HvXCDdQ8AtSG1KQOG60mgatJIoZR9mqJDTsqRhvvGbRt29Kgpznf0j2vuRkTl7jOkvhLEpVOgI6cCAOJH6yTl2lHirJpR0mGhSZlYOkXLuZf0fVP9uDapzWEQRiGTuT59jEfdl75I6ijYczcdv3*yOq2fa9IXh2f-dfta3a5zRoY61r*BdOr2bA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB0GGL0YONwvtT7avYeWcADNdByJj4DWcbKRhIcKNkM6pNv/qTpAj2bVRJpBnbMGC7PW0bf7GHgiFlCIBEoLbokvwkjZkjFpYjhRgdAd3/Tu3ARSXC10Z93sXC8ARJNoS9nAYiJ0sN2A+YUb5Re3H3PAf+JUww2RTw8j5ewpZS7R7SoOdWLRB6wADekDKpF1pEn/wZ1iggdVDUbC6yJu/kMI8rHSpXMXGt3mJwICndP5pj2ZTZ4oZKQuW8inIWioHEChnoBluVh8vR5v4O5m7x1qHUI+KMKmg46XCRz4HSeyZSSt0i/YEtmAc2CvJBOLnfNBWjEU9Q9wz7XUaqhdyJSLhxfiGmNqMXlOR5CP3hIWoWzaSxjBGxj7EHyEYH+APgTb6DSTwFcwdUrRKNiJbXT7TcxvYp2oWy6+8euOEyvQmBGStilH8HlZ/evPw1ETL/gH9vb0cltE9g8BXtT/zVftwgElIB8OUSHqSajwbr1ixz+84ceFB6qxWkMKaoA8exrOv4xW8HkAbD62HQWkORY3CWW6+Azn/1jM60VRAUjFxhOJrPGRjR6huaJuh8+B9+KhofihfpwTPQKA0DniZmkL52NFqPW6wHI3siWycd6bgl6NiMUm1Ay1hnMGddfFg7/mijYOAGxHloCrxGa61VdLJRDxnTfKDUzWXqv39hMwxCg7iZZe7JoYWSfeJdjfo+PAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeBfB4hwExhN4+D+GEuR+ULSZhV5dUQ+HOIC/Bzwak/E1AhOZr5O+F4SyYt4NMhvm89xpP3yiFEYDyAE3kLjBonTZupkZkgmWmOmm1/C+ta8/tykMBVAusTSQ+1GeSmPvO7L4a9AtWek8OjEx4TLd4779HQpTGIWCqY19x4dh4OJM6vTqB57yS1fHvp/Y8RHwgrRUzuqCmZ+ERPBG0+3kqy0XeA0mwKf6MMy8yEwlYOAio/9qO3+XNofeQc8TuK/5vuGxd74nf29o9vugQWNShqKt/ITfmQp+uO/kSynDJnE/RVRLf2MldQfEVxQd9WKGX0bCkJP8GKPo7nWfzwBQ6+OqxdRT00N/tvi6ondb8RRH28RPktJGDfQ7GH5D6H7V4yXWhQWp6CXRF8mPaWwQV3lZje5WYRk4kgmGDKTja2ohNR1YFroQbg/TA8k67TIXqFqYyGdH5l5eGWKVPDJawHuQl0ctVwDAL5TCieqE0IcOHxEuYTsZt3oqw2PetNxZB2QtSHiB1az2jydwh5xv5KAhi3sOW9XdvS8JbgJuzRQpS50PEc+o2S79pv6q+XrTYma9DWNNg14wwhCTxZJQ9vAgZ/1wQwosMf957SKq7qaL5y0Auhan+HX3IbQ1qcyIUP/fiR1qAthLqvOu8xPikV/E7Twr+e7OBGeAFNZouJEuEr4DXLLOey6QuOBeTNaIk/sGur51RMDZ0FptsKGY3HzkatxcPmGBFxmcdPYjoxA4kiMcUBywdXnxRB6BKrKR+Bz5Lxkcf5fCEl+DCBldnqe30wvuOLnjQs23hKC - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUttuozAQ-ZrwFmQu4fLAQ5aSLdt0t2KhTftSuWYK3iY2tQ0t*fod2DSqqpWssXXOaOacGT8pKupU1pA0XMmOjhbrlQLBxhnMqsI6gGItFWbNmOyFSUrQ5vqEnclcGGgUNVwK24wdJOllll79qsrH79nPrMjT-2YOoDTeiR*f6QKeYeoPiTaKi*YTYXolLqihSRw7gRNG8YpEcUiCzTnnN28SSm82Ls8DXzZ35raA-J6*FX9Yebfb5UX37XhP04cgruTxiiy8CwstHwDNHWZvDiHEUqCrYpu0xnQLb71wN3j2ktF9K7VBJCIRQYi1wF5kb3Qruw4UIhrUwBlofN78K5sLJg-oooCaK2AGmcH5KHfKuQbTynrhbb4MGtV9HvXCDdQ8AtSG1KQOG60mgatJIoZR9mqJDTsqRhvvGbRt29Kgpznf0j2vuRkTl7jOkvhLEpVOgI6cCAOJH6yTl2lHirJpR0mGhSZlYOkXLuZf0fVP9uDapzWEQRiGTuT59jEfdl75I6ijYczcdv3*yOq2fa9IXh2f-dfta3a5zRoY61r*BdOr2bA post-payments-googlepay: summary: Make a Google Pay payment value: @@ -12340,23 +10343,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgBK6QhIJjlNqvAPkOnf1HzcblwXCFm8j17/geaZbQWzWPhxHlvOzQw0TOdwxonkCYOHQDGEupixy+jiPAkPwjk9aubdkxkPMvtXNZC/4FaQSoRNRxXP/zLjD1ut7pQrYXtMhORqUpfy6BEYo3tz6JwUDeEvfPngMsJxKlKETkxU+VFvwPW6VsH70LVBaEnxqdhlKg02jqq3ROhksyTbwCN6VzipUfn0RJWizDxuLINEXgI2zr0WAmE+QXkcVx30FLq7ebgq6vO5JegU+eyow0M6teWIWdeeCpfPEH0uEY0Ijpv7M0DQiQlv4cPTPEH/xPgn3ha+i63acomRTtG+J+bZgKZqJIWONrZFCX8zUrtnO2zCQpYJE7aTewjACA7h7yU1ANNzp858v4zwktyUBfx/AWSRckgieZp/8N9FWmjVM902bPBrGUXKRXyjH4H2b9OFZivNmxl97iDIe/gXkfy54qy7m6MmztDgurQ44k9+e3wH+V2cnktBQnPPyGIn1w7Wi5GxZ8gP3fl7nDVMZkXaVH3X/Evl+8U+5vg+vORZqfINT3c3Gi2V53bNM1WenMrYXhmHfszODBTAqh1zyoZtmc+8CK/UaSmtOE/FOaxNmpG+i9ZUVQjxFWhQOpvhhsQuevtDJrilT/2beCcYXnqFoYmaKNP+yUrEM0PFzFpRGxDpLiBPDU8aTIHXkZu1MH4DAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSNlJboJoK1IzC49XNvAhpuEw3D/8HFQPenVjLW55FXRkA7hLhNAe6cK7luiuct7aryHgPUf+/sisCwXfndfPrFo6EVv6mDyBVbv1FQOpCAFIHawR9LoOar+mg3YuU2trdMX8awt2fWD5jSW0iIv4MEnQfFY9JRW5uP1a0jIvY/Bqcp6ejjs+Ic1ody7M/cqPrRgwVxPd9Mrm2OaMyZYrmtiIKWLzUiJWZ58zw8UuQ0c1PpY8+NLEd0dtIw7TR2K5YfmNSg4ZQcKyA11yUghsbpIG5+HZ8DoY2LNO36FJwRacScsx0Ipv54J3uzcK9Gp4gTUtzpzTVuUa+RGcCLVYrs5zIudmBMqzzKnDHPnmkCnLkjK0qkZzz/bPK7zwiaHtZdyGK/Kdrzekz4NgDArJ/VKl8ZnhRANjrKSiTgHo2JqNNF18pYisdVyj94KzWsneJvGtSKKEaIMokjZHiw6XlNGoF+TFExpEb+IauUa4fJBljpVRLRQlHlWAcqrwYBr4/E28oPobq+9AFCGC9zN8jKrqb7gBEDgfHAMWqj77JcIa62GrKg38ns+nkUhaP1wHz1xI7sFwVWp9HqBFhoaeSfImL9ofkYdcHUIyiu6o6/O6RqycWToDy3lFtXqok9NCdqjrtNmm2bhnMJ1UhDsG/1chxGC2SBAJERBX8O81hR3BdOwEWHUiPOn+PuyEnUImkOaVVIuKrHfjkAl70TVm1MPRHMy//ubL6dHWrET4BqxAEmdoSORpfIo9N4Q7Kktr0YS5g44hyjLhX+j6c8POPnc+mqVdeHxKA== - paymentMethodType: ideal - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUsFuozAQ-Rq4BdmQADn4kFC6YUu7URaiai*VY0*Dt4lNbUNLv34Nm22raiVrxnrPmnlvxgdNJc8UByI40JPPOq1BsmGC8nrnC2M60AUnGIfYP4NmDZV2xZjqpCUVGHt7wd7JQlo4amqFkoEdWiDZJs9uftTVw7f8Lt8V2X9f9qCNy2S*fKd38AijGiDGaiGPnwjbaXlFLSXLJY5xki4XaBknKP2o-VMcySLbo7mpSrTfrl-u48XmpajMoazv1qI5eeE6izZl-Du7CbeyKrzoym-pcAZn7zy5wwghX4OpdyVprG29aOWF1*6cFKOnRhnrkBSlyEGsAfakOmsa1bagHWJA94KBcdft37KFZOrsfOyACw3MOqbH-8pd3tyCbRT3ousvo3bqPg-bC2M9DcFpc9SozjVajAIXo0QXBtXpmWvYUjkELk9gEAS*ATNOek9Pggs7kBCFeIbmM5RWOHaOcDqG*Jd-8TJuSVM2bonkrtCoDHzzJOT0S9ruEPRhcFlEEidJgtNoHrwV-X1UfY952g952KxeHxhvmtcaFfXb4-y5fM43ZX6EgXP1B7Iy3CU - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgBK6QhIJjlNqvAPkOnf1HzcblwXCFm8j17/geaZbQWzWPhxHlvOzQw0TOdwxonkCYOHQDGEupixy+jiPAkPwjk9aubdkxkPMvtXNZC/4FaQSoRNRxXP/zLjD1ut7pQrYXtMhORqUpfy6BEYo3tz6JwUDeEvfPngMsJxKlKETkxU+VFvwPW6VsH70LVBaEnxqdhlKg02jqq3ROhksyTbwCN6VzipUfn0RJWizDxuLINEXgI2zr0WAmE+QXkcVx30FLq7ebgq6vO5JegU+eyow0M6teWIWdeeCpfPEH0uEY0Ijpv7M0DQiQlv4cPTPEH/xPgn3ha+i63acomRTtG+J+bZgKZqJIWONrZFCX8zUrtnO2zCQpYJE7aTewjACA7h7yU1ANNzp858v4zwktyUBfx/AWSRckgieZp/8N9FWmjVM902bPBrGUXKRXyjH4H2b9OFZivNmxl97iDIe/gXkfy54qy7m6MmztDgurQ44k9+e3wH+V2cnktBQnPPyGIn1w7Wi5GxZ8gP3fl7nDVMZkXaVH3X/Evl+8U+5vg+vORZqfINT3c3Gi2V53bNM1WenMrYXhmHfszODBTAqh1zyoZtmc+8CK/UaSmtOE/FOaxNmpG+i9ZUVQjxFWhQOpvhhsQuevtDJrilT/2beCcYXnqFoYmaKNP+yUrEM0PFzFpRGxDpLiBPDU8aTIHXkZu1MH4DAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSNlJboJoK1IzC49XNvAhpuEw3D/8HFQPenVjLW55FXRkA7hLhNAe6cK7luiuct7aryHgPUf+/sisCwXfndfPrFo6EVv6mDyBVbv1FQOpCAFIHawR9LoOar+mg3YuU2trdMX8awt2fWD5jSW0iIv4MEnQfFY9JRW5uP1a0jIvY/Bqcp6ejjs+Ic1ody7M/cqPrRgwVxPd9Mrm2OaMyZYrmtiIKWLzUiJWZ58zw8UuQ0c1PpY8+NLEd0dtIw7TR2K5YfmNSg4ZQcKyA11yUghsbpIG5+HZ8DoY2LNO36FJwRacScsx0Ipv54J3uzcK9Gp4gTUtzpzTVuUa+RGcCLVYrs5zIudmBMqzzKnDHPnmkCnLkjK0qkZzz/bPK7zwiaHtZdyGK/Kdrzekz4NgDArJ/VKl8ZnhRANjrKSiTgHo2JqNNF18pYisdVyj94KzWsneJvGtSKKEaIMokjZHiw6XlNGoF+TFExpEb+IauUa4fJBljpVRLRQlHlWAcqrwYBr4/E28oPobq+9AFCGC9zN8jKrqb7gBEDgfHAMWqj77JcIa62GrKg38ns+nkUhaP1wHz1xI7sFwVWp9HqBFhoaeSfImL9ofkYdcHUIyiu6o6/O6RqycWToDy3lFtXqok9NCdqjrtNmm2bhnMJ1UhDsG/1chxGC2SBAJERBX8O81hR3BdOwEWHUiPOn+PuyEnUImkOaVVIuKrHfjkAl70TVm1MPRHMy//ubL6dHWrET4BqxAEmdoSORpfIo9N4Q7Kktr0YS5g44hyjLhX+j6c8POPnc+mqVdeHxKA== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUsFuozAQ-Rq4BdmQADn4kFC6YUu7URaiai*VY0*Dt4lNbUNLv34Nm22raiVrxnrPmnlvxgdNJc8UByI40JPPOq1BsmGC8nrnC2M60AUnGIfYP4NmDZV2xZjqpCUVGHt7wd7JQlo4amqFkoEdWiDZJs9uftTVw7f8Lt8V2X9f9qCNy2S*fKd38AijGiDGaiGPnwjbaXlFLSXLJY5xki4XaBknKP2o-VMcySLbo7mpSrTfrl-u48XmpajMoazv1qI5eeE6izZl-Du7CbeyKrzoym-pcAZn7zy5wwghX4OpdyVprG29aOWF1*6cFKOnRhnrkBSlyEGsAfakOmsa1bagHWJA94KBcdft37KFZOrsfOyACw3MOqbH-8pd3tyCbRT3ousvo3bqPg-bC2M9DcFpc9SozjVajAIXo0QXBtXpmWvYUjkELk9gEAS*ATNOek9Pggs7kBCFeIbmM5RWOHaOcDqG*Jd-8TJuSVM2bonkrtCoDHzzJOT0S9ruEPRhcFlEEidJgtNoHrwV-X1UfY952g952KxeHxhvmtcaFfXb4-y5fM43ZX6EgXP1B7Iy3CU post-payments-klarna: summary: Make a Klarna payment value: @@ -12465,23 +10451,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgANyRgy/Cb83UcMZgH26iRoesCdEWFukqzzkhE+5ftULQ3vt3u/wz4HJSwjDdOGV/m0MPpgtK4gUjH7pI/2BjN6TsWyuVR4Q7lLkpzDXfcWPp2MzPnuL44TlLJcnDbeC0PjoFC61mX/z8/4+3FtgMRI6N5T8lmSq37FS0b5UjSLxGgHzRWVwXbxVDTfJFM15TWF/shBi5NQrEcprfSZTLUQ7XWk2p9HRTmS50Ga/GSq0xDwsPo02f14r7iNKDPBD4U7pMpgPxNVDsiVwiwPwUyTaPz4nnq/+UVdknsU1/fKiYXNYVD4hfDPlaknja0i6Au+HDh0CCLrgoNd/PUI2EGz8fiSjbLWDRAI5+9gf895urW6b8ckjzYTqVVKgc74e8T0yBJaTF9Kd1IYCTt0jZU/ijVwDK848AZurobAlPYiF7sQOXgFAXeQHmmXDSNXJwMH9OdleCzkUcvB/4i1ZIfFxblTmncX3FDBc0yc6FPVgmtfBWQLOpAZl8tNREG6RwRNnW5kLkjMSDXSfwmGdW7LNVF1SBv+uemTRK9+jmhg+qRyUR/XQht+eGosYQYlyut06izAuI4dhG+Ro9bn09WjQxVnaEvD6Uq65IU4LWv2HcjWjpKlBOv5ejNo4H8DnwybnRA5SdN/EY/iZod86yG3tTAbY4Ayvo2Q+lG7Vb7LcRAOlt9cfqtyXgaKymPax8NiAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifd3J3r8hnE9gF0UJyMarOonSJWlwT+31JLeSYSOT5AmjUV9w7SwcjfsIF+LqjNHnC8lj1AnQVcXe4B8DoZ/SwIANLW/6BbMf9C3CgIrE3VpCZl7p8ljpp+8GSXHPULuf5mSk6wiwQficutG0Uspisuj5dCU9nbmBfHgnhNPEYone4d8efMIOvh8gKCaSG3vqlfLtKETuFDLWPoNMfv1ILw1uCSmNZd5xLMISjFtoz2bdQ+ds91tQGGUUvqsnhwqGyUpXP1T+sJWbESbgZCbANF1qaZTSJ7Iex5Myh9gRSvkW5376N6D7iYJQ3VlgHMWxgjmgf02EgOcqFanMcpr2kq4p4tpXMuK6EEXd3fvuGIMDwA1cD5CflbiKSwQ/PjGIvng5l1Ywi5py00oL0gbV716eog6xIYy+M3c5frNe56WCSxAakbsut66a9uVskqQXIDw/pTfE07/LRA3vOvXBTl8O3WCc3s3JGLJXgtvoaTRnuriIIOJ5m1d+5ATMIxU9tDgXOh4fzMRd7gxkPhBnIQJ9ERjTsoVgKJcicjA3dq7c60DbshZ0EWzSYwdENl3vhYnwkl60wo/6kgRvWGillBLb1nMtldst2J/z6WMbmPHqtvSOiJr5uMA0yisPOWVaod4HnThVyPeluTNOoLAnlqCHr+W/h0VhqPVWHi4dfCG/Tx2Y4Vi1OU0cP9TMjpfMj7zAsdTEoRRKQsIXy47YNhM3pCTNTuOrxoyf1i4WHO6v8+Q7DjVAOQUlpUnWY1hvbBz36Pn2T6yzDosWA+1J3rVLo8oj1kbjwzmwgYM7kQ0= - paymentMethodType: directEbanking - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUu9vmzAQ-WvgW5ANhB8f*JClZKFL1o3CVPVL5ZhrQAk2tQ0L*et3pFlaTZOss-Xe6e69O*8UE9VSVpBUjQJu0h0Th0bsbd4rBYKPFy4tc7sFxWsmzIJz2QuTFKDN9ordyEwY2CtmGikcM3aQLNfp8ttDWbx8Tb*nebb8b*YASuOd*PGNzuEVpv6QaKMmPR*E6ZW4Y4YlcUwDGkbxnJI4pPTLLeex2SfdhrfRY2ruu7XlruCMQZ2eMkbd7aoR8Owfi98H0g-kgMziwf9peXd2x8YW0GJ7cUgJIbYCXeabpDams7wF5uI5Ss6OtdQGkYhEBCFeAz-I3uhadh0oRDSooeGg8fnjvWwmuGzRSw7vs0ZmoH-LXXO2YGpZWd7qn3Gjus8Dt9xAXQaB2pCa1GGj*SRwPknEMMpezbBhx8To4H0BHcexNehp2r-YsakaMyYucemM*DMSFTRARzTC4MbP9tXLtCnF*LSpJMVCkzKwNf6Sy9-o*p0zuM51GWEQhiGNPN85Z8OTV9wHVTSMqVsvTi*8qutTSbLy-Oq-bd7S9Sbdw1hV8g8Atd1V - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgANyRgy/Cb83UcMZgH26iRoesCdEWFukqzzkhE+5ftULQ3vt3u/wz4HJSwjDdOGV/m0MPpgtK4gUjH7pI/2BjN6TsWyuVR4Q7lLkpzDXfcWPp2MzPnuL44TlLJcnDbeC0PjoFC61mX/z8/4+3FtgMRI6N5T8lmSq37FS0b5UjSLxGgHzRWVwXbxVDTfJFM15TWF/shBi5NQrEcprfSZTLUQ7XWk2p9HRTmS50Ga/GSq0xDwsPo02f14r7iNKDPBD4U7pMpgPxNVDsiVwiwPwUyTaPz4nnq/+UVdknsU1/fKiYXNYVD4hfDPlaknja0i6Au+HDh0CCLrgoNd/PUI2EGz8fiSjbLWDRAI5+9gf895urW6b8ckjzYTqVVKgc74e8T0yBJaTF9Kd1IYCTt0jZU/ijVwDK848AZurobAlPYiF7sQOXgFAXeQHmmXDSNXJwMH9OdleCzkUcvB/4i1ZIfFxblTmncX3FDBc0yc6FPVgmtfBWQLOpAZl8tNREG6RwRNnW5kLkjMSDXSfwmGdW7LNVF1SBv+uemTRK9+jmhg+qRyUR/XQht+eGosYQYlyut06izAuI4dhG+Ro9bn09WjQxVnaEvD6Uq65IU4LWv2HcjWjpKlBOv5ejNo4H8DnwybnRA5SdN/EY/iZod86yG3tTAbY4Ayvo2Q+lG7Vb7LcRAOlt9cfqtyXgaKymPax8NiAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifd3J3r8hnE9gF0UJyMarOonSJWlwT+31JLeSYSOT5AmjUV9w7SwcjfsIF+LqjNHnC8lj1AnQVcXe4B8DoZ/SwIANLW/6BbMf9C3CgIrE3VpCZl7p8ljpp+8GSXHPULuf5mSk6wiwQficutG0Uspisuj5dCU9nbmBfHgnhNPEYone4d8efMIOvh8gKCaSG3vqlfLtKETuFDLWPoNMfv1ILw1uCSmNZd5xLMISjFtoz2bdQ+ds91tQGGUUvqsnhwqGyUpXP1T+sJWbESbgZCbANF1qaZTSJ7Iex5Myh9gRSvkW5376N6D7iYJQ3VlgHMWxgjmgf02EgOcqFanMcpr2kq4p4tpXMuK6EEXd3fvuGIMDwA1cD5CflbiKSwQ/PjGIvng5l1Ywi5py00oL0gbV716eog6xIYy+M3c5frNe56WCSxAakbsut66a9uVskqQXIDw/pTfE07/LRA3vOvXBTl8O3WCc3s3JGLJXgtvoaTRnuriIIOJ5m1d+5ATMIxU9tDgXOh4fzMRd7gxkPhBnIQJ9ERjTsoVgKJcicjA3dq7c60DbshZ0EWzSYwdENl3vhYnwkl60wo/6kgRvWGillBLb1nMtldst2J/z6WMbmPHqtvSOiJr5uMA0yisPOWVaod4HnThVyPeluTNOoLAnlqCHr+W/h0VhqPVWHi4dfCG/Tx2Y4Vi1OU0cP9TMjpfMj7zAsdTEoRRKQsIXy47YNhM3pCTNTuOrxoyf1i4WHO6v8+Q7DjVAOQUlpUnWY1hvbBz36Pn2T6yzDosWA+1J3rVLo8oj1kbjwzmwgYM7kQ0= - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUu9vmzAQ-WvgW5ANhB8f*JClZKFL1o3CVPVL5ZhrQAk2tQ0L*et3pFlaTZOss-Xe6e69O*8UE9VSVpBUjQJu0h0Th0bsbd4rBYKPFy4tc7sFxWsmzIJz2QuTFKDN9ordyEwY2CtmGikcM3aQLNfp8ttDWbx8Tb*nebb8b*YASuOd*PGNzuEVpv6QaKMmPR*E6ZW4Y4YlcUwDGkbxnJI4pPTLLeex2SfdhrfRY2ruu7XlruCMQZ2eMkbd7aoR8Owfi98H0g-kgMziwf9peXd2x8YW0GJ7cUgJIbYCXeabpDams7wF5uI5Ss6OtdQGkYhEBCFeAz-I3uhadh0oRDSooeGg8fnjvWwmuGzRSw7vs0ZmoH-LXXO2YGpZWd7qn3Gjus8Dt9xAXQaB2pCa1GGj*SRwPknEMMpezbBhx8To4H0BHcexNehp2r-YsakaMyYucemM*DMSFTRARzTC4MbP9tXLtCnF*LSpJMVCkzKwNf6Sy9-o*p0zuM51GWEQhiGNPN85Z8OTV9wHVTSMqVsvTi*8qutTSbLy-Oq-bd7S9Sbdw1hV8g8Atd1V post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index a0dd6d2d..f1e764ba 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1025,26 +1047,26 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' - subscription-first-transaction-200: - $ref: '#/components/examples/post-payments-subscription-first-transaction-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1055,8 +1077,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1064,8 +1086,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1073,8 +1095,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1082,8 +1104,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1094,13 +1116,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1145,8 +1169,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1154,8 +1178,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1163,8 +1187,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1172,8 +1196,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1184,13 +1208,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1227,8 +1253,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1236,8 +1262,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1245,8 +1271,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1254,8 +1280,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1266,13 +1292,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1331,8 +1359,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1340,8 +1368,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1349,8 +1377,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1358,8 +1386,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1370,13 +1398,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1438,8 +1468,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1447,8 +1477,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1456,8 +1486,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1465,8 +1495,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1477,13 +1507,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1541,8 +1573,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1550,8 +1582,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1559,8 +1591,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1568,8 +1600,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1580,13 +1612,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1644,8 +1678,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1653,8 +1687,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1662,8 +1696,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1671,8 +1705,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1683,13 +1717,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1748,8 +1784,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1757,8 +1793,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1766,8 +1802,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1775,8 +1811,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1787,8 +1823,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1846,7 +1882,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -2000,13 +2036,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -2551,6 +2587,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -3024,19 +3068,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3262,68 +3293,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3509,13 +3478,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3586,13 +3555,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3653,13 +3622,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3676,7 +3645,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3715,7 +3684,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3742,13 +3711,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3766,41 +3735,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3937,7 +3906,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -3948,7 +3917,7 @@ components: in India. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -4024,7 +3993,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4069,12 +4038,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4090,13 +4059,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4110,7 +4079,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4121,7 +4090,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4132,12 +4101,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4147,7 +4116,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4162,14 +4131,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4201,7 +4170,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4295,12 +4264,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4316,11 +4285,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4328,36 +4297,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4790,7 +4761,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4901,7 +4872,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4922,7 +4893,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -5058,7 +5029,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5150,7 +5121,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead. @@ -5222,7 +5193,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5479,13 +5450,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5503,13 +5474,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5536,13 +5507,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5564,13 +5535,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5672,13 +5643,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5747,14 +5718,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -6002,13 +5965,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6030,13 +5993,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6060,7 +6023,7 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -6070,7 +6033,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6102,13 +6065,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6347,7 +6310,7 @@ components: PaymentDetailsResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. oneOf: @@ -6371,7 +6334,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -6387,7 +6350,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -6425,7 +6388,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6479,7 +6442,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6542,7 +6505,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6627,7 +6590,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. type: boolean @@ -6644,7 +6607,7 @@ components: PaymentMethod: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -6734,7 +6697,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6750,7 +6713,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6783,7 +6746,7 @@ components: the transaction. type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6794,8 +6757,10 @@ components: > This field is required for recurring payments.' type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6820,7 +6785,7 @@ components: $ref: '#/components/schemas/PaymentMethod' type: array storedPaymentMethods: - x-addedInVersion: 49 + x-addedInVersion: '49' description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' @@ -6865,7 +6830,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6903,12 +6868,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6924,7 +6889,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6949,11 +6914,11 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -6966,7 +6931,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -6980,7 +6945,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -6991,29 +6956,29 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7025,17 +6990,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7043,7 +7008,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7053,7 +7018,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7068,14 +7033,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7105,7 +7070,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -7166,7 +7131,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -7183,12 +7148,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -7285,12 +7250,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7306,11 +7271,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7318,34 +7283,36 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7357,7 +7324,7 @@ components: PaymentResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' @@ -7389,7 +7356,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -7405,7 +7372,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' 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. @@ -7451,7 +7418,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7502,7 +7469,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7561,7 +7528,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7577,12 +7544,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7590,7 +7557,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7601,7 +7568,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7626,14 +7593,14 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7646,7 +7613,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7660,7 +7627,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7671,23 +7638,23 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7699,17 +7666,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7717,7 +7684,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7727,7 +7694,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7742,7 +7709,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7816,7 +7783,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7876,12 +7843,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7897,11 +7864,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7909,22 +7876,24 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. @@ -7936,7 +7905,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -8015,7 +7984,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -8104,13 +8073,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8143,18 +8112,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -8163,7 +8132,7 @@ components: RecurringDetail: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -8244,6 +8213,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8556,6 +8528,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8639,7 +8643,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8654,11 +8658,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -8941,7 +8945,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -8950,7 +8954,7 @@ components: description: The payload you received from the Samsung Pay SDK response. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8974,13 +8978,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8997,7 +9001,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -9228,13 +9232,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9252,7 +9256,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -9287,13 +9290,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -9301,7 +9304,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -9343,14 +9346,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -9407,7 +9410,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -9429,7 +9432,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -9439,7 +9442,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -9452,7 +9455,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -9463,7 +9466,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -9481,7 +9484,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDSecureData: @@ -9524,7 +9527,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -9532,7 +9535,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9561,7 +9564,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9571,7 +9574,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9593,13 +9596,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9672,13 +9675,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9713,43 +9716,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9767,20 +9741,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9789,17 +9749,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9807,11 +9756,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9819,13 +9763,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9852,15 +9789,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -9878,39 +9806,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -9951,6 +9902,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -9976,1867 +9928,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -11979,6 +10117,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -11995,24 +10142,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12060,22 +10189,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12132,21 +10245,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: '011026' - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9V1BDJ - pspReference: 993617895160556C - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -12167,21 +10265,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 040853 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9V28N0 - pspReference: 993617895163558F - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -12202,21 +10285,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: 022851 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9USF5K - pspReference: 993617895139551B - resultCode: Authorised - merchantReference: string post-payments-card-direct: summary: Make a card payment value: @@ -12233,37 +10301,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: '042117' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9UVQJ0 - pspReference: 993617895155555B - resultCode: Authorised - merchantReference: string post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -12342,24 +10380,6 @@ components: recurringProcessingModel: CardOnFile returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: '051103' - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9UUT9J - pspReference: 993617895152551D - resultCode: Authorised - merchantReference: string post-payments-giropay: summary: Make a giropay payment value: @@ -12371,23 +10391,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgCbCocr/c9RDB3l3GwHQ9ZghYfXrXmiHFU1DYCUvyD9+CzOhDaqzKmrU8In313x6Cn8UAB6HG2ndmAMVDoB7yWEVu9LDTMd2pmnolKLdUPbz8Ab9nYLs6Ne4VrkUIiErz4vw91CXOfK4UamqHjiec7Su/z9RwzvnLOK3nRJTO9tPu7hz2VzZzAXuzVOEmRNFScq8jVU7a4YnW6h9CniosKnFdZksMQ5bWPwf5ZjiOTsESt0KCgmIoptLEpWbVFERbpO42HmHhF5eZyYxX61VJJ/Wb/wxDnADFUAc8e2SrRWaM3Wrz3KOLe8tDP1w52xgY6cJjH1x7RpusscaZuyGj6MC7ymlS74wcEZ4MQLo0sxmCh3SSUnYGmRHcC3HH+FN7zfy631OSzyiJ1ZJ+bzVtpB6W3odoby2HkaSLxp3nbMYKf1QnxBEsckDg+0KIGa5PUiYma8vpLGtCACVi1F5bHgRFQM2AMRyqmhqrIGOHcdBgTnVkbzOpxjr6ywrFJNLvwr6k0Gpq2uymNohJ1Zl7mWs6hJMs+c54J5OflHsE24NPflw5aEXnkEcfOwotZnzcpXklNFVQ2Yp75z3DbvEw8M6u/OrKmLCFJp2d7O4vbtyMEOQkxGkbpeKa6jJAE6IVd+XjQwG/joTJkLT0LyRSjJoZPbikljkUa5WON6G85kZRD1DgwIWdPsm3DaSqRWTgSxAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWrq3BQxMlca+NqR0+uuqFcq12blP+pz9Al1HE3vMRiqm+HY60KEjKbrgypqNU3J0K0aOddQz5kA0mqTRGvaO00jFY9NOOgpPdgg+ZSHzMWi9MhQLNQGOvlC7UuzIF3QtemjEuXCMZKRhsOs5HAM50lOtbL3fQ7pqbSN1h3pI5kyP9hg220KE8wvz7HDm7fSy6+CTW3UTbwAQpT+LX5mEfXzMcvBanrbtSkTzDkE47KM4BAFLsjw72hPe9w4/9xwS5pH9CVoJdxmrc0QdZV+M6N3UJGt6ZX2wkGohRKHpcFWPjYk59CRfZsuDkwsIrok4UqPIjXSw1aZt5ABd6/L/XFMe1C+zdDW3IfxtIY0dwaHjg5WSpk2if0WpqH6XMrHW/0E/CdmWuMEnO1MSdla4GuSuad02Fm/Gr3XmTmiO6ycaHSAF6MOMHt1LuT7y7IKkG4dLfxwDMVese7EhVRzyooSFzO+ua3mb5M0phg6JpsJuNiqsrpqU7MEHBSiISTOuJvi0Kj6bZKaAMFvfQ7i28+CxM1J/MUKpaTcRheD5ZQFM/IDoprMdSQ3RgELZgJNrIO4bX2BXGhJ7muMCAivziPoIfvb6aOrs0j0n2KQfmtMu0gVIsEmzrkbhQAzpn4GuLWWtdQvyyb661hc1zeDit2xhxhlajJf+sjl3ByLr6YfFhrfuCuFbUs2YFIFU8A2OJQxMxwwfy/+fPRFbVxQ8w2Kt7n8by6rsRJO8Y17tV1bN4wKv7YjN5H96rdr9ZjfP2rKQ1FXz86rgYGb5sdlwiJZVU+Hihig/Z1mNJ7NsQ== - paymentMethodType: giropay - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmQgfOTBDykhDXfJNaKhivpSOfYGUINNbINKf30Nl4uq6iRrbc2sdmd2fZKEs0QwwGUtRUsGm3ZSAqfDBKZFbjcgaUW4XlIqOq7xAZTe3bA7mXENpSS6FtzRQws42aTJ76fi8PaY-knzLPlvZg9SmRsH6E7ncIaxP2ClZc3Lb4TuJF8RTfBi4YZuFC8C148i31vdc57rEj9t5z1p1vylPJ42u*TYlvu9116LV729Bo9n*qxZej4G-sryHoTlr2xjugFjr5ncuQghW4Iq8i2utG4tf2l5a3MugpJLJZQ2SIxiZCBaAX0XnVaVaFuQBlEg*5qCMs-937IZp6IxPnJgtQSqDdO7-8rdcnagK8Esf-1j1Ebd92FbXiinIRhthhrVmUbBKDAYJZowiE7OTMOW8MEx9wQ6jmMrUOOkX8ilZrUesIc8d4bmMxQf3NA4cmMTgujVvnkZtyQJHbeEU1NoVAa2eq-59C-a7uT0nnNbRBRGUeTG-tz5zPqjf-gVsrgfUq9afrxRVlUfBcqKz-P8ur2mm21awsCY*AIZ*9oT - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCbCocr/c9RDB3l3GwHQ9ZghYfXrXmiHFU1DYCUvyD9+CzOhDaqzKmrU8In313x6Cn8UAB6HG2ndmAMVDoB7yWEVu9LDTMd2pmnolKLdUPbz8Ab9nYLs6Ne4VrkUIiErz4vw91CXOfK4UamqHjiec7Su/z9RwzvnLOK3nRJTO9tPu7hz2VzZzAXuzVOEmRNFScq8jVU7a4YnW6h9CniosKnFdZksMQ5bWPwf5ZjiOTsESt0KCgmIoptLEpWbVFERbpO42HmHhF5eZyYxX61VJJ/Wb/wxDnADFUAc8e2SrRWaM3Wrz3KOLe8tDP1w52xgY6cJjH1x7RpusscaZuyGj6MC7ymlS74wcEZ4MQLo0sxmCh3SSUnYGmRHcC3HH+FN7zfy631OSzyiJ1ZJ+bzVtpB6W3odoby2HkaSLxp3nbMYKf1QnxBEsckDg+0KIGa5PUiYma8vpLGtCACVi1F5bHgRFQM2AMRyqmhqrIGOHcdBgTnVkbzOpxjr6ywrFJNLvwr6k0Gpq2uymNohJ1Zl7mWs6hJMs+c54J5OflHsE24NPflw5aEXnkEcfOwotZnzcpXklNFVQ2Yp75z3DbvEw8M6u/OrKmLCFJp2d7O4vbtyMEOQkxGkbpeKa6jJAE6IVd+XjQwG/joTJkLT0LyRSjJoZPbikljkUa5WON6G85kZRD1DgwIWdPsm3DaSqRWTgSxAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWrq3BQxMlca+NqR0+uuqFcq12blP+pz9Al1HE3vMRiqm+HY60KEjKbrgypqNU3J0K0aOddQz5kA0mqTRGvaO00jFY9NOOgpPdgg+ZSHzMWi9MhQLNQGOvlC7UuzIF3QtemjEuXCMZKRhsOs5HAM50lOtbL3fQ7pqbSN1h3pI5kyP9hg220KE8wvz7HDm7fSy6+CTW3UTbwAQpT+LX5mEfXzMcvBanrbtSkTzDkE47KM4BAFLsjw72hPe9w4/9xwS5pH9CVoJdxmrc0QdZV+M6N3UJGt6ZX2wkGohRKHpcFWPjYk59CRfZsuDkwsIrok4UqPIjXSw1aZt5ABd6/L/XFMe1C+zdDW3IfxtIY0dwaHjg5WSpk2if0WpqH6XMrHW/0E/CdmWuMEnO1MSdla4GuSuad02Fm/Gr3XmTmiO6ycaHSAF6MOMHt1LuT7y7IKkG4dLfxwDMVese7EhVRzyooSFzO+ua3mb5M0phg6JpsJuNiqsrpqU7MEHBSiISTOuJvi0Kj6bZKaAMFvfQ7i28+CxM1J/MUKpaTcRheD5ZQFM/IDoprMdSQ3RgELZgJNrIO4bX2BXGhJ7muMCAivziPoIfvb6aOrs0j0n2KQfmtMu0gVIsEmzrkbhQAzpn4GuLWWtdQvyyb661hc1zeDit2xhxhlajJf+sjl3ByLr6YfFhrfuCuFbUs2YFIFU8A2OJQxMxwwfy/+fPRFbVxQ8w2Kt7n8by6rsRJO8Y17tV1bN4wKv7YjN5H96rdr9ZjfP2rKQ1FXz86rgYGb5sdlwiJZVU+Hihig/Z1mNJ7NsQ== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmQgfOTBDykhDXfJNaKhivpSOfYGUINNbINKf30Nl4uq6iRrbc2sdmd2fZKEs0QwwGUtRUsGm3ZSAqfDBKZFbjcgaUW4XlIqOq7xAZTe3bA7mXENpSS6FtzRQws42aTJ76fi8PaY-knzLPlvZg9SmRsH6E7ncIaxP2ClZc3Lb4TuJF8RTfBi4YZuFC8C148i31vdc57rEj9t5z1p1vylPJ42u*TYlvu9116LV729Bo9n*qxZej4G-sryHoTlr2xjugFjr5ncuQghW4Iq8i2utG4tf2l5a3MugpJLJZQ2SIxiZCBaAX0XnVaVaFuQBlEg*5qCMs-937IZp6IxPnJgtQSqDdO7-8rdcnagK8Esf-1j1Ebd92FbXiinIRhthhrVmUbBKDAYJZowiE7OTMOW8MEx9wQ6jmMrUOOkX8ilZrUesIc8d4bmMxQf3NA4cmMTgujVvnkZtyQJHbeEU1NoVAa2eq-59C-a7uT0nnNbRBRGUeTG-tz5zPqjf-gVsrgfUq9afrxRVlUfBcqKz-P8ur2mm21awsCY*AIZ*9oT post-payments-googlepay: summary: Make a Google Pay payment value: @@ -12412,23 +10415,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgAgejLrmL/1NDgt5UM/kotd4pBlzIhQUUCnCx5fErtiyUQRIlz9Cxtt0craQ9k7KXqofIKsziPtvdX+spifXXOP1Xve6ycq9s1x5kH9kLLMcoFl34XCAeRKd64rrPA+1XJpRdM8BKzhy7lpx7NzOParV0h3ZfEJ00XzgSJjd5K6aedZSUGJSQQ97NSFfRQgthSQp3Y/qI8t40tDoOkVuL1/bhbJsAYqyWNTsfgtYS/RPO7351b5iDAwtUysUvIkWHGhhX9Jq2AwlcZMsXA27zjG2CVewSKap96OBU2kzRsOVO1ZDTQXYG2S/thUwKfl/K7N2CcxiDq9aN7euNzIGf1uupwzUfe33u544555l0MbfTAjR979fjXBm/C9zxg3spMdQovWrgCSUvQbMOIg/Xn4swBA4bSI3XtlRzB/DQfgwcbUEStf2c0dP0hPTTkYD50bT1kMdLHf/2csG7WlCJJn29DhUlhcoYDfgMkXyLng+Ae0bh+QGSxECMDnnPNLtpwWkxZwux4v5tRXLEiyRcUmDGHtBohBFsbTv9lU7BXaTW+fmFM35R7Afb7aUgGkxMbM9ZcDua2Lwg8WgHVx+bkK2lcQa3OGAEtYgEMC463GWsGO+x2CKzZ86yuNJTVypm9tCLwkVef55j2RWsbLjU7A6dEYf6HQFMUgl1vmFCnqZxCr/Lhb5Sy5CqQliBEcHCguAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUb1EXocZXF+ooYwdH65WLMWSoxifyCpyba1GNrz+on79V6FSg8rCV/n2h8AWsX/93aQilNkCHomaIkYHqXbl86yJokDAYutjLB9ay5Lw7IAqUdCntYbB08d1AnA6LE5/WQ+mbSslr/BcBDYybHw4dXXV00qZv4FBrfoi5seZyq4WQHzTb62KVELKRPgAFdSFOjRKXYt784MNPTM2pFWfDHXUseMFx6Ipr+bIH+KVxfxOza75T8e2jzwYFzKOQwX3MefJbjzudbC99AGWj1uBRnD9KcxttL8QqAA3OI52qmo8kj49fGqK+PPNcRwYM+ziFEG9woBOiwKOilubtTDbttZoVtFBh2JCWJGpKPWOtZ0Xu5C7/nJV9fKT0VGM1HdfOgMOC/OuOzv9M8oTzF17KhxB7YXbZ9Wwlh98E3tmJk/LABE73ccVCs1CJZYq3NgMshqoxcfvfubrOPLHlEthSSvK7X/w10m4HCBwyqLDQmDAoeJGNltHQHEQPLq8PuhYkOZ8SGEEMCyKTGBjAvLAYl0B9lWA6djhHTtI/5zia/kZODivv7z0BtjeUBBs2KpEvEs7WbjhIN4okqp5aleI7Y6zTAUUueJ/mP81GVdlmr27PUahOH2aMXO6s0m8ffT3X98B+M/HEpIk3eVZmRoIEirv3CZ7+lfG65sJe8ukjxlC574a+QIu/rrXECOUj+dSKyD+z1vAXVtAoORDy1TkrK6bWDV7iEEe/qlhg3Ih1YBqoDnUcKlbVME0lVj7VX5OHtw5CN65bUrYBdkF88ycc3Rsblsf7CMSuA= - paymentMethodType: ideal - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUttuozAQ-ZrwFmRDuOTBDyihDd20u6JhL32pHHsCVhOb2oaGfP0aNhtVq5WssXXOaOacGe81lXylOBDBgR491mkNkg0TlFelJ4zpQBecYBxg7wSaNVTajDHVSUt2YOzjFbuRhbRQa2qFkr4dWiCrTb768rXavd7nT3lZrP6b2YM27iYRutElHGBUA8RYLWT9ibCdlmtqKVkucYyTdBnhKEzCxcMt51nU5FeGQXycTL7v03OWUl3*ODSXl-p*i9tN8oGf1rPgLkdWB0mgZuHaa*lwAmfvNLnDCCFPg6nKLWmsbWdh5vLdOSpGj40y1iEpSpGDWAPsTXXWNKptQTvEgO4FA*Oe3-6ULSRTJ*ejBC40MOuYHv8td815BNsoPgvv-hm1U-d52LMg1tMQnDZHjepco2gUGI0SXRhUp*euYUvl4Lt7An3f9wyYcdLf6VFwYQcSoADP0WKO0h2OnSO8HEP44l29jFvSlI1bIrkrNCoDz7wJOf2Sttv7feBfF5HESZLgNFz4l6L-Ge4eYp72Qx402fmV8aY5V6ioLofF*-Y932zzGgbO1W9o9N0x - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgAgejLrmL/1NDgt5UM/kotd4pBlzIhQUUCnCx5fErtiyUQRIlz9Cxtt0craQ9k7KXqofIKsziPtvdX+spifXXOP1Xve6ycq9s1x5kH9kLLMcoFl34XCAeRKd64rrPA+1XJpRdM8BKzhy7lpx7NzOParV0h3ZfEJ00XzgSJjd5K6aedZSUGJSQQ97NSFfRQgthSQp3Y/qI8t40tDoOkVuL1/bhbJsAYqyWNTsfgtYS/RPO7351b5iDAwtUysUvIkWHGhhX9Jq2AwlcZMsXA27zjG2CVewSKap96OBU2kzRsOVO1ZDTQXYG2S/thUwKfl/K7N2CcxiDq9aN7euNzIGf1uupwzUfe33u544555l0MbfTAjR979fjXBm/C9zxg3spMdQovWrgCSUvQbMOIg/Xn4swBA4bSI3XtlRzB/DQfgwcbUEStf2c0dP0hPTTkYD50bT1kMdLHf/2csG7WlCJJn29DhUlhcoYDfgMkXyLng+Ae0bh+QGSxECMDnnPNLtpwWkxZwux4v5tRXLEiyRcUmDGHtBohBFsbTv9lU7BXaTW+fmFM35R7Afb7aUgGkxMbM9ZcDua2Lwg8WgHVx+bkK2lcQa3OGAEtYgEMC463GWsGO+x2CKzZ86yuNJTVypm9tCLwkVef55j2RWsbLjU7A6dEYf6HQFMUgl1vmFCnqZxCr/Lhb5Sy5CqQliBEcHCguAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUb1EXocZXF+ooYwdH65WLMWSoxifyCpyba1GNrz+on79V6FSg8rCV/n2h8AWsX/93aQilNkCHomaIkYHqXbl86yJokDAYutjLB9ay5Lw7IAqUdCntYbB08d1AnA6LE5/WQ+mbSslr/BcBDYybHw4dXXV00qZv4FBrfoi5seZyq4WQHzTb62KVELKRPgAFdSFOjRKXYt784MNPTM2pFWfDHXUseMFx6Ipr+bIH+KVxfxOza75T8e2jzwYFzKOQwX3MefJbjzudbC99AGWj1uBRnD9KcxttL8QqAA3OI52qmo8kj49fGqK+PPNcRwYM+ziFEG9woBOiwKOilubtTDbttZoVtFBh2JCWJGpKPWOtZ0Xu5C7/nJV9fKT0VGM1HdfOgMOC/OuOzv9M8oTzF17KhxB7YXbZ9Wwlh98E3tmJk/LABE73ccVCs1CJZYq3NgMshqoxcfvfubrOPLHlEthSSvK7X/w10m4HCBwyqLDQmDAoeJGNltHQHEQPLq8PuhYkOZ8SGEEMCyKTGBjAvLAYl0B9lWA6djhHTtI/5zia/kZODivv7z0BtjeUBBs2KpEvEs7WbjhIN4okqp5aleI7Y6zTAUUueJ/mP81GVdlmr27PUahOH2aMXO6s0m8ffT3X98B+M/HEpIk3eVZmRoIEirv3CZ7+lfG65sJe8ukjxlC574a+QIu/rrXECOUj+dSKyD+z1vAXVtAoORDy1TkrK6bWDV7iEEe/qlhg3Ih1YBqoDnUcKlbVME0lVj7VX5OHtw5CN65bUrYBdkF88ycc3Rsblsf7CMSuA= - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUttuozAQ-ZrwFmRDuOTBDyihDd20u6JhL32pHHsCVhOb2oaGfP0aNhtVq5WssXXOaOacGe81lXylOBDBgR491mkNkg0TlFelJ4zpQBecYBxg7wSaNVTajDHVSUt2YOzjFbuRhbRQa2qFkr4dWiCrTb768rXavd7nT3lZrP6b2YM27iYRutElHGBUA8RYLWT9ibCdlmtqKVkucYyTdBnhKEzCxcMt51nU5FeGQXycTL7v03OWUl3*ODSXl-p*i9tN8oGf1rPgLkdWB0mgZuHaa*lwAmfvNLnDCCFPg6nKLWmsbWdh5vLdOSpGj40y1iEpSpGDWAPsTXXWNKptQTvEgO4FA*Oe3-6ULSRTJ*ejBC40MOuYHv8td815BNsoPgvv-hm1U-d52LMg1tMQnDZHjepco2gUGI0SXRhUp*euYUvl4Lt7An3f9wyYcdLf6VFwYQcSoADP0WKO0h2OnSO8HEP44l29jFvSlI1bIrkrNCoDz7wJOf2Sttv7feBfF5HESZLgNFz4l6L-Ge4eYp72Qx402fmV8aY5V6ioLofF*-Y932zzGgbO1W9o9N0x post-payments-klarna: summary: Make a Klarna payment value: @@ -12539,23 +10525,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgB0+dPV+fRwAnBXX+A2fGzbbXVRuCdq7CQ2x0107iwt/hUloD+MgxZ8BEmOHmKpXNkPDSl6YuZKSxT+tpQszNY4HL2ooTPGHjHHpGNS9+No4+z70mFkvdV2u9G7mJx16dWSSBOCvY2bvBVVrLTnxv7HNEl4ciqdivSmpLE5Y3IqlXHqMv7eibbmhUe7OWSE/Kl7vSb5iq49u21ip7Xj6s+uhi28zrrhDClCYooIewYBPBWFYOgs6Wqx5LkjDkxdig9UAiQYTKtm+IjTxkonidPrvOlo/oDWISUsCU2Kv4LlyaIQDIVPTJkEnJVvP6RjikNs0f5i+I21DTv7q70A5IEoQvayTyg2eEhJBZXmCA+e/kUXK9VSjSKbX0zZ9Go1H3xpWmd1xj6VLgwA34NwqHNzW63nmndTp90i+UcFj4ZPgHkV+p59XgNYHCWFjD+qtv1CwumniUBwQYbgAhwGC/nn0Y7uPAUVE4fH3sJQiV0I40K8UHwusxXTC6wP6E2qwrNTEm3Mf4eOqsmb2eUd81GFHPQsEasuh7mvm17jKRrfBuQmZ0h91iQBioMwkaKvg7n8nQk+lGWrnEQoH4tjqedLxPngjeBCLEj0uKGYyYeYEf0GcVI+jOPt3wR8ejqxvUJ47A0eny7aW5jgQCyBxkxR9ZgihQDKlWO0axPX+KLYKxAU+qeI98YXz36/BUIxgKtRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaFmjTYWP/sjHxcxXylNifxOVm6oe9j8aPFuUzrkec+MxKOPix4gHG0s00F+secwtzas3aCRLH62FpTHhwQhfeSp40paazBADS9cMbgDVk2gsgmNSS1dFWO+iWqlB3mX52mS1wOFnWkOxwkWUskqKygIigxyQsxQ8oggvccTUUbeRVSV3K+NqBz+Pru3xCoEvoAxBjDOEqGoPHA/umMU2ue3CVCu5TMOV831hj97mzKSxHtzf/KAs5LGr54AHFZxOuukTx4mVHr69F8MNNqCaCTTBYg1ZZdBCxsIejZvWHkzez6/qghPzoByZcLpUJ8REc5xQvZ0AXSQ2dwrKg9d4VmCAmqxj3lkErpjoYSp5CT4QCVDUm32JvVTCAeCm5msz9f7rVJrUZElRdt0iWsX4YeqU/SPt0BMnzLfTQgXeaT29cuHRnMVJE/ky69LdiMbbEWPWY3W9Ygw606RvXu2GSADJa0vDm+nfDdRjlA7jZxddiATjrvbPCQVdLVddwi6xEA5Of0JIh+ZD7RAfp39kGILHNLnjcxWSprZa5rZulZX6yiBvRYgAb6zB6bEa+i/gWvLEYka8GgBl+NLnZC+hcpEJ0gP5a5bjEmMpd1IrgDSHF0SzXbLLOZKVy5JBy/9IZr3cNcEF31tU4+RudvAVaWAkZmer18O+DVh+Ctu6NLzCS0OvGpt40UMAPRQoQor/UldSKl5KU0nhG+7usZnJPuKwVlXmlYpTdv5kUYxfsnJ0ArplK4N47pB9UFhMY23gTPzd8MECtoCbEnxCIkHOTgEwup7JnphbT6b3W7XV30= - paymentMethodType: directEbanking - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUlGPojAQ-jXwJimggA99cBGF1fUMpxv3Xja1jEBWW2wLkf3127Ked7lcQjpkvunM933ToyCsiHkBuKgFUJUcCfuoWWnTVghgtB*wZJ-bFxC0IkzNKOUtU3gHUr3ccw8wYwpKQVTNmaP6BnCcJvHqx373vkw2SZ7F-63sQEgd8QQ94BxOYOYDlkoYPn8A1Qo2J4rg6dQN3DCaTkzwo9Wj5mdd4qrvxqmvlrdtdHgt8*vT83KTHixvId-ylMHq7bQpW7mYW95TvJ1Jy5-bDekvoAVeBn0uQsgWIPf5GldKNZY-07f1d*aUnCsulc5EKEI6RSugH7xVsuJNA8JMAdHVFKT*3X63zRjlF60kh2*nNdK5v9vda15AVbyw-MU-Zmt2f9tteYEYbNDcNGTY6UETQ3BiKOqj560Y6YENYb2j45B0HMeWII3Xr*RcF7XqsYc8d4TGIxTt3EArcqf68Nxf9l2L2ZMg1OwJJ7qRYQa21G9keBlNe3Q6z7mvIgzCMHQjf*x8Zt3B3z0HRdT1iVfNbu*0qKrbHmX7z9P4ur4m6TopoS8K-gXEVtz2 - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB0+dPV+fRwAnBXX+A2fGzbbXVRuCdq7CQ2x0107iwt/hUloD+MgxZ8BEmOHmKpXNkPDSl6YuZKSxT+tpQszNY4HL2ooTPGHjHHpGNS9+No4+z70mFkvdV2u9G7mJx16dWSSBOCvY2bvBVVrLTnxv7HNEl4ciqdivSmpLE5Y3IqlXHqMv7eibbmhUe7OWSE/Kl7vSb5iq49u21ip7Xj6s+uhi28zrrhDClCYooIewYBPBWFYOgs6Wqx5LkjDkxdig9UAiQYTKtm+IjTxkonidPrvOlo/oDWISUsCU2Kv4LlyaIQDIVPTJkEnJVvP6RjikNs0f5i+I21DTv7q70A5IEoQvayTyg2eEhJBZXmCA+e/kUXK9VSjSKbX0zZ9Go1H3xpWmd1xj6VLgwA34NwqHNzW63nmndTp90i+UcFj4ZPgHkV+p59XgNYHCWFjD+qtv1CwumniUBwQYbgAhwGC/nn0Y7uPAUVE4fH3sJQiV0I40K8UHwusxXTC6wP6E2qwrNTEm3Mf4eOqsmb2eUd81GFHPQsEasuh7mvm17jKRrfBuQmZ0h91iQBioMwkaKvg7n8nQk+lGWrnEQoH4tjqedLxPngjeBCLEj0uKGYyYeYEf0GcVI+jOPt3wR8ejqxvUJ47A0eny7aW5jgQCyBxkxR9ZgihQDKlWO0axPX+KLYKxAU+qeI98YXz36/BUIxgKtRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaFmjTYWP/sjHxcxXylNifxOVm6oe9j8aPFuUzrkec+MxKOPix4gHG0s00F+secwtzas3aCRLH62FpTHhwQhfeSp40paazBADS9cMbgDVk2gsgmNSS1dFWO+iWqlB3mX52mS1wOFnWkOxwkWUskqKygIigxyQsxQ8oggvccTUUbeRVSV3K+NqBz+Pru3xCoEvoAxBjDOEqGoPHA/umMU2ue3CVCu5TMOV831hj97mzKSxHtzf/KAs5LGr54AHFZxOuukTx4mVHr69F8MNNqCaCTTBYg1ZZdBCxsIejZvWHkzez6/qghPzoByZcLpUJ8REc5xQvZ0AXSQ2dwrKg9d4VmCAmqxj3lkErpjoYSp5CT4QCVDUm32JvVTCAeCm5msz9f7rVJrUZElRdt0iWsX4YeqU/SPt0BMnzLfTQgXeaT29cuHRnMVJE/ky69LdiMbbEWPWY3W9Ygw606RvXu2GSADJa0vDm+nfDdRjlA7jZxddiATjrvbPCQVdLVddwi6xEA5Of0JIh+ZD7RAfp39kGILHNLnjcxWSprZa5rZulZX6yiBvRYgAb6zB6bEa+i/gWvLEYka8GgBl+NLnZC+hcpEJ0gP5a5bjEmMpd1IrgDSHF0SzXbLLOZKVy5JBy/9IZr3cNcEF31tU4+RudvAVaWAkZmer18O+DVh+Ctu6NLzCS0OvGpt40UMAPRQoQor/UldSKl5KU0nhG+7usZnJPuKwVlXmlYpTdv5kUYxfsnJ0ArplK4N47pB9UFhMY23gTPzd8MECtoCbEnxCIkHOTgEwup7JnphbT6b3W7XV30= - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUlGPojAQ-jXwJimggA99cBGF1fUMpxv3Xja1jEBWW2wLkf3127Ked7lcQjpkvunM933ToyCsiHkBuKgFUJUcCfuoWWnTVghgtB*wZJ-bFxC0IkzNKOUtU3gHUr3ccw8wYwpKQVTNmaP6BnCcJvHqx373vkw2SZ7F-63sQEgd8QQ94BxOYOYDlkoYPn8A1Qo2J4rg6dQN3DCaTkzwo9Wj5mdd4qrvxqmvlrdtdHgt8*vT83KTHixvId-ylMHq7bQpW7mYW95TvJ1Jy5-bDekvoAVeBn0uQsgWIPf5GldKNZY-07f1d*aUnCsulc5EKEI6RSugH7xVsuJNA8JMAdHVFKT*3X63zRjlF60kh2*nNdK5v9vda15AVbyw-MU-Zmt2f9tteYEYbNDcNGTY6UETQ3BiKOqj560Y6YENYb2j45B0HMeWII3Xr*RcF7XqsYc8d4TGIxTt3EArcqf68Nxf9l2L2ZMg1OwJJ7qRYQa21G9keBlNe3Q6z7mvIgzCMHQjf*x8Zt3B3z0HRdT1iVfNbu*0qKrbHmX7z9P4ur4m6TopoS8K-gXEVtz2 post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: @@ -12584,26 +10553,6 @@ components: type: Commission reference: '6124146' post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - post-payments-subscription-first-transaction-200: summary: Example response for request 'subscription-first-transaction' value: additionalData: diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index b41461b9..ff8a761d 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1025,28 +1047,28 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' - subscription-first-transaction-200: - $ref: '#/components/examples/post-payments-subscription-first-transaction-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-SF: + $ref: '#/components/examples/post-payments-enableOneClick-SF' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1057,8 +1079,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1066,8 +1088,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1075,8 +1097,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1084,8 +1106,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1096,13 +1118,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1147,8 +1171,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1156,8 +1180,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1165,8 +1189,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1174,8 +1198,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1186,13 +1210,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1229,8 +1255,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1238,8 +1264,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1247,8 +1273,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1256,8 +1282,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1268,13 +1294,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1333,8 +1361,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1342,8 +1370,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1351,8 +1379,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1360,8 +1388,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1372,13 +1400,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1440,8 +1470,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1449,8 +1479,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1458,8 +1488,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1467,8 +1497,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1479,13 +1509,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1543,8 +1575,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1552,8 +1584,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1561,8 +1593,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1570,8 +1602,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1582,13 +1614,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1646,8 +1680,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1655,8 +1689,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1664,8 +1698,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1673,8 +1707,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1685,13 +1719,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1750,8 +1786,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1759,8 +1795,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1768,8 +1804,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1777,8 +1813,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1789,8 +1825,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1848,7 +1884,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -2002,13 +2038,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -2553,6 +2589,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -3026,19 +3070,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3264,68 +3295,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3511,13 +3480,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3588,13 +3557,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3655,13 +3624,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3678,7 +3647,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3717,7 +3686,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3744,13 +3713,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3768,41 +3737,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3939,7 +3908,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -3950,7 +3919,7 @@ components: in India. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -4026,7 +3995,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4071,12 +4040,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4092,13 +4061,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4112,7 +4081,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4123,13 +4092,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4140,12 +4109,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4155,7 +4124,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4170,14 +4139,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4209,7 +4178,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4303,12 +4272,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4324,11 +4293,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4336,36 +4305,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4798,7 +4769,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4909,7 +4880,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4930,7 +4901,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -5066,7 +5037,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5158,7 +5129,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead. @@ -5230,7 +5201,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5487,13 +5458,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5511,13 +5482,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5544,13 +5515,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5572,13 +5543,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5680,13 +5651,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5755,14 +5726,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -6010,13 +5973,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6038,13 +6001,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6068,7 +6031,7 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -6078,7 +6041,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6110,13 +6073,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6355,7 +6318,7 @@ components: PaymentDetailsResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. oneOf: @@ -6379,7 +6342,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -6395,7 +6358,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -6433,7 +6396,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6487,7 +6450,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6546,7 +6509,7 @@ components: link is created. type: string id: - x-addedInVersion: 51 + x-addedInVersion: '51' description: A unique identifier of the payment link. readOnly: true type: string @@ -6555,7 +6518,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6640,7 +6603,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. type: boolean @@ -6658,7 +6621,7 @@ components: PaymentMethod: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -6748,7 +6711,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6764,7 +6727,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6793,7 +6756,7 @@ components: description: The shopper's country code. type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -6803,7 +6766,7 @@ components: the transaction. type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6814,8 +6777,10 @@ components: > This field is required for recurring payments.' type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6840,7 +6805,7 @@ components: $ref: '#/components/schemas/PaymentMethod' type: array storedPaymentMethods: - x-addedInVersion: 49 + x-addedInVersion: '49' description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' @@ -6885,7 +6850,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6923,12 +6888,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6944,7 +6909,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6969,11 +6934,11 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -6986,7 +6951,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7000,7 +6965,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7011,35 +6976,35 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7051,17 +7016,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7069,7 +7034,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7079,7 +7044,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7094,14 +7059,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7131,7 +7096,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -7192,7 +7157,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -7209,12 +7174,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -7311,12 +7276,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7332,11 +7297,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7344,34 +7309,36 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7383,7 +7350,7 @@ components: PaymentResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' @@ -7415,7 +7382,7 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -7431,7 +7398,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' 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. @@ -7477,7 +7444,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7528,7 +7495,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7587,7 +7554,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7603,12 +7570,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7616,7 +7583,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7627,7 +7594,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7652,14 +7619,14 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7672,7 +7639,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7686,7 +7653,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7697,29 +7664,29 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7731,17 +7698,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7749,7 +7716,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7759,7 +7726,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7774,7 +7741,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7848,7 +7815,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7908,12 +7875,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7929,11 +7896,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7941,22 +7908,24 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. @@ -7968,7 +7937,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -8047,7 +8016,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -8136,13 +8105,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8175,18 +8144,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -8195,7 +8164,7 @@ components: RecurringDetail: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -8276,6 +8245,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8588,6 +8560,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8671,7 +8675,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8686,11 +8690,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -8973,7 +8977,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -8982,7 +8986,7 @@ components: description: The payload you received from the Samsung Pay SDK response. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9006,13 +9010,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9029,7 +9033,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -9260,13 +9264,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9284,7 +9288,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -9319,13 +9322,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -9333,7 +9336,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -9375,14 +9378,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -9439,7 +9442,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -9461,7 +9464,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -9471,7 +9474,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -9484,7 +9487,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -9495,7 +9498,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -9513,7 +9516,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDSecureData: @@ -9556,7 +9559,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -9564,7 +9567,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9593,7 +9596,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9603,7 +9606,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9625,13 +9628,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9704,13 +9707,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9745,43 +9748,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9799,20 +9773,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9821,17 +9781,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9839,11 +9788,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9851,13 +9795,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9884,15 +9821,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -9910,39 +9838,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -9983,6 +9934,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -10008,1867 +9960,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -12011,6 +10149,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -12027,24 +10174,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12092,22 +10221,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12164,21 +10277,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: 097410 - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VHQOF - pspReference: 993617895214576G - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -12199,21 +10297,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 054817 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VIO26 - pspReference: 993617895217578K - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -12234,21 +10317,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '046773' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCAVH - pspReference: 993617895196572H - resultCode: Authorised - merchantReference: string post-payments-card-direct: summary: Make a card payment value: @@ -12265,37 +10333,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 044925 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VEP3H - pspReference: 993617895204576J - resultCode: Authorised - merchantReference: string post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -12336,25 +10374,6 @@ components: details: redirectResult: X6XtfGC3!Y... post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF-200: summary: Example response for request 'enableOneClick-SF' value: additionalData: @@ -12392,24 +10411,6 @@ components: storePaymentMethod: true returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: '003704' - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCKO0 - pspReference: 993617895197573E - resultCode: Authorised - merchantReference: string post-payments-giropay: summary: Make a giropay payment value: @@ -12421,23 +10422,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - paymentMethodType: giropay - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA post-payments-googlepay: summary: Make a Google Pay payment value: @@ -12462,23 +10446,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - paymentMethodType: ideal - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ post-payments-klarna: summary: Make a Klarna payment value: @@ -12589,23 +10556,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - paymentMethodType: directEbanking - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: @@ -12634,26 +10584,6 @@ components: type: Commission reference: '6124146' post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-subscription-first-transaction-200: summary: Example response for request 'subscription-first-transaction' value: additionalData: diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 840dfddd..3f8e0125 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1025,28 +1047,28 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' - subscription-first-transaction-200: - $ref: '#/components/examples/post-payments-subscription-first-transaction-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-SF: + $ref: '#/components/examples/post-payments-enableOneClick-SF' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1057,8 +1079,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1066,8 +1088,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1075,8 +1097,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1084,8 +1106,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1096,13 +1118,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1147,8 +1171,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1156,8 +1180,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1165,8 +1189,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1174,8 +1198,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1186,13 +1210,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1229,8 +1255,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1238,8 +1264,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1247,8 +1273,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1256,8 +1282,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1268,13 +1294,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1333,8 +1361,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1342,8 +1370,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1351,8 +1379,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1360,8 +1388,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1372,13 +1400,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1440,8 +1470,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1449,8 +1479,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1458,8 +1488,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1467,8 +1497,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1479,13 +1509,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1543,8 +1575,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1552,8 +1584,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1561,8 +1593,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1570,8 +1602,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1582,13 +1614,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1646,8 +1680,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1655,8 +1689,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1664,8 +1698,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1673,8 +1707,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1685,13 +1719,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1750,8 +1786,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1759,8 +1795,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1768,8 +1804,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1777,8 +1813,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1789,8 +1825,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1848,7 +1884,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -2002,13 +2038,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -2553,6 +2589,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -3026,19 +3070,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3264,68 +3295,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3511,13 +3480,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3588,13 +3557,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3655,13 +3624,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3678,7 +3647,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3717,7 +3686,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3744,13 +3713,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3768,41 +3737,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3939,7 +3908,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -3950,7 +3919,7 @@ components: in India. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -4026,7 +3995,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4071,12 +4040,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4092,13 +4061,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4112,7 +4081,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4123,13 +4092,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4140,12 +4109,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4155,7 +4124,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4170,14 +4139,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4209,7 +4178,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4303,12 +4272,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4324,11 +4293,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4336,36 +4305,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4798,7 +4769,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4909,7 +4880,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4930,7 +4901,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -5066,7 +5037,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5158,7 +5129,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead. @@ -5230,7 +5201,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5487,13 +5458,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5511,13 +5482,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5544,13 +5515,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5572,13 +5543,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5680,13 +5651,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5755,14 +5726,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -6010,13 +5973,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6038,13 +6001,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6068,7 +6031,7 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -6078,7 +6041,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6110,13 +6073,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6355,7 +6318,7 @@ components: PaymentDetailsResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. oneOf: @@ -6379,11 +6342,11 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -6399,7 +6362,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -6437,7 +6400,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6491,7 +6454,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6550,7 +6513,7 @@ components: link is created. type: string id: - x-addedInVersion: 51 + x-addedInVersion: '51' description: A unique identifier of the payment link. readOnly: true type: string @@ -6559,7 +6522,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6644,7 +6607,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. type: boolean @@ -6662,7 +6625,7 @@ components: PaymentMethod: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -6752,7 +6715,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6768,7 +6731,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6797,7 +6760,7 @@ components: description: The shopper's country code. type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -6807,7 +6770,7 @@ components: the transaction. type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6818,8 +6781,10 @@ components: > This field is required for recurring payments.' type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6844,7 +6809,7 @@ components: $ref: '#/components/schemas/PaymentMethod' type: array storedPaymentMethods: - x-addedInVersion: 49 + x-addedInVersion: '49' description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' @@ -6889,7 +6854,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6927,12 +6892,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6948,7 +6913,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6973,11 +6938,11 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -6990,7 +6955,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7004,7 +6969,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7015,35 +6980,35 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7055,17 +7020,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7073,7 +7038,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7083,7 +7048,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7098,14 +7063,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7135,7 +7100,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -7196,7 +7161,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -7213,12 +7178,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -7315,12 +7280,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7336,11 +7301,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7348,34 +7313,36 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7387,7 +7354,7 @@ components: PaymentResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' @@ -7419,11 +7386,11 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -7439,7 +7406,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' 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. @@ -7485,7 +7452,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7536,7 +7503,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7595,7 +7562,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7611,12 +7578,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7624,7 +7591,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7635,7 +7602,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7660,14 +7627,14 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7680,7 +7647,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7694,7 +7661,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7705,29 +7672,29 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7739,17 +7706,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7757,7 +7724,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7767,7 +7734,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7782,7 +7749,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7856,7 +7823,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7916,12 +7883,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7937,11 +7904,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7949,22 +7916,24 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. @@ -7976,7 +7945,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -8055,7 +8024,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -8144,13 +8113,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8183,18 +8152,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -8203,7 +8172,7 @@ components: RecurringDetail: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -8284,6 +8253,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8596,6 +8568,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8679,7 +8683,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8694,11 +8698,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -8981,7 +8985,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -8990,7 +8994,7 @@ components: description: The payload you received from the Samsung Pay SDK response. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9014,13 +9018,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9037,7 +9041,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -9268,13 +9272,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9292,7 +9296,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -9327,13 +9330,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -9341,7 +9344,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -9383,14 +9386,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -9447,7 +9450,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -9469,7 +9472,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -9479,7 +9482,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -9492,7 +9495,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -9503,7 +9506,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -9521,7 +9524,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDSecureData: @@ -9564,7 +9567,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -9572,7 +9575,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9601,7 +9604,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9611,7 +9614,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9633,13 +9636,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9712,13 +9715,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9753,43 +9756,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9807,20 +9781,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9829,17 +9789,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9847,11 +9796,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9859,13 +9803,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9892,15 +9829,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -9918,39 +9846,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -9991,6 +9942,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -10016,1867 +9968,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -12019,6 +10157,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -12035,24 +10182,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12100,22 +10229,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12172,21 +10285,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: 097410 - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VHQOF - pspReference: 993617895214576G - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -12207,21 +10305,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 054817 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VIO26 - pspReference: 993617895217578K - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -12242,21 +10325,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '046773' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCAVH - pspReference: 993617895196572H - resultCode: Authorised - merchantReference: string post-payments-card-direct: summary: Make a card payment value: @@ -12273,37 +10341,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 044925 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VEP3H - pspReference: 993617895204576J - resultCode: Authorised - merchantReference: string post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -12344,25 +10382,6 @@ components: details: redirectResult: X6XtfGC3!Y... post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF-200: summary: Example response for request 'enableOneClick-SF' value: additionalData: @@ -12400,24 +10419,6 @@ components: storePaymentMethod: true returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: '003704' - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCKO0 - pspReference: 993617895197573E - resultCode: Authorised - merchantReference: string post-payments-giropay: summary: Make a giropay payment value: @@ -12429,23 +10430,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - paymentMethodType: giropay - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA post-payments-googlepay: summary: Make a Google Pay payment value: @@ -12470,23 +10454,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - paymentMethodType: ideal - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ post-payments-klarna: summary: Make a Klarna payment value: @@ -12597,23 +10564,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - paymentMethodType: directEbanking - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: @@ -12642,26 +10592,6 @@ components: type: Commission reference: '6124146' post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-subscription-first-transaction-200: summary: Example response for request 'subscription-first-transaction' value: additionalData: diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index e58b0a23..9f6d6fbd 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1025,28 +1047,28 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' - subscription-first-transaction-200: - $ref: '#/components/examples/post-payments-subscription-first-transaction-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-SF: + $ref: '#/components/examples/post-payments-enableOneClick-SF' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1057,8 +1079,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1066,8 +1088,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1075,8 +1097,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1084,8 +1106,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1096,13 +1118,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1147,8 +1171,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1156,8 +1180,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1165,8 +1189,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1174,8 +1198,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1186,13 +1210,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1229,8 +1255,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1238,8 +1264,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1247,8 +1273,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1256,8 +1282,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1268,13 +1294,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1333,8 +1361,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1342,8 +1370,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1351,8 +1379,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1360,8 +1388,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1372,13 +1400,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1440,8 +1470,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1449,8 +1479,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1458,8 +1488,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1467,8 +1497,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1479,13 +1509,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1543,8 +1575,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1552,8 +1584,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1561,8 +1593,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1570,8 +1602,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1582,13 +1614,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1646,8 +1680,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1655,8 +1689,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1664,8 +1698,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1673,8 +1707,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1685,13 +1719,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1750,8 +1786,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1759,8 +1795,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1768,8 +1804,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1777,8 +1813,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1789,8 +1825,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1848,7 +1884,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -2002,13 +2038,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -2553,6 +2589,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -3026,19 +3070,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3264,68 +3295,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3511,13 +3480,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3588,13 +3557,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3655,13 +3624,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3678,7 +3647,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3717,7 +3686,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3744,13 +3713,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3768,41 +3737,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3939,7 +3908,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -3950,7 +3919,7 @@ components: in India. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -4026,7 +3995,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4071,12 +4040,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4092,13 +4061,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4112,7 +4081,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4123,13 +4092,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4140,12 +4109,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4155,7 +4124,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4170,14 +4139,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4209,7 +4178,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4303,12 +4272,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4324,11 +4293,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4336,36 +4305,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4798,7 +4769,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4909,7 +4880,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4930,7 +4901,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -5066,7 +5037,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5158,7 +5129,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead. @@ -5230,7 +5201,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5487,13 +5458,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5511,13 +5482,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5544,13 +5515,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5572,13 +5543,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5680,13 +5651,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5755,14 +5726,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -6010,13 +5973,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6038,13 +6001,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6068,7 +6031,7 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -6078,7 +6041,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6110,13 +6073,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6355,7 +6318,7 @@ components: PaymentDetailsResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. oneOf: @@ -6379,11 +6342,11 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -6399,7 +6362,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -6437,7 +6400,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6491,7 +6454,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6550,7 +6513,7 @@ components: link is created. type: string id: - x-addedInVersion: 51 + x-addedInVersion: '51' description: A unique identifier of the payment link. readOnly: true type: string @@ -6559,7 +6522,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6644,7 +6607,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. type: boolean @@ -6662,7 +6625,7 @@ components: PaymentMethod: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -6679,7 +6642,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -6758,7 +6721,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6774,7 +6737,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6803,7 +6766,7 @@ components: description: The shopper's country code. type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -6813,7 +6776,7 @@ components: the transaction. type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6824,14 +6787,16 @@ components: > This field is required for recurring payments.' type: string splitCardFundingSources: - x-addedInVersion: 53 + x-addedInVersion: '53' default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. type: boolean store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6856,7 +6821,7 @@ components: $ref: '#/components/schemas/PaymentMethod' type: array storedPaymentMethods: - x-addedInVersion: 49 + x-addedInVersion: '49' description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' @@ -6901,7 +6866,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6939,12 +6904,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6960,7 +6925,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -6985,11 +6950,11 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7002,7 +6967,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7016,7 +6981,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7027,35 +6992,35 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7067,17 +7032,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7085,7 +7050,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7095,7 +7060,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7110,14 +7075,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7147,7 +7112,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -7208,7 +7173,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -7225,12 +7190,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -7327,12 +7292,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7348,11 +7313,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7360,34 +7325,36 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7399,7 +7366,7 @@ components: PaymentResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' @@ -7431,11 +7398,11 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' additionalProperties: type: string description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` @@ -7451,7 +7418,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' 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. @@ -7497,7 +7464,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7548,7 +7515,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7607,7 +7574,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7623,12 +7590,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7636,7 +7603,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7647,7 +7614,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7672,14 +7639,14 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7692,7 +7659,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7706,7 +7673,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7717,29 +7684,29 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7751,17 +7718,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7769,7 +7736,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7779,7 +7746,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7794,7 +7761,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7868,7 +7835,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7928,12 +7895,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7949,11 +7916,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7961,22 +7928,24 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. @@ -7988,7 +7957,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -8067,7 +8036,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -8156,13 +8125,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8195,18 +8164,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -8215,7 +8184,7 @@ components: RecurringDetail: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -8232,7 +8201,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -8302,6 +8271,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8614,6 +8586,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8697,7 +8701,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8712,11 +8716,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -8999,7 +9003,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9008,7 +9012,7 @@ components: description: The payload you received from the Samsung Pay SDK response. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9032,13 +9036,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9055,7 +9059,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -9286,13 +9290,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9310,7 +9314,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -9345,13 +9348,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -9359,7 +9362,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -9401,14 +9404,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -9465,7 +9468,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -9487,7 +9490,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -9497,7 +9500,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -9510,7 +9513,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -9521,7 +9524,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -9539,7 +9542,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDSecureData: @@ -9582,7 +9585,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -9590,7 +9593,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9619,7 +9622,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9629,7 +9632,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9651,13 +9654,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9730,13 +9733,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9771,43 +9774,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9825,20 +9799,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9847,17 +9807,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9865,11 +9814,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9877,13 +9821,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9910,15 +9847,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -9936,39 +9864,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -10009,6 +9960,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -10034,1867 +9986,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -12037,6 +10175,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -12053,24 +10200,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12118,22 +10247,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12190,21 +10303,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: 097410 - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VHQOF - pspReference: 993617895214576G - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -12225,21 +10323,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 054817 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VIO26 - pspReference: 993617895217578K - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -12260,21 +10343,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '046773' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCAVH - pspReference: 993617895196572H - resultCode: Authorised - merchantReference: string post-payments-card-direct: summary: Make a card payment value: @@ -12291,37 +10359,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 044925 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VEP3H - pspReference: 993617895204576J - resultCode: Authorised - merchantReference: string post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -12362,25 +10400,6 @@ components: details: redirectResult: X6XtfGC3!Y... post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF-200: summary: Example response for request 'enableOneClick-SF' value: additionalData: @@ -12418,24 +10437,6 @@ components: storePaymentMethod: true returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: '003704' - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCKO0 - pspReference: 993617895197573E - resultCode: Authorised - merchantReference: string post-payments-giropay: summary: Make a giropay payment value: @@ -12447,23 +10448,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - paymentMethodType: giropay - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA post-payments-googlepay: summary: Make a Google Pay payment value: @@ -12488,23 +10472,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - paymentMethodType: ideal - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ post-payments-klarna: summary: Make a Klarna payment value: @@ -12615,23 +10582,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - paymentMethodType: directEbanking - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: @@ -12660,26 +10610,6 @@ components: type: Commission reference: '6124146' post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-subscription-first-transaction-200: summary: Example response for request 'subscription-first-transaction' value: additionalData: diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index 47a5ed3e..bcbe8094 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1025,28 +1047,28 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' - subscription-first-transaction-200: - $ref: '#/components/examples/post-payments-subscription-first-transaction-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-SF: + $ref: '#/components/examples/post-payments-enableOneClick-SF' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1057,8 +1079,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1066,8 +1088,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1075,8 +1097,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1084,8 +1106,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1096,13 +1118,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1147,8 +1171,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1156,8 +1180,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1165,8 +1189,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1174,8 +1198,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1186,13 +1210,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1229,8 +1255,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1238,8 +1264,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1247,8 +1273,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1256,8 +1282,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1268,13 +1294,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1333,8 +1361,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1342,8 +1370,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1351,8 +1379,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1360,8 +1388,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1372,13 +1400,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1440,8 +1470,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1449,8 +1479,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1458,8 +1488,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1467,8 +1497,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1479,13 +1509,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1543,8 +1575,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1552,8 +1584,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1561,8 +1593,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1570,8 +1602,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1582,13 +1614,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1646,8 +1680,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1655,8 +1689,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1664,8 +1698,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1673,8 +1707,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1685,13 +1719,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1750,8 +1786,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1759,8 +1795,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1768,8 +1804,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1777,8 +1813,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1789,8 +1825,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1848,7 +1884,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -2002,13 +2038,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -2553,6 +2589,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -3026,19 +3070,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3264,68 +3295,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3511,13 +3480,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3588,13 +3557,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3655,13 +3624,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3678,7 +3647,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3717,7 +3686,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3744,13 +3713,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3768,41 +3737,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3939,7 +3908,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -3950,7 +3919,7 @@ components: in India. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -4026,7 +3995,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4071,12 +4040,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4092,13 +4061,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4112,7 +4081,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4123,13 +4092,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4140,12 +4109,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4155,7 +4124,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4170,14 +4139,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4209,7 +4178,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4303,12 +4272,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4324,11 +4293,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4336,36 +4305,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4798,7 +4769,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4909,7 +4880,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4930,7 +4901,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -5066,7 +5037,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5158,7 +5129,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead. @@ -5230,7 +5201,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5487,13 +5458,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5511,13 +5482,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5544,13 +5515,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5572,13 +5543,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5637,7 +5608,7 @@ components: format: int32 type: integer plans: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -5654,13 +5625,13 @@ components: type: string type: array preselectedValue: - x-addedInVersion: 64 + x-addedInVersion: '64' description: Preselected number of installments offered for this payment method. format: int32 type: integer values: - x-addedInVersion: 64 + x-addedInVersion: '64' description: An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`. @@ -5671,7 +5642,7 @@ components: Installments: properties: plan: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -5727,13 +5698,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5802,14 +5773,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -6057,13 +6020,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6085,13 +6048,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6115,7 +6078,7 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -6125,7 +6088,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6157,13 +6120,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6402,7 +6365,7 @@ components: PaymentDetailsResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. oneOf: @@ -6426,13 +6389,13 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -6441,7 +6404,7 @@ components: type: object details: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' description: When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint. items: @@ -6451,7 +6414,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -6460,7 +6423,7 @@ components: $ref: '#/components/schemas/CheckoutOrderResponse' outputDetails: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -6468,7 +6431,7 @@ components: type: object paymentData: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action.paymentData` instead. description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint. @@ -6483,7 +6446,7 @@ components: type: string redirect: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. description: When the payment flow requires a redirect, this object contains information about the redirect URL. @@ -6498,7 +6461,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6552,7 +6515,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6611,7 +6574,7 @@ components: link is created. type: string id: - x-addedInVersion: 51 + x-addedInVersion: '51' description: A unique identifier of the payment link. readOnly: true type: string @@ -6620,7 +6583,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6705,7 +6668,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. type: boolean @@ -6723,7 +6686,7 @@ components: PaymentMethod: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -6740,7 +6703,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -6819,7 +6782,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6835,7 +6798,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6864,7 +6827,7 @@ components: description: The shopper's country code. type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -6874,12 +6837,12 @@ components: the transaction. type: string order: - x-addedInVersion: 64 + x-addedInVersion: '64' description: Contains the order information which is required for partial payments. $ref: '#/components/schemas/CheckoutOrder' shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6890,14 +6853,16 @@ components: > This field is required for recurring payments.' type: string splitCardFundingSources: - x-addedInVersion: 53 + x-addedInVersion: '53' default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. type: boolean store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6922,7 +6887,7 @@ components: $ref: '#/components/schemas/PaymentMethod' type: array storedPaymentMethods: - x-addedInVersion: 49 + x-addedInVersion: '49' description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' @@ -6967,7 +6932,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -7005,12 +6970,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7026,7 +6991,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7051,11 +7016,11 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7068,7 +7033,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7082,7 +7047,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7093,35 +7058,35 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7133,17 +7098,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7151,7 +7116,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7161,7 +7126,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7176,14 +7141,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7213,7 +7178,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -7274,7 +7239,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -7291,12 +7256,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -7393,12 +7358,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7414,11 +7379,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7426,34 +7391,36 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7465,7 +7432,7 @@ components: PaymentResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' @@ -7497,13 +7464,13 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -7512,7 +7479,7 @@ components: type: object details: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' description: When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint. items: @@ -7522,7 +7489,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' 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. @@ -7538,7 +7505,7 @@ components: $ref: '#/components/schemas/CheckoutOrderResponse' outputDetails: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -7546,7 +7513,7 @@ components: type: object paymentData: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action.paymentData` instead. description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint. @@ -7562,7 +7529,7 @@ components: type: string redirect: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. description: When the payment flow requires a redirect, this object contains information about the redirect URL. @@ -7577,7 +7544,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7628,7 +7595,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7687,7 +7654,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7703,12 +7670,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7716,7 +7683,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7727,7 +7694,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7752,14 +7719,14 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7772,7 +7739,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7786,7 +7753,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7797,29 +7764,29 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7831,17 +7798,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7849,7 +7816,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7859,7 +7826,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7874,7 +7841,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7948,7 +7915,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -8008,12 +7975,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -8029,11 +7996,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -8041,22 +8008,24 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. @@ -8068,7 +8037,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -8147,7 +8116,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -8236,13 +8205,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8275,18 +8244,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -8295,7 +8264,7 @@ components: RecurringDetail: properties: brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -8312,7 +8281,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -8382,6 +8351,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8694,6 +8666,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8777,7 +8781,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8792,11 +8796,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -9079,7 +9083,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9088,7 +9092,7 @@ components: description: The payload you received from the Samsung Pay SDK response. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9112,13 +9116,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9135,7 +9139,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -9366,13 +9370,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9390,7 +9394,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -9425,13 +9428,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -9439,7 +9442,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -9481,14 +9484,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -9545,7 +9548,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -9567,7 +9570,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -9577,7 +9580,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -9590,7 +9593,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -9601,7 +9604,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -9619,7 +9622,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDSecureData: @@ -9662,7 +9665,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -9670,7 +9673,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9699,7 +9702,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9709,7 +9712,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9731,13 +9734,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9810,13 +9813,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9851,43 +9854,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9905,20 +9879,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9927,17 +9887,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9945,11 +9894,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9957,13 +9901,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9990,15 +9927,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -10016,39 +9944,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -10089,6 +10040,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -10114,1867 +10066,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -12117,6 +10255,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -12133,24 +10280,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12198,22 +10327,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12270,21 +10383,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: 097410 - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VHQOF - pspReference: 993617895214576G - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -12305,21 +10403,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 054817 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VIO26 - pspReference: 993617895217578K - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -12340,21 +10423,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '046773' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCAVH - pspReference: 993617895196572H - resultCode: Authorised - merchantReference: string post-payments-card-direct: summary: Make a card payment value: @@ -12371,37 +10439,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 044925 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VEP3H - pspReference: 993617895204576J - resultCode: Authorised - merchantReference: string post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -12442,25 +10480,6 @@ components: details: redirectResult: X6XtfGC3!Y... post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF-200: summary: Example response for request 'enableOneClick-SF' value: additionalData: @@ -12498,24 +10517,6 @@ components: storePaymentMethod: true returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: '003704' - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCKO0 - pspReference: 993617895197573E - resultCode: Authorised - merchantReference: string post-payments-giropay: summary: Make a giropay payment value: @@ -12527,23 +10528,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - paymentMethodType: giropay - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA post-payments-googlepay: summary: Make a Google Pay payment value: @@ -12568,23 +10552,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - paymentMethodType: ideal - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ post-payments-klarna: summary: Make a Klarna payment value: @@ -12695,23 +10662,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - paymentMethodType: directEbanking - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: @@ -12740,26 +10690,6 @@ components: type: Commission reference: '6124146' post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-subscription-first-transaction-200: summary: Example response for request 'subscription-first-transaction' value: additionalData: diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 83164d4a..7534ddb1 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1025,28 +1047,28 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' - subscription-first-transaction-200: - $ref: '#/components/examples/post-payments-subscription-first-transaction-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-SF: + $ref: '#/components/examples/post-payments-enableOneClick-SF' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1057,8 +1079,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1066,8 +1088,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1075,8 +1097,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1084,8 +1106,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1096,13 +1118,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1147,8 +1171,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1156,8 +1180,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1165,8 +1189,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1174,8 +1198,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1186,13 +1210,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1229,8 +1255,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1238,8 +1264,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1247,8 +1273,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1256,8 +1282,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1268,13 +1294,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1333,8 +1361,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1342,8 +1370,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1351,8 +1379,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1360,8 +1388,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1372,13 +1400,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1440,8 +1470,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1449,8 +1479,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1458,8 +1488,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1467,8 +1497,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1479,13 +1509,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1543,8 +1575,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1552,8 +1584,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1561,8 +1593,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1570,8 +1602,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1582,13 +1614,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1646,8 +1680,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1655,8 +1689,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1664,8 +1698,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1673,8 +1707,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1685,13 +1719,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1750,8 +1786,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1759,8 +1795,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1768,8 +1804,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1777,8 +1813,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1789,8 +1825,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1848,7 +1884,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -2002,13 +2038,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -2553,6 +2589,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -3026,19 +3070,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3264,68 +3295,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3511,13 +3480,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3588,13 +3557,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3654,26 +3623,26 @@ components: additionalProperties: false properties: bankAccountNumber: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The bank account number (without separators). type: string bankLocationId: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The bank routing number of the account. type: string holderName: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The name of the bank account holder. type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3690,7 +3659,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3729,7 +3698,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3756,13 +3725,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3780,41 +3749,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3951,7 +3920,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -3962,7 +3931,7 @@ components: in India. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -4038,7 +4007,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4083,12 +4052,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4104,13 +4073,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4124,7 +4093,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4135,7 +4104,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4146,12 +4115,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4161,7 +4130,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4176,14 +4145,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4215,7 +4184,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4309,12 +4278,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4330,11 +4299,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4342,36 +4311,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4432,7 +4403,7 @@ components: - Failed type: string transactionLimit: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The maximum spendable balance for a single transaction. Applicable to some gift cards. $ref: '#/components/schemas/Amount' @@ -4809,7 +4780,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4920,7 +4891,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4941,7 +4912,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -5077,7 +5048,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5139,7 +5110,7 @@ components: link can be used for one successful payment only. type: boolean riskData: - x-addedInVersion: 65 + x-addedInVersion: '65' description: Any risk-related settings to apply to the payment. $ref: '#/components/schemas/RiskData' shopperEmail: @@ -5173,7 +5144,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead. @@ -5245,7 +5216,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5502,13 +5473,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5526,13 +5497,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5559,13 +5530,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5587,13 +5558,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5652,7 +5623,7 @@ components: format: int32 type: integer plans: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -5669,13 +5640,13 @@ components: type: string type: array preselectedValue: - x-addedInVersion: 64 + x-addedInVersion: '64' description: Preselected number of installments offered for this payment method. format: int32 type: integer values: - x-addedInVersion: 64 + x-addedInVersion: '64' description: An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`. @@ -5686,7 +5657,7 @@ components: Installments: properties: plan: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -5742,13 +5713,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5817,14 +5788,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -6072,13 +6035,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6100,13 +6063,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6130,7 +6093,7 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -6140,7 +6103,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6172,13 +6135,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6417,7 +6380,7 @@ components: PaymentDetailsResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. oneOf: @@ -6441,13 +6404,13 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -6456,7 +6419,7 @@ components: type: object details: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' description: When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint. items: @@ -6466,7 +6429,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -6475,7 +6438,7 @@ components: $ref: '#/components/schemas/CheckoutOrderResponse' outputDetails: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -6483,7 +6446,7 @@ components: type: object paymentData: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action.paymentData` instead. description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint. @@ -6498,7 +6461,7 @@ components: type: string redirect: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. description: When the payment flow requires a redirect, this object contains information about the redirect URL. @@ -6513,7 +6476,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6567,7 +6530,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6626,7 +6589,7 @@ components: link is created. type: string id: - x-addedInVersion: 51 + x-addedInVersion: '51' description: A unique identifier of the payment link. readOnly: true type: string @@ -6635,7 +6598,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6680,7 +6643,7 @@ components: link can be used for one successful payment only. type: boolean riskData: - x-addedInVersion: 65 + x-addedInVersion: '65' description: Any risk-related settings to apply to the payment. $ref: '#/components/schemas/RiskData' shopperEmail: @@ -6724,7 +6687,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. type: boolean @@ -6742,11 +6705,11 @@ components: PaymentMethod: properties: brand: - x-addedInVersion: 65 + x-addedInVersion: '65' description: 'Brand for the selected gift card. For example: plastix, hmclub.' type: string brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -6763,7 +6726,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -6825,7 +6788,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6841,7 +6804,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6874,12 +6837,12 @@ components: the transaction. type: string order: - x-addedInVersion: 64 + x-addedInVersion: '64' description: Contains the order information which is required for partial payments. $ref: '#/components/schemas/CheckoutOrder' shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6890,14 +6853,16 @@ components: > This field is required for recurring payments.' type: string splitCardFundingSources: - x-addedInVersion: 53 + x-addedInVersion: '53' default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. type: boolean store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6912,7 +6877,7 @@ components: $ref: '#/components/schemas/PaymentMethod' type: array storedPaymentMethods: - x-addedInVersion: 49 + x-addedInVersion: '49' description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' @@ -6957,7 +6922,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6995,12 +6960,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7016,7 +6981,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7041,11 +7006,11 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7058,7 +7023,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7072,7 +7037,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7083,29 +7048,29 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7117,17 +7082,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7135,7 +7100,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7145,7 +7110,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7160,14 +7125,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7197,7 +7162,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -7258,7 +7223,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -7275,12 +7240,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -7377,12 +7342,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7398,11 +7363,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7410,34 +7375,36 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7449,7 +7416,7 @@ components: PaymentResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' @@ -7481,13 +7448,13 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -7496,7 +7463,7 @@ components: type: object details: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' description: When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint. items: @@ -7506,7 +7473,7 @@ components: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' 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. @@ -7522,7 +7489,7 @@ components: $ref: '#/components/schemas/CheckoutOrderResponse' outputDetails: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -7530,7 +7497,7 @@ components: type: object paymentData: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action.paymentData` instead. description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint. @@ -7546,7 +7513,7 @@ components: type: string redirect: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. description: When the payment flow requires a redirect, this object contains information about the redirect URL. @@ -7561,7 +7528,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7612,7 +7579,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7671,7 +7638,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7687,12 +7654,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7700,7 +7667,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7711,7 +7678,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7736,14 +7703,14 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7756,7 +7723,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7770,7 +7737,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7781,23 +7748,23 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7809,17 +7776,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7827,7 +7794,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7837,7 +7804,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7852,7 +7819,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7926,7 +7893,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7986,12 +7953,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -8007,11 +7974,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -8019,22 +7986,24 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. @@ -8046,7 +8015,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -8125,7 +8094,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -8214,13 +8183,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8253,18 +8222,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -8273,11 +8242,11 @@ components: RecurringDetail: properties: brand: - x-addedInVersion: 65 + x-addedInVersion: '65' description: 'Brand for the selected gift card. For example: plastix, hmclub.' type: string brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -8294,7 +8263,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -8360,6 +8329,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8672,6 +8644,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8748,7 +8752,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8763,11 +8767,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -9025,20 +9029,20 @@ components: and specific browser settings. type: string customFields: - x-addedInVersion: 65 + x-addedInVersion: '65' additionalProperties: type: string description: Any custom fields used as part of the input to configured risk rules. type: object fraudOffset: - x-addedInVersion: 65 + x-addedInVersion: '65' description: An integer value that is added to the normal fraud score. The value can be either positive or negative. format: int32 type: integer profileReference: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string @@ -9068,7 +9072,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9077,7 +9081,7 @@ components: description: The payload you received from the Samsung Pay SDK response. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9101,13 +9105,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9124,7 +9128,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -9355,13 +9359,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9379,7 +9383,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -9414,13 +9417,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -9428,7 +9431,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -9470,14 +9473,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -9534,7 +9537,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -9556,7 +9559,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -9566,7 +9569,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -9579,7 +9582,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -9590,7 +9593,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -9608,7 +9611,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDSecureData: @@ -9651,7 +9654,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -9659,7 +9662,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9688,7 +9691,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9698,7 +9701,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9720,13 +9723,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9799,13 +9802,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9840,45 +9843,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - pspReference: 881611827877203B - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - pspReference: '8816118280275544' - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9896,20 +9868,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9918,17 +9876,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9936,11 +9883,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9948,13 +9890,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9981,15 +9916,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -10007,39 +9933,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -10080,6 +10029,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -10105,1867 +10055,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -12108,6 +10244,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -12124,24 +10269,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12189,22 +10316,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12261,21 +10372,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: 097410 - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VHQOF - pspReference: 993617895214576G - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -12296,21 +10392,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 054817 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VIO26 - pspReference: 993617895217578K - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -12331,21 +10412,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '046773' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCAVH - pspReference: 993617895196572H - resultCode: Authorised - merchantReference: string post-payments-card-direct: summary: Make a card payment value: @@ -12362,37 +10428,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 044925 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VEP3H - pspReference: 993617895204576J - resultCode: Authorised - merchantReference: string post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -12433,25 +10469,6 @@ components: details: redirectResult: X6XtfGC3!Y... post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF-200: summary: Example response for request 'enableOneClick-SF' value: additionalData: @@ -12489,24 +10506,6 @@ components: storePaymentMethod: true returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: '003704' - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCKO0 - pspReference: 993617895197573E - resultCode: Authorised - merchantReference: string post-payments-giropay: summary: Make a giropay payment value: @@ -12518,23 +10517,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - paymentMethodType: giropay - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA post-payments-googlepay: summary: Make a Google Pay payment value: @@ -12559,23 +10541,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - paymentMethodType: ideal - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ post-payments-klarna: summary: Make a Klarna payment value: @@ -12686,23 +10651,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - paymentMethodType: directEbanking - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: @@ -12731,26 +10679,6 @@ components: type: Commission reference: '6124146' post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-subscription-first-transaction-200: summary: Example response for request 'subscription-first-transaction' value: additionalData: diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index 3a16c4d6..b1cdd541 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +196,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +208,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +217,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +226,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +235,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +247,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +281,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +293,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +302,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +311,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +320,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +332,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -362,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -374,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -383,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -392,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -401,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -413,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -448,8 +458,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -469,8 +479,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,8 +488,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -487,8 +497,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -496,8 +506,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -508,13 +518,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -536,8 +548,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -548,8 +560,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -557,8 +569,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -566,8 +578,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -575,8 +587,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -587,12 +599,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -623,8 +637,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -635,8 +649,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -644,8 +658,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -653,8 +667,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -662,8 +676,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -674,13 +688,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -717,12 +733,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -733,8 +749,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -742,8 +758,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -751,8 +767,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -760,8 +776,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -772,13 +788,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -806,8 +824,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -818,8 +836,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -827,8 +845,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -836,8 +854,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -845,8 +863,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -857,13 +875,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -901,10 +921,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -915,8 +935,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -924,8 +944,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -933,8 +953,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -942,8 +962,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -954,13 +974,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1025,28 +1047,28 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' - subscription-first-transaction-200: - $ref: '#/components/examples/post-payments-subscription-first-transaction-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-SF: + $ref: '#/components/examples/post-payments-enableOneClick-SF' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1057,8 +1079,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1066,8 +1088,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1075,8 +1097,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1084,8 +1106,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1096,13 +1118,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1147,8 +1171,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1156,8 +1180,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1165,8 +1189,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1174,8 +1198,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1186,13 +1210,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1229,8 +1255,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1238,8 +1264,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1247,8 +1273,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1256,8 +1282,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1268,13 +1294,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1333,8 +1361,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1342,8 +1370,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1351,8 +1379,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1360,8 +1388,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1372,13 +1400,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1440,8 +1470,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1449,8 +1479,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1458,8 +1488,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1467,8 +1497,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1479,13 +1509,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1543,8 +1575,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1552,8 +1584,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1561,8 +1593,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1570,8 +1602,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1582,13 +1614,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1646,8 +1680,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1655,8 +1689,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1664,8 +1698,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1673,8 +1707,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1685,13 +1719,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1750,8 +1786,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1759,8 +1795,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1768,8 +1804,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1777,8 +1813,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1789,8 +1825,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1848,7 +1884,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -2002,13 +2038,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -2553,6 +2589,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -3026,19 +3070,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3264,68 +3295,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3511,13 +3480,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3588,13 +3557,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3654,26 +3623,26 @@ components: additionalProperties: false properties: bankAccountNumber: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The bank account number (without separators). type: string bankLocationId: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The bank routing number of the account. type: string holderName: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The name of the bank account holder. type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3690,7 +3659,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3729,7 +3698,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3756,13 +3725,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3780,41 +3749,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3951,7 +3920,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -3962,7 +3931,7 @@ components: in India. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -4038,7 +4007,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4083,12 +4052,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4104,13 +4073,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4124,7 +4093,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4135,7 +4104,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4146,12 +4115,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4161,7 +4130,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4176,14 +4145,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4215,7 +4184,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4309,12 +4278,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4330,11 +4299,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4342,36 +4311,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4432,7 +4403,7 @@ components: - Failed type: string transactionLimit: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The maximum spendable balance for a single transaction. Applicable to some gift cards. $ref: '#/components/schemas/Amount' @@ -4809,7 +4780,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4920,7 +4891,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4941,7 +4912,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -5077,7 +5048,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5139,7 +5110,7 @@ components: link can be used for one successful payment only. type: boolean riskData: - x-addedInVersion: 65 + x-addedInVersion: '65' description: Any risk-related settings to apply to the payment. $ref: '#/components/schemas/RiskData' shopperEmail: @@ -5173,7 +5144,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead. @@ -5245,7 +5216,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5502,13 +5473,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5526,13 +5497,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5559,13 +5530,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5587,13 +5558,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5652,7 +5623,7 @@ components: format: int32 type: integer plans: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -5669,13 +5640,13 @@ components: type: string type: array preselectedValue: - x-addedInVersion: 64 + x-addedInVersion: '64' description: Preselected number of installments offered for this payment method. format: int32 type: integer values: - x-addedInVersion: 64 + x-addedInVersion: '64' description: An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`. @@ -5686,7 +5657,7 @@ components: Installments: properties: plan: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -5742,13 +5713,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5817,14 +5788,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -6072,13 +6035,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6100,13 +6063,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6130,7 +6093,7 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -6140,7 +6103,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6172,13 +6135,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6417,7 +6380,7 @@ components: PaymentDetailsResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. oneOf: @@ -6441,13 +6404,13 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -6456,21 +6419,21 @@ components: type: object details: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' description: When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint. items: $ref: '#/components/schemas/InputDetail' type: array donationToken: - x-addedInVersion: 66 + x-addedInVersion: '66' description: Donation Token containing payment details for Adyen Giving. type: string fraudResult: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -6479,7 +6442,7 @@ components: $ref: '#/components/schemas/CheckoutOrderResponse' outputDetails: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -6487,7 +6450,7 @@ components: type: object paymentData: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action.paymentData` instead. description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint. @@ -6502,7 +6465,7 @@ components: type: string redirect: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. description: When the payment flow requires a redirect, this object contains information about the redirect URL. @@ -6517,7 +6480,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6571,7 +6534,7 @@ components: description: The shopperLocale. type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentLinkResource: @@ -6630,7 +6593,7 @@ components: link is created. type: string id: - x-addedInVersion: 51 + x-addedInVersion: '51' description: A unique identifier of the payment link. readOnly: true type: string @@ -6639,7 +6602,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -6684,7 +6647,7 @@ components: link can be used for one successful payment only. type: boolean riskData: - x-addedInVersion: 65 + x-addedInVersion: '65' description: Any risk-related settings to apply to the payment. $ref: '#/components/schemas/RiskData' shopperEmail: @@ -6728,7 +6691,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. type: boolean @@ -6746,11 +6709,11 @@ components: PaymentMethod: properties: brand: - x-addedInVersion: 65 + x-addedInVersion: '65' description: 'Brand for the selected gift card. For example: plastix, hmclub.' type: string brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -6767,7 +6730,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -6829,7 +6792,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6845,7 +6808,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6878,12 +6841,12 @@ components: the transaction. type: string order: - x-addedInVersion: 64 + x-addedInVersion: '64' description: Contains the order information which is required for partial payments. $ref: '#/components/schemas/CheckoutOrder' shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6894,14 +6857,16 @@ components: > This field is required for recurring payments.' type: string splitCardFundingSources: - x-addedInVersion: 53 + x-addedInVersion: '53' default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. type: boolean store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6916,7 +6881,7 @@ components: $ref: '#/components/schemas/PaymentMethod' type: array storedPaymentMethods: - x-addedInVersion: 49 + x-addedInVersion: '49' description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' @@ -6961,7 +6926,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6999,12 +6964,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7020,7 +6985,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7045,11 +7010,11 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7062,7 +7027,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7076,7 +7041,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7087,29 +7052,29 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7121,17 +7086,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7139,7 +7104,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7149,7 +7114,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7164,14 +7129,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7201,7 +7166,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -7262,7 +7227,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -7279,12 +7244,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -7381,12 +7346,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7402,11 +7367,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7414,34 +7379,36 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7453,7 +7420,7 @@ components: PaymentResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' @@ -7485,13 +7452,13 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' authentication: - x-addedInVersion: 40 + x-addedInVersion: '40' deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -7500,21 +7467,21 @@ components: type: object details: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' description: When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint. items: $ref: '#/components/schemas/InputDetail' type: array donationToken: - x-addedInVersion: 66 + x-addedInVersion: '66' description: Donation Token containing payment details for Adyen Giving. type: string fraudResult: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' 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. @@ -7530,7 +7497,7 @@ components: $ref: '#/components/schemas/CheckoutOrderResponse' outputDetails: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. additionalProperties: type: string @@ -7538,7 +7505,7 @@ components: type: object paymentData: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action.paymentData` instead. description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint. @@ -7554,7 +7521,7 @@ components: type: string redirect: deprecated: true - x-deprecatedInVersion: 64 + x-deprecatedInVersion: '64' x-deprecatedMessage: Use `action` instead. description: When the payment flow requires a redirect, this object contains information about the redirect URL. @@ -7569,7 +7536,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7620,7 +7587,7 @@ components: - Success type: string threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' PaymentReversalResource: @@ -7679,7 +7646,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7695,12 +7662,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7708,7 +7675,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7719,7 +7686,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7744,14 +7711,14 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7764,7 +7731,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7778,7 +7745,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7789,23 +7756,23 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7817,17 +7784,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7835,7 +7802,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7845,7 +7812,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7860,7 +7827,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7934,7 +7901,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7994,12 +7961,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -8015,11 +7982,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -8027,22 +7994,24 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. @@ -8054,7 +8023,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -8133,7 +8102,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -8222,13 +8191,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8261,18 +8230,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -8281,11 +8250,11 @@ components: RecurringDetail: properties: brand: - x-addedInVersion: 65 + x-addedInVersion: '65' description: 'Brand for the selected gift card. For example: plastix, hmclub.' type: string brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -8302,7 +8271,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -8368,6 +8337,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8680,6 +8652,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8756,7 +8760,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8771,11 +8775,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -9033,20 +9037,20 @@ components: and specific browser settings. type: string customFields: - x-addedInVersion: 65 + x-addedInVersion: '65' additionalProperties: type: string description: Any custom fields used as part of the input to configured risk rules. type: object fraudOffset: - x-addedInVersion: 65 + x-addedInVersion: '65' description: An integer value that is added to the normal fraud score. The value can be either positive or negative. format: int32 type: integer profileReference: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string @@ -9076,7 +9080,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9085,7 +9089,7 @@ components: description: The payload you received from the Samsung Pay SDK response. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9109,13 +9113,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9132,7 +9136,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -9363,13 +9367,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9387,7 +9391,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -9422,13 +9425,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -9436,7 +9439,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -9478,14 +9481,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -9542,7 +9545,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -9564,7 +9567,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -9574,7 +9577,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -9587,7 +9590,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -9598,7 +9601,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -9616,7 +9619,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDSecureData: @@ -9659,7 +9662,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -9667,7 +9670,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -9696,7 +9699,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9706,7 +9709,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9728,13 +9731,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9807,13 +9810,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9848,45 +9851,14 @@ components: schema: type: string examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - pspReference: 881611827877203B - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - pspReference: '8816118280275544' - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: + get-paymentLinks-linkId-basic: summary: Example response for request 'basic' value: amount: @@ -9904,20 +9876,6 @@ components: summary: Update the status of a payment link value: status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -9926,17 +9884,6 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -9944,11 +9891,6 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -9956,13 +9898,6 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -9989,15 +9924,6 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -10015,39 +9941,62 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal - details: - details: - key: firstName @@ -10088,6 +10037,7 @@ components: name: Belgium key: country type: select + value: NL key: billingAddress type: address - key: separateDeliveryAddress @@ -10113,1867 +10063,53 @@ components: name: Belgium key: country type: select + value: NL key: deliveryAddress optional: true type: address name: AfterPay Invoice type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch + - name: Pay later with Klarna. + type: klarna - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true + - key: sepa.ownerName type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - amount: - currency: EUR - value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit - name: AliPay type: alipay - name: AliPay @@ -12116,6 +10252,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -12132,24 +10277,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12197,22 +10324,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12269,21 +10380,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: 097410 - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VHQOF - pspReference: 993617895214576G - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -12304,21 +10400,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 054817 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VIO26 - pspReference: 993617895217578K - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -12339,21 +10420,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '046773' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCAVH - pspReference: 993617895196572H - resultCode: Authorised - merchantReference: string post-payments-card-direct: summary: Make a card payment value: @@ -12370,37 +10436,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 044925 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VEP3H - pspReference: 993617895204576J - resultCode: Authorised - merchantReference: string post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -12441,25 +10477,6 @@ components: details: redirectResult: X6XtfGC3!Y... post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF-200: summary: Example response for request 'enableOneClick-SF' value: additionalData: @@ -12497,24 +10514,6 @@ components: storePaymentMethod: true returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: '003704' - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCKO0 - pspReference: 993617895197573E - resultCode: Authorised - merchantReference: string post-payments-giropay: summary: Make a giropay payment value: @@ -12526,23 +10525,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - paymentMethodType: giropay - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA post-payments-googlepay: summary: Make a Google Pay payment value: @@ -12567,23 +10549,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - paymentMethodType: ideal - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ post-payments-klarna: summary: Make a Klarna payment value: @@ -12694,23 +10659,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - paymentMethodType: directEbanking - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: @@ -12739,26 +10687,6 @@ components: type: Commission reference: '6124146' post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-subscription-first-transaction-200: summary: Example response for request 'subscription-first-transaction' value: additionalData: diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index e302ea39..57e4c31a 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -67,6 +67,8 @@ x-groups: paths: /cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the @@ -121,8 +123,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -130,8 +132,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -139,8 +141,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -148,8 +150,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -160,13 +162,104 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /donations: + post: + tags: + - Payments + summary: Starts a transaction for donation. + description: 'Takes in the donation token generated by the `/payments` request + and uses it to make the donation for the donation account specified in the + request. + + + For more information, see [Donations](https://docs.adyen.com/online-payments/donations).' + x-addedInVersion: '67' + operationId: post-donations + x-groupName: Payments + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + donations: + $ref: '#/components/examples/post-donations-donations' + schema: + $ref: '#/components/schemas/PaymentDonationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + donations: + $ref: '#/components/examples/post-donations-donations' + schema: + $ref: '#/components/schemas/DonationResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders: post: + tags: + - Orders summary: Creates an order for the given amount. description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different @@ -192,8 +285,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-basic-200' + basic: + $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. @@ -204,8 +297,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -213,8 +306,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -222,8 +315,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -231,8 +324,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -243,13 +336,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /orders/cancel: post: + tags: + - Orders summary: Cancels the given order. description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding @@ -275,8 +370,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-orders-cancel-basic-200' + basic: + $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. @@ -287,8 +382,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -296,8 +391,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -305,8 +400,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -314,8 +409,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -326,13 +421,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /originKeys: post: + tags: + - Utility summary: Create originKey values for one or more merchant domains. description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ @@ -342,7 +439,7 @@ paths: \ without generating a new key, and detect the card type from the number entered\ \ in your payment form. " deprecated: true - x-deprecatedInVersion: 67 + x-deprecatedInVersion: '67' operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 @@ -364,8 +461,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-originKeys-basic-200' + basic: + $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. @@ -376,8 +473,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -385,8 +482,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -394,8 +491,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -403,8 +500,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -415,13 +512,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks: post: + tags: + - Payment links summary: Creates a payment link. description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the @@ -450,8 +549,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentLinks-basic-200' + basic: + $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -471,8 +570,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -480,8 +579,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -489,8 +588,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -498,8 +597,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -510,13 +609,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentLinks/{linkId}: get: + tags: + - Payment links summary: Retrieve a payment link. description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId @@ -538,8 +639,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -550,8 +651,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -559,8 +660,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -568,8 +669,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -577,8 +678,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -589,12 +690,14 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. patch: + tags: + - Payment links summary: Update the status of a payment link description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). @@ -625,8 +728,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. @@ -637,8 +740,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -646,8 +749,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -655,8 +758,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -664,8 +767,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -676,13 +779,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods: post: + tags: + - Payments 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 @@ -719,12 +824,12 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-paymentMethods-basic-200' - filtered-200: - $ref: '#/components/examples/post-paymentMethods-filtered-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -735,8 +840,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -744,8 +849,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -753,8 +858,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -762,8 +867,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -774,13 +879,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentMethods/balance: post: + tags: + - Orders summary: Returns the available balance on gift card. description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include @@ -808,8 +915,8 @@ paths: content: application/json: examples: - plastix-200: - $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. @@ -820,8 +927,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -829,8 +936,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -838,8 +945,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -847,8 +954,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -859,13 +966,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /paymentSession: post: + tags: + - Classic Checkout SDK summary: Creates a payment session. description: '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 @@ -903,10 +1012,10 @@ paths: content: application/json: examples: - enableOneClick-200: - $ref: '#/components/examples/post-paymentSession-enableOneClick-200' - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -917,8 +1026,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -926,8 +1035,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -935,8 +1044,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -944,8 +1053,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -956,13 +1065,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments: post: + tags: + - Payments summary: Starts a transaction. description: "Sends payment parameters (like amount, country, and currency)\ \ together with other required input details collected from the shopper. To\ @@ -1027,28 +1138,28 @@ paths: content: application/json: examples: - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' - card-3d-secure-direct-200: - $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-direct-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - giropay-200: - $ref: '#/components/examples/post-payments-giropay-200' - ideal-200: - $ref: '#/components/examples/post-payments-ideal-200' - sofort-200: - $ref: '#/components/examples/post-payments-sofort-200' - subscription-first-transaction-200: - $ref: '#/components/examples/post-payments-subscription-first-transaction-200' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-SF: + $ref: '#/components/examples/post-payments-enableOneClick-SF' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + sofort: + $ref: '#/components/examples/post-payments-sofort' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1059,8 +1170,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1068,8 +1179,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1077,8 +1188,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1086,8 +1197,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1098,13 +1209,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/details: post: + tags: + - Payments 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` @@ -1145,8 +1258,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1154,8 +1267,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1163,8 +1276,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1172,8 +1285,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1184,13 +1297,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/result: post: + tags: + - Classic Checkout SDK summary: Verifies payment result. description: 'Verifies the payment result using the payload returned from the Checkout SDK. @@ -1227,8 +1342,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1236,8 +1351,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1245,8 +1360,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1254,8 +1369,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1266,13 +1381,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/amountUpdates: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, @@ -1331,8 +1448,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1340,8 +1457,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1349,8 +1466,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1358,8 +1475,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1370,13 +1487,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/cancels: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the @@ -1438,8 +1557,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1447,8 +1566,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1456,8 +1575,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1465,8 +1584,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1477,13 +1596,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/captures: post: + tags: + - Modifications summary: Captures an authorised payment. description: " Captures an authorised payment and returns a unique reference\ \ for this request. You get the outcome of the request asynchronously, in\ @@ -1541,8 +1662,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1550,8 +1671,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1559,8 +1680,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1568,8 +1689,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1580,13 +1701,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/refunds: post: + tags: + - Modifications summary: Refunds a captured payment. description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ \ and returns a unique reference for this request. You get the outcome of\ @@ -1644,8 +1767,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1653,8 +1776,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1662,8 +1785,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1671,8 +1794,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1683,13 +1806,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /payments/{paymentPspReference}/reversals: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) @@ -1748,8 +1873,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1757,8 +1882,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1766,8 +1891,8 @@ paths: content: application/json: examples: - generic-403: - $ref: '#/components/examples/generic-403' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -1775,8 +1900,8 @@ paths: content: application/json: examples: - generic-422: - $ref: '#/components/examples/generic-422' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1787,8 +1912,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1846,7 +1971,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -2000,13 +2125,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -2551,6 +2676,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -3024,19 +3157,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -3262,68 +3382,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -3509,13 +3567,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3586,13 +3644,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3652,26 +3710,26 @@ components: additionalProperties: false properties: bankAccountNumber: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The bank account number (without separators). type: string bankLocationId: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The bank routing number of the account. type: string holderName: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The name of the bank account holder. type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3688,7 +3746,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -3727,7 +3785,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BillDeskDetails: @@ -3754,13 +3812,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -3778,41 +3836,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -3949,7 +4007,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -3960,7 +4018,7 @@ components: in India. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -4036,7 +4094,7 @@ components: CheckoutBalanceCheckRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4081,12 +4139,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4102,13 +4160,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4122,7 +4180,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4133,7 +4191,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4144,12 +4202,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4159,7 +4217,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4174,14 +4232,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4213,7 +4271,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4307,12 +4365,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4328,11 +4386,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4340,36 +4398,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4430,7 +4490,7 @@ components: - Failed type: string transactionLimit: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The maximum spendable balance for a single transaction. Applicable to some gift cards. $ref: '#/components/schemas/Amount' @@ -4786,7 +4846,7 @@ components: CheckoutUtilityResponse: properties: originKeys: - x-addedInVersion: 1 + x-addedInVersion: '1' additionalProperties: type: string description: The list of origin keys for all requested domains. For each @@ -4897,7 +4957,7 @@ components: System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: - x-addedInVersion: 37 + x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. @@ -4918,7 +4978,7 @@ components: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' CreatePaymentAmountUpdateRequest: @@ -5054,7 +5114,7 @@ components: be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -5105,7 +5165,7 @@ components: future communications about the payment status. type: string requiredShopperFields: - x-addedInVersion: 67 + x-addedInVersion: '67' description: "List of fields that the shopper has to provide on the payment\ \ page before completing the payment. For more information, refer to [Provide\ \ shopper information](https://docs.adyen.com/online-payments/pay-by-link/api#shopper-information).\n\ @@ -5135,7 +5195,7 @@ components: link can be used for one successful payment only. type: boolean riskData: - x-addedInVersion: 65 + x-addedInVersion: '65' description: Any risk-related settings to apply to the payment. $ref: '#/components/schemas/RiskData' shopperEmail: @@ -5169,7 +5229,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead. @@ -5241,7 +5301,7 @@ components: maxLength: 100000 type: string threeDSAuthenticationOnly: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. @@ -5322,6 +5382,55 @@ components: - lastName - shopperEmail title: Doku + DonationResponse: + properties: + amount: + x-addedInVersion: '67' + description: Authorised amount in the transaction. + $ref: '#/components/schemas/Amount' + donationAccount: + x-addedInVersion: '67' + description: The Adyen account name of your charity. We will provide you + with this account name once your chosen charity has been [onboarded](https://docs.adyen.com/online-payments/donations#onboarding). + type: string + id: + x-addedInVersion: '67' + description: Your unique resource identifier. + type: string + merchantAccount: + x-addedInVersion: '67' + description: The merchant account identifier, with which you want to process + the transaction. + type: string + payment: + x-addedInVersion: '67' + description: Action to be taken for completing the payment. + $ref: '#/components/schemas/PaymentResponse' + reference: + x-addedInVersion: '67' + 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 + status: + x-addedInVersion: '67' + description: 'The status of the donation transaction. + + + Possible values: + + * **completed** + + * **pending** + + * **refused**' + enum: + - completed + - pending + - refused + type: string DotpayDetails: additionalProperties: false properties: @@ -5498,13 +5607,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5522,13 +5631,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5555,13 +5664,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5583,13 +5692,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5648,7 +5757,7 @@ components: format: int32 type: integer plans: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -5665,13 +5774,13 @@ components: type: string type: array preselectedValue: - x-addedInVersion: 64 + x-addedInVersion: '64' description: Preselected number of installments offered for this payment method. format: int32 type: integer values: - x-addedInVersion: 64 + x-addedInVersion: '64' description: An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`. @@ -5682,7 +5791,7 @@ components: Installments: properties: plan: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -5738,13 +5847,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -5813,14 +5922,6 @@ components: description: Tax amount, in minor units. format: int64 type: integer - taxCategory: - description: 'Required for AfterPay. Tax category: High, Low, None, Zero' - enum: - - High - - Low - - None - - Zero - type: string taxPercentage: description: Tax percentage, in minor units. format: int64 @@ -6068,13 +6169,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6096,13 +6197,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6126,7 +6227,7 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -6136,7 +6237,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6168,13 +6269,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -6431,18 +6532,18 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' donationToken: - x-addedInVersion: 66 + x-addedInVersion: '66' description: Donation Token containing payment details for Adyen Giving. type: string fraudResult: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The reference used during the /payments request. type: string order: @@ -6467,7 +6568,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -6521,97 +6622,333 @@ components: description: The shopperLocale. type: string threeDS2ResponseData: - x-addedInVersion: 67 + x-addedInVersion: '67' description: Response of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2ResponseData' threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' threeDSPaymentData: - x-addedInVersion: 67 + x-addedInVersion: '67' description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string - PaymentLinkResource: + PaymentDonationRequest: properties: - allowedPaymentMethods: - description: 'List of payment methods to be presented to the shopper. To - refer to payment methods, use their `paymentMethod.type` from [Payment - methods overview](https://docs.adyen.com/payment-methods). - + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. - Example: `"allowedPaymentMethods":["ideal","giropay"]`' - items: + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalData: + additionalProperties: type: string - type: array + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object amount: - description: The payment amount and currency. + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - description: The address where to send the invoice. + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > For 3D Secure 2 transactions, schemes require `billingAddress` for all + browser-based and mobile implementations. Include all of the fields within + this object.' $ref: '#/components/schemas/Address' - blockedPaymentMethods: - description: 'List of payment methods to be hidden from the shopper. To - refer to payment methods, use their `paymentMethod.type` from [Payment - methods overview](https://docs.adyen.com/payment-methods). + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + 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`. - Example: `"blockedPaymentMethods":["ideal","giropay"]`' - items: - type: string - type: array + Possible values: + + * iOS + + * Android + + * Web' + enum: + - iOS + - Android + - Web + type: string + company: + x-addedInVersion: '32' + description: Information regarding the company. + $ref: '#/components/schemas/Company' + conversionId: + x-addedInVersion: '49' + description: Conversion ID that corresponds to the Id generated for tracking + user payment journey. + type: string countryCode: - description: The shopper's two-letter country code. + 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 - deliverAt: - description: The date and time the purchased goods should be delivered. - In ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' format: date-time type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' deliveryAddress: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' - description: - description: 'A short description visible on the payment page. + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. - Maximum length: 280 characters.' - type: string - expiresAt: - description: The date that the payment link expires, in ISO 8601 format. - For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum - expiry date should be 70 days from when the payment link is created. If - not provided, the default expiry is set to 24 hours after the payment - link is created. + + 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 - id: - x-addedInVersion: 51 - description: A unique identifier of the payment link. - readOnly: true + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + donationAccount: + description: Donation account to which the transaction is credited. + type: string + donationOriginalPspReference: + description: PSP reference of the transaction from which the donation token + is generated. + type: string + donationToken: + description: Donation token received in the `/payments` call. + type: string + enableOneClick: + x-addedInVersion: '32' + 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: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the payment details + will be tokenized for payouts. + type: boolean + enableRecurring: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the payment details + will be tokenized for recurring payments. + type: boolean + entityType: + x-addedInVersion: '24' + 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: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' lineItems: + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - This parameter is required for open invoice (_buy now, pay later_) payment - methods such AfterPay, Klarna, RatePay, and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string merchantAccount: - description: The merchant account identifier for which the payment link - is created. + 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 for reporting purposes (for example, order auth-rate). The reference - should be unique per billing cycle. + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + mpiData: + description: Authentication data produced by an MPI (Mastercard SecureCode + or Visa Secure). + $ref: '#/components/schemas/ThreeDSecureData' + order: + description: Contains the order information which is required for partial + payments. + $ref: '#/components/schemas/CheckoutOrder' + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + origin: + x-addedInVersion: '40' + description: 'Required for the 3D Secure 2 `channel` **Web** integration. + + + Set this parameter to the origin URL of the page that you are loading + the 3D Secure Component from.' + maxLength: 8000 + type: string + paymentMethod: + description: The type and required details of a payment method to use. + oneOf: + - $ref: '#/components/schemas/AchDetails' + - $ref: '#/components/schemas/AfterpayDetails' + - $ref: '#/components/schemas/AmazonPayDetails' + - $ref: '#/components/schemas/AndroidPayDetails' + - $ref: '#/components/schemas/ApplePayDetails' + - $ref: '#/components/schemas/BacsDirectDebitDetails' + - $ref: '#/components/schemas/BillDeskDetails' + - $ref: '#/components/schemas/BlikDetails' + - $ref: '#/components/schemas/CardDetails' + - $ref: '#/components/schemas/CellulantDetails' + - $ref: '#/components/schemas/DokuDetails' + - $ref: '#/components/schemas/DotpayDetails' + - $ref: '#/components/schemas/DragonpayDetails' + - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EntercashDetails' + - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' + - $ref: '#/components/schemas/GiropayDetails' + - $ref: '#/components/schemas/GooglePayDetails' + - $ref: '#/components/schemas/IdealDetails' + - $ref: '#/components/schemas/KlarnaDetails' + - $ref: '#/components/schemas/LianLianPayDetails' + - $ref: '#/components/schemas/MasterpassDetails' + - $ref: '#/components/schemas/MbwayDetails' + - $ref: '#/components/schemas/MobilePayDetails' + - $ref: '#/components/schemas/MolPayDetails' + - $ref: '#/components/schemas/OpenInvoiceDetails' + - $ref: '#/components/schemas/PayPalDetails' + - $ref: '#/components/schemas/PayUUpiDetails' + - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/PaymentDetails' + - $ref: '#/components/schemas/QiwiWalletDetails' + - $ref: '#/components/schemas/RatepayDetails' + - $ref: '#/components/schemas/SamsungPayDetails' + - $ref: '#/components/schemas/SepaDirectDebitDetails' + - $ref: '#/components/schemas/StoredPaymentMethodDetails' + - $ref: '#/components/schemas/UpiDetails' + - $ref: '#/components/schemas/VippsDetails' + - $ref: '#/components/schemas/VisaCheckoutDetails' + - $ref: '#/components/schemas/WeChatPayDetails' + - $ref: '#/components/schemas/WeChatPayMiniProgramDetails' + - $ref: '#/components/schemas/ZipDetails' + recurringExpiry: + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + type: string + recurringFrequency: + description: Minimum number of days between authorisations. Only for 3D + Secure 2. type: string recurringProcessingModel: + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -6619,7 +6956,7 @@ components: \ or simply to streamline the checkout process. Any subscription not following\ \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ - \ that occurs on a non-fixed schedule and/or has variable amounts. For\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ \ example, automatic top-ups when a cardholder's balance drops below a\ \ certain amount.\n" enum: @@ -6627,54 +6964,323 @@ components: - Subscription - UnscheduledCardOnFile type: string + redirectFromIssuerMethod: + x-addedInVersion: '32' + description: Specifies the redirect method (GET or POST) when redirecting + back from the issuer. + type: string + redirectToIssuerMethod: + x-addedInVersion: '32' + description: Specifies the redirect method (GET or POST) when redirecting + to the issuer. + type: string reference: - description: A reference that is used to uniquely identify the payment in - future communications about the payment status. + 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: 'Website URL used for redirection after payment is completed. + description: 'The URL to return to in case of a redirection. - If provided, a **Continue** button will be shown on the payment page. - If shoppers select the button, they are redirected to the specified URL.' + The format depends on the channel. This URL can have a maximum of 1024 + characters. + + * 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. + + Example: `https://your-company.com/checkout?shopperOrder=12xy` + + * 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). + + Example: `my-app://` + + * For Android, use a custom URL handled by an Activity on your app. You + can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). + + Example: `my-app://your.package.name`' + maxLength: 8000 type: string - reusable: - description: Indicates whether the payment link can be reused for multiple - payments. If not provided, this defaults to **false** which means the - link can be used for one successful payment only. - type: boolean riskData: - x-addedInVersion: 65 - description: Any risk-related settings to apply to the payment. + description: Contains risk data, such as client-side data, used to identify + risk for a transaction. $ref: '#/components/schemas/RiskData' + sessionValidity: + description: 'The date and time until when the session remains valid, in + [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. + + + For example: 2020-07-18T15:42:40.428+01:00' + type: string shopperEmail: - description: The shopper's email address. + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' type: string - shopperLocale: - description: 'The language to be used in the payment page, specified by - a combination of a language and country code. For example, `en-US`. + shopperIP: + description: 'The shopper''s IP address. In general, 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). + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. - For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' - type: string - shopperName: - description: The shopper's full name. This object is required for some payment - methods such as AfterPay, Klarna, or if you're enrolled in the PayPal - Seller Protection program. - $ref: '#/components/schemas/Name' - shopperReference: - description: A unique identifier for the shopper (for example, user ID or - account ID). + This field is also 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 - splits: - description: An array of objects specifying how the payment should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). - items: - $ref: '#/components/schemas/Split' - type: array - status: - description: "Status of the payment link. Possible values:\n* **active**\ + 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: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: 'Your reference to uniquely identify this shopper (for example, + user ID or account ID). Minimum length: 3 characters. + + > This field is required for recurring payments.' + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + storePaymentMethod: + x-addedInVersion: '49' + description: When true and `shopperReference` is provided, the payment details + will be stored. + type: boolean + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + - returnUrl + - paymentMethod + - donationAccount + PaymentLinkResource: + properties: + allowedPaymentMethods: + description: 'List of payment methods to be presented to the shopper. To + refer to payment methods, use their `paymentMethod.type` from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"allowedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + amount: + description: The payment amount and currency. + $ref: '#/components/schemas/Amount' + applicationInfo: + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + description: The address where to send the invoice. + $ref: '#/components/schemas/Address' + blockedPaymentMethods: + description: 'List of payment methods to be hidden from the shopper. To + refer to payment methods, use their `paymentMethod.type` from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"blockedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + countryCode: + description: The shopper's two-letter country code. + type: string + deliverAt: + description: The date and time the purchased goods should be delivered. + In ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. + format: date-time + type: string + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + description: + description: 'A short description visible on the payment page. + + Maximum length: 280 characters.' + type: string + expiresAt: + description: The date that the payment link expires, in ISO 8601 format. + For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum + expiry date should be 70 days from when the payment link is created. If + not provided, the default expiry is set to 24 hours after the payment + link is created. + type: string + id: + x-addedInVersion: '51' + description: A unique identifier of the payment link. + readOnly: true + type: string + lineItems: + description: 'Price and product information about the purchased items, to + be included on the invoice sent to the shopper. + + This parameter is required for open invoice (_buy now, pay later_) payment + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' + items: + $ref: '#/components/schemas/LineItem' + type: array + merchantAccount: + description: The merchant account identifier for which the payment link + is created. + type: string + merchantOrderReference: + description: This reference allows linking multiple transactions to each + other for reporting purposes (for example, order auth-rate). The reference + should be unique per billing cycle. + type: string + recurringProcessingModel: + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or has variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + reference: + description: A reference that is used to uniquely identify the payment in + future communications about the payment status. + type: string + returnUrl: + description: 'Website URL used for redirection after payment is completed. + + If provided, a **Continue** button will be shown on the payment page. + If shoppers select the button, they are redirected to the specified URL.' + type: string + reusable: + description: Indicates whether the payment link can be reused for multiple + payments. If not provided, this defaults to **false** which means the + link can be used for one successful payment only. + type: boolean + riskData: + x-addedInVersion: '65' + description: Any risk-related settings to apply to the payment. + $ref: '#/components/schemas/RiskData' + shopperEmail: + description: The shopper's email address. + type: string + shopperLocale: + description: 'The language to be used in the payment page, specified by + a combination of a language and country code. For example, `en-US`. + + + For a list of shopper locales that Pay by Link supports, refer to [Language + and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + type: string + shopperName: + description: The shopper's full name. This object is required for some payment + methods such as AfterPay, Klarna, or if you're enrolled in the PayPal + Seller Protection program. + $ref: '#/components/schemas/Name' + shopperReference: + description: A unique identifier for the shopper (for example, user ID or + account ID). + type: string + splits: + description: An array of objects specifying how the payment should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: "Status of the payment link. Possible values:\n* **active**\ \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ \ below)" enum: @@ -6687,7 +7293,7 @@ components: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - x-addedInVersion: 50 + x-addedInVersion: '50' description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. type: boolean @@ -6705,11 +7311,11 @@ components: PaymentMethod: properties: brand: - x-addedInVersion: 65 + x-addedInVersion: '65' description: 'Brand for the selected gift card. For example: plastix, hmclub.' type: string brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -6726,7 +7332,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -6788,7 +7394,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6804,7 +7410,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -6837,12 +7443,12 @@ components: the transaction. type: string order: - x-addedInVersion: 64 + x-addedInVersion: '64' description: Contains the order information which is required for partial payments. $ref: '#/components/schemas/CheckoutOrder' shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string @@ -6853,14 +7459,16 @@ components: > This field is required for recurring payments.' type: string splitCardFundingSources: - x-addedInVersion: 53 + x-addedInVersion: '53' default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. type: boolean store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string @@ -6875,7 +7483,7 @@ components: $ref: '#/components/schemas/PaymentMethod' type: array storedPaymentMethods: - x-addedInVersion: 49 + x-addedInVersion: '49' description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' @@ -6920,7 +7528,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -6958,12 +7566,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -6979,7 +7587,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7004,11 +7612,11 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7021,7 +7629,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7035,7 +7643,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7046,29 +7654,29 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7080,17 +7688,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7098,7 +7706,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7108,7 +7716,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7123,14 +7731,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7160,7 +7768,7 @@ components: use the `merchantOrderReference`instead. type: string origin: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Required for the 3D Secure 2 `channel` **Web** integration. @@ -7221,7 +7829,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -7238,12 +7846,12 @@ components: - UnscheduledCardOnFile type: string redirectFromIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. type: string redirectToIssuerMethod: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Specifies the redirect method (GET or POST) when redirecting to the issuer. type: string @@ -7340,12 +7948,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7361,11 +7969,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7373,34 +7981,36 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -7412,7 +8022,7 @@ components: PaymentResponse: properties: action: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' @@ -7443,18 +8053,18 @@ components: > **Account** > **API URLs** > **Additional data settings**.' type: object amount: - x-addedInVersion: 52 + x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' donationToken: - x-addedInVersion: 66 + x-addedInVersion: '66' description: Donation Token containing payment details for Adyen Giving. type: string fraudResult: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: - x-addedInVersion: 49 + x-addedInVersion: '49' 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. @@ -7487,7 +8097,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -7538,15 +8148,15 @@ components: - Success type: string threeDS2ResponseData: - x-addedInVersion: 67 + x-addedInVersion: '67' description: Response of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2ResponseData' threeDS2Result: - x-addedInVersion: 41 + x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' threeDSPaymentData: - x-addedInVersion: 67 + x-addedInVersion: '67' description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string @@ -7606,7 +8216,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7622,12 +8232,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -7635,7 +8245,7 @@ components: this object.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: 33 + x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). @@ -7646,7 +8256,7 @@ components: type: string type: array captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -7671,14 +8281,14 @@ components: - Web type: string company: - x-addedInVersion: 32 + x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Conversion ID that corresponds to the Id generated for tracking user payment journey. type: string @@ -7691,7 +8301,7 @@ components: Example: NL or DE' type: string dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -7705,7 +8315,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -7716,23 +8326,23 @@ components: format: date-time type: string enableOneClick: - x-addedInVersion: 32 + x-addedInVersion: '32' 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: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: - x-addedInVersion: 32 + x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -7744,17 +8354,17 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: - x-addedInVersion: 32 + x-addedInVersion: '32' description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, - and Zip.' + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array @@ -7762,7 +8372,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -7772,7 +8382,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -7787,7 +8397,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -7861,7 +8471,7 @@ components: risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: - x-addedInVersion: 32 + x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string @@ -7921,12 +8531,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -7942,11 +8552,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -7954,22 +8564,24 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string storePaymentMethod: - x-addedInVersion: 49 + x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. @@ -7981,7 +8593,7 @@ components: > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -8060,7 +8672,7 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string refusalReasonCode: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string @@ -8149,13 +8761,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -8188,18 +8800,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -8208,11 +8820,11 @@ components: RecurringDetail: properties: brand: - x-addedInVersion: 65 + x-addedInVersion: '65' description: 'Brand for the selected gift card. For example: plastix, hmclub.' type: string brands: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string @@ -8229,7 +8841,7 @@ components: $ref: '#/components/schemas/InputDetail' type: array fundingSource: - x-addedInVersion: 53 + x-addedInVersion: '53' description: The funding source of the payment method. enum: - debit @@ -8295,6 +8907,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8607,6 +9222,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -8683,7 +9330,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -8698,11 +9345,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -8960,20 +9607,20 @@ components: and specific browser settings. type: string customFields: - x-addedInVersion: 65 + x-addedInVersion: '65' additionalProperties: type: string description: Any custom fields used as part of the input to configured risk rules. type: object fraudOffset: - x-addedInVersion: 65 + x-addedInVersion: '65' description: An integer value that is added to the normal fraud score. The value can be either positive or negative. format: int32 type: integer profileReference: - x-addedInVersion: 65 + x-addedInVersion: '65' description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string @@ -9003,7 +9650,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9012,7 +9659,7 @@ components: description: The payload you received from the Samsung Pay SDK response. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9036,13 +9683,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9059,7 +9706,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -9265,7 +9912,7 @@ components: description: The unique payment method code. type: string iban: - x-addedInVersion: 67 + x-addedInVersion: '67' description: The IBAN of the bank account. type: string id: @@ -9278,7 +9925,7 @@ components: description: The display name of the stored payment method. type: string ownerName: - x-addedInVersion: 67 + x-addedInVersion: '67' description: The name of the bank account holder. type: string shopperEmail: @@ -9298,13 +9945,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9322,7 +9969,6 @@ components: - grabpay_TH - grabpay_ID - grabpay_VN - - grabpay_VN - grabpay_PH - oxxo - gcash @@ -9357,13 +10003,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -9371,7 +10017,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -9413,14 +10059,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -9477,7 +10123,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -9499,7 +10145,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -9509,7 +10155,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -9562,17 +10208,17 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string challengeCancel: - x-addedInVersion: 67 + x-addedInVersion: '67' description: Indicator informing the ACS and the DS that the authentication has been canceled. type: string challengeIndicator: - x-addedInVersion: 67 + x-addedInVersion: '67' type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -9581,14 +10227,14 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string exemptionIndicator: - x-addedInVersion: 67 + x-addedInVersion: '67' type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string riskScore: - x-addedInVersion: 67 + x-addedInVersion: '67' type: string threeDSServerTransID: description: The `threeDSServerTransID` value as defined in the 3D Secure @@ -9605,7 +10251,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDSecureData: @@ -9632,7 +10278,7 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string challengeCancel: - x-addedInVersion: 67 + x-addedInVersion: '67' type: string directoryResponse: description: 'In 3D Secure 1, this is the enrollment response from the 3D @@ -9651,7 +10297,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -9659,14 +10305,14 @@ components: description: The electronic commerce indicator. type: string riskScore: - x-addedInVersion: 67 + x-addedInVersion: '67' type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string transStatusReason: - x-addedInVersion: 67 + x-addedInVersion: '67' type: string xid: description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, @@ -9694,7 +10340,7 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -9704,7 +10350,7 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string storedPaymentMethodId: - x-addedInVersion: 49 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9726,13 +10372,13 @@ components: properties: recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9805,13 +10451,13 @@ components: type: string recurringDetailReference: deprecated: true - x-deprecatedInVersion: 49 + 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 + x-addedInVersion: '49' description: This is the `recurringDetailReference` returned in the response when you created the token. type: string @@ -9828,1987 +10474,136 @@ components: name: X-API-Key type: apiKey BasicAuth: - scheme: basic - type: http - headers: - Idempotency-Key: - description: The idempotency key used for processing the request. Present if - the key was provided in the request. - schema: - type: string - parameters: - Idempotency-Key: - description: A unique identifier for the message with a maximum of 64 characters - (we recommend a UUID). - example: 37ca9c97-d1d1-4c62-89e8-706891a563ed - name: Idempotency-Key - in: header - schema: - type: string - examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: - summary: Response code 401. Unauthorized. - value: - status: 401 - errorCode: '000' - message: HTTP Status Response - Unauthorized - errorType: security - generic-403: - summary: Response code 403. Forbidden. - value: - status: 403 - errorCode: '901' - message: Invalid Merchant Account - errorType: security - pspReference: 881611827877203B - generic-422: - summary: Response code 422. Unprocessable entity. - value: - status: 422 - errorCode: '14_030' - message: Return URL is missing. - errorType: validation - pspReference: '8816118280275544' - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' - get-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: active - url: https://test.adyen.link/PL61C53A8B97E6915A - patch-paymentLinks-linkId-basic: - summary: Update the status of a payment link - value: - status: expired - patch-paymentLinks-linkId-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 8700 - countryCode: NL - expiresAt: '2021-04-08T14:06:39Z' - merchantAccount: TestMerchantCheckout - reference: shopper-reference-ekvL83 - shopperLocale: hu-HU - shopperReference: shopper-reference-LZfdWZ - status: expired - url: https://test.adyen.link/PL61C53A8B97E6915A - post-orders-basic: - summary: Create an order - value: - reference: YOUR_ORDER_REFERENCE - amount: - value: 2500 - currency: EUR - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178914061985' - resultCode: Success - expiresAt: '2021-04-09T14:16:46Z' - orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== - reference: shopper-reference-ekvL83 - remainingAmount: - currency: EUR - value: 2500 - post-orders-cancel-basic: - summary: Cancel an order - value: - order: - pspReference: '8815517812932012' - orderData: 823fh892f8f18f4...148f13f9f3f - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-orders-cancel-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8816178914079738' - resultCode: Received - post-originKeys-basic: - summary: Get origin keys - value: - originDomains: - - https://www.your-domain1.com - - https://www.your-domain2.com - - https://www.your-domain3.com - post-originKeys-basic-200: - summary: Example response for request 'basic' - value: - originKeys: - https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw - https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc - https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg - post-paymentLinks-basic: - summary: Create a payment link - value: - reference: YOUR_ORDER_NUMBER - amount: - value: 1250 - currency: BRL - countryCode: BR - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperReference: YOUR_UNIQUE_SHOPPER_ID - shopperEmail: test@email.com - shopperLocale: pt-BR - billingAddress: - street: Roque Petroni Jr - postalCode: '59000060' - city: "S\xE3o Paulo" - houseNumberOrName: '999' - country: BR - stateOrProvince: SP - deliveryAddress: - street: Roque Petroni Jr - postalCode: '59000060' - city: "S\xE3o Paulo" - houseNumberOrName: '999' - country: BR - stateOrProvince: SP - post-paymentLinks-basic-200: - summary: Example response for request 'basic' - value: - amount: - currency: EUR - value: 1250 - expiresAt: '2021-04-09T14:17:31Z' - reference: shopper-reference-ekvL83 - url: https://test.adyen.link/PL6DB3157D27FFBBCF - post-paymentMethods-balance-basic: - summary: Retrieve gift card balance - value: - paymentMethod: - type: givex - number: '4126491073027401' - cvc: '737' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix: - summary: Retrieve gift card balance - value: - paymentMethod: - type: plastix - number: '4010100000000000000' - cvc: '73737' - holderName: BALANCE EUR 888 - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-balance-plastix-200: - summary: Example response for request 'plastix' - value: - additionalData: - nonScheme.transactionLimit: '5000' - nonScheme.transactionLimitCcy: EUR - pspReference: 851617891188737F - resultCode: Success - balance: - currency: EUR - value: 888 - post-paymentMethods-basic: - summary: Get available payment methods - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentMethods-basic-200: - summary: Example response for request 'basic' - value: - paymentMethods: - - details: - - details: - - key: ownerName - type: text - - key: bankLocationId - type: text - - key: bankAccountNumber - type: text - key: bankAccount - type: bankAccount - name: ACH Direct Debit - type: ach - - name: Adyen Voucher - type: adyen_test_voucher - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: Afterpay - type: afterpaytouch - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: Credit Card - type: scheme - - name: AliPay - type: alipay - - name: AliPay HK - type: alipay_hk - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Credit Card via AsiaPay - type: asiapay - - name: China UnionPay - type: asiapay_unionpay - - name: Baby Gift Card - type: babygiftcard - - name: Baloto - type: baloto - - name: BancNet - type: bancnet - - name: Bank Transfer (BG) - type: bankTransfer_BG - - name: Bank Transfer (CH) - type: bankTransfer_CH - - name: Bank Transfer (DE) - type: bankTransfer_DE - - name: Bank Transfer (FI) - type: bankTransfer_FI - - name: Bank Transfer (GB) - type: bankTransfer_GB - - name: Bank Transfer (HU) - type: bankTransfer_HU - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bank Transfer (IE) - type: bankTransfer_IE - - name: Electronic Bank Transfer (MX) - type: bankTransfer_MX_linked - - name: Bank Transfer (MX) - type: bankTransfer_MX_offline - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Bank Transfer (PL) - type: bankTransfer_PL - - name: Bank Transfer (SE) - type: bankTransfer_SE - - name: Bank Transfer (US) - type: bankTransfer_US - - name: Payconiq by Bancontact - type: bcmc_mobile - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: 99Bill - type: bill99 - - details: - - items: - - id: AUB_DIRECT - name: AU Small Finance Bank - - id: ALB_DIRECT - name: 'Allahabad Bank ' - - id: APG_DIRECT - name: Andhra Pragathi Grameena Bank - - id: BDN_DIRECT - name: Bandhan bank - - id: BBK_DIRECT - name: Bank of Bahrain and Kuwait - - id: BBR_DIRECT - name: Bank of Baroda - Retail Banking - - id: BCB_DIRECT - name: 'Bassien Catholic Co-Operative Bank ' - - id: CNB_DIRECT - name: Canara Bank - - id: SYD_DIRECT - name: Canara Bank (e-Syndicate) - - id: CSB_DIRECT - name: Catholic Syrian Bank - - id: CBI_DIRECT - name: Central Bank of India - - id: CUB_DIRECT - name: City Union Bank - - id: COB_DIRECT - name: Cosmos Bank - - id: DEN_DIRECT - name: Dena Bank - - id: DBK_DIRECT - name: Deutsche Bank - - id: DCB_DIRECT - name: Development Credit Bank - - id: DLB_DIRECT - name: Dhanlakshmi Bank - Retail Net Banking - - id: ESF_DIRECT - name: ESAF Small Finance Bank - - id: EQB_DIRECT - name: Equitas Small Finance Bank - - id: FBK_DIRECT - name: Federal Bank - - id: FNC_DIRECT - name: Fincare Bank - - id: HDF_DIRECT - name: HDFC Bank - - id: ICI_DIRECT - name: 'ICICI Bank ' - - id: IDB_DIRECT - name: IDBI Bank - Retail Net Banking - - id: IDN_DIRECT - name: IDFC FIRST Bank - - id: INB_DIRECT - name: Indian Bank - - id: IOB_DIRECT - name: Indian Overseas Bank - - id: IDS_DIRECT - name: IndusInd Bank - - id: JKB_DIRECT - name: Jammu & Kashmir Bank - - id: JNB_DIRECT - name: Jana Small Finance Bank - - id: JSB_DIRECT - name: Janata Sahakari Bank Ltd Pune - - id: KJB_DIRECT - name: Kalyan Janata Sahakari Bank - - id: KBL_DIRECT - name: Karnataka Bank Ltd - - id: KVB_DIRECT - name: Karur Vysya Bank - - id: 162_DIRECT - name: Kotak Bank - - id: LVR_DIRECT - name: Laxmi Vilas Bank - Retail - - id: NKB_DIRECT - name: NKGSB Co-op Bank - - id: NEB_DIRECT - name: North East Small Finance Bank - - id: OBC_DIRECT - name: PNB (Erstwhile-Oriental Bank of Commerce) - - id: UNI_DIRECT - name: PNB (Erstwhile-United Bank of India) - - id: PMC_DIRECT - name: Punjab & Maharastra Co-op Bank - - id: PSB_DIRECT - name: Punjab & Sind Bank - - id: CPN_DIRECT - name: 'Punjab National Bank - Corporate ' - - id: PNB_DIRECT - name: Punjab National Bank - Retail Banking - - id: RBL_DIRECT - name: RBL Bank Limited - - id: SWB_DIRECT - name: Saraswat Bank - - id: SHB_DIRECT - name: Shivalik Mercantile Cooperative Bank Ltd - - id: SIB_DIRECT - name: South Indian Bank - - id: SCB_DIRECT - name: Standard Chartered Bank - - id: SBI_DIRECT - name: State Bank of India - - id: SRB_DIRECT - name: Suryoday Small Finance Bank - - id: TJB_DIRECT - name: TJSB Bank - - id: TNC_DIRECT - name: Tamil Nadu State Co-operative Bank - - id: TMB_DIRECT - name: Tamilnad Mercantile Bank Ltd - - id: TBB_DIRECT - name: Thane Bharat Sahakari Bank Ltd - - id: MSB_DIRECT - name: The Mehsana Urban Co Op Bank Ltd - - id: UCO_DIRECT - name: UCO Bank - - id: UBI_DIRECT - name: Union Bank of India - - id: ADB_DIRECT - name: Union Bank of India (Erstwhile Andhra Bank) - - id: CRP_DIRECT - name: Union Bank of India (Erstwhile Corporation Bank) - - id: VRB_DIRECT - name: Varachha Co-operative Bank Limited - - id: VJB_DIRECT - name: Vijaya Bank - - id: YBK_DIRECT - name: Yes Bank - - id: ZOB_DIRECT - name: Zoroastrian Co-operative Bank Limited - - id: DBS_DIRECT - name: digibank by DBS - key: issuer - type: select - name: Online Banking India - type: billdesk_online - - name: UPI - type: billdesk_upi - - details: - - items: - - id: DCW_DIRECT - name: DCB Cippy - - id: ICC_DIRECT - name: ICC Cash Card - - id: OXY_DIRECT - name: Oxigen Wallet - - id: PCH_DIRECT - name: Pay World Money - key: issuer - type: select - name: Wallets India - type: billdesk_wallet - - name: Blik - type: blik - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Boleto - type: boleto - - name: Boleto Bancario - type: boletobancario_santander - - name: Bradesco - type: bradesco - - name: Cash-Ticket - type: cashticket - - name: CashU - type: cashu - - name: CCAvenue - type: ccavenue - - name: Mula Checkout - type: cellulant - - name: Chasin Giftcard - type: chasingiftcard - - name: Clearpay - type: clearpay - - name: ClickandBuy - type: clickandbuy - - name: Paiement en 3 fois par Cartes Bancaires - type: cofinoga_3xcb - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: DANA - type: dana - - name: DineroMail - type: dineromail - - name: Online bank transfer. - type: directEbanking - - name: Direct Debit Brazil - Banco do Brazil - type: directdebit_BR_bancodobrasil - - name: Direct Debit Brazil - Bradesco - type: directdebit_BR_bradesco - - name: Direct Debit Brazil - Caixa Economica Federal - type: directdebit_BR_caixa - - name: Direct Debit Brazil - HSBC - type: directdebit_BR_hsbc - - name: Direct Debit Brazil - Itau - type: directdebit_BR_itau - - name: Direct Debit Brazil - Santander - type: directdebit_BR_santander - - name: BACS Direct Debit - type: directdebit_GB - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Alfamart - type: doku_alfamart - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BCA Bank Transfer - type: doku_bca_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BNI VA - type: doku_bni_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: BRI VA - type: doku_bri_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: CIMB VA - type: doku_cimb_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Danamon VA - type: doku_danamon_va - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Indomaret - type: doku_indomaret - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Mandiri VA - type: doku_mandiri_va - - details: - - key: ovoId - type: text - name: OVO - type: doku_ovo - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - type: text - name: Bank Transfer - type: doku_permata_lite_atm - - details: - - key: shopperEmail - type: emailAddress - - key: firstName - type: text - - key: lastName - type: text - - key: infix - optional: true - 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 - type: dragonpay_ebanking - - name: GCash - type: dragonpay_gcash - - name: Over The Counter Banks - type: dragonpay_otc_banking - - name: OTC non-Bank via Dragonpay - type: dragonpay_otc_non_banking - - name: Convenience Stores - type: dragonpay_otc_philippines - - name: 7/11 - type: dragonpay_seveneleven - - name: eagleeye_voucher - type: eagleeye_voucher - - name: Finnish E-Banking - type: ebanking_FI - - name: Pay-easy ATM - type: econtext_atm - - name: Online Banking - type: econtext_online - - name: 7-Eleven - type: econtext_seven_eleven - - name: Convenience Stores - type: econtext_stores - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Lastschrift (ELV) - type: elv - - details: - - items: - - id: '231' - name: POP Pankki - - id: '551' - name: "Komer\u010Dn\xED banka" - - id: '232' - name: Aktia - - id: '552' - name: Raiffeisen - - id: '233' - name: "S\xE4\xE4st\xF6pankki" - - id: '750' - name: Swedbank - - id: '211' - name: Nordea - - id: '553' - name: "\u010CSOB" - - id: '234' - name: S-Pankki - - id: '751' - name: SEB - - id: '554' - name: Moneta - - id: '235' - name: OmaSP - - id: '752' - name: Nordea - - id: '213' - name: Op-Pohjola - - id: '555' - name: UniCredit - - id: '753' - name: LHV - - id: '556' - name: Fio - - id: '557' - name: mBank - - id: '216' - name: Handelsbanken - - id: '558' - name: Air Bank - - id: '260' - name: "L\xE4nsf\xF6rs\xE4kringar" - - id: '240' - name: BankDeposit - - id: '265' - name: Sparbanken - - id: '640' - name: BankDeposit - - id: '200' - name: "\xC5landsbanken" - - id: '940' - name: Swedbank - - id: '500' - name: "\u010Cesk\xE1 spo\u0159itelna" - - id: '720' - name: Swedbank - - id: '941' - name: SEB - - id: '204' - name: Danske Bank - - id: '721' - name: SEB - - id: '942' - name: Citadele - - id: '205' - name: Handelsbanken - - id: '722' - name: DNB - - id: '943' - name: DNB - - id: '206' - name: Nordea - - id: '723' - name: "\u0160iauli\u0173 bankas" - - id: '207' - name: SEB - - id: '724' - name: Nordea - - id: '505' - name: "Komer\u010Dn\xED banka" - - id: '208' - name: Skandiabanken - - id: '209' - name: Swedbank - key: issuer - type: select - name: Bank Payment - type: entercash - - name: Nationale Entertainment Card - type: entertainmentcard - - details: - - items: - - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 - name: Dolomitenbank - - id: ee9fc487-ebe0-486c-8101-17dce5141a67 - name: Raiffeissen Bankengruppe - - id: 6765e225-a0dc-4481-9666-e26303d4f221 - name: Hypo Tirol Bank AG - - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc - name: Sparda Bank Wien - - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f - name: Schoellerbank AG - - id: e2e97aaa-de4c-4e18-9431-d99790773433 - name: Volksbank Gruppe - - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 - name: Immo-Bank - - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 - name: Bank Austria - - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 - name: Easybank AG - - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a - name: VR-BankBraunau - - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 - name: Volkskreditbank - - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 - name: Erste Bank und Sparkassen - - id: ba7199cc-f057-42f2-9856-2378abf21638 - name: BAWAG P.S.K. Gruppe - key: issuer - type: select - name: EPS - type: eps - - name: Expert Cadeaukaart - type: expertgiftcard - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 3x Oney - type: facilypay_3x - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: FR - name: France - - id: ES - name: Spain - key: country - type: select - key: deliveryAddress - optional: true - type: address - name: 4x Oney - type: facilypay_4x - - name: Fashioncheque - type: fashioncheque - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: Fawry - type: fawry - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Fonq Giftcard - type: fonqgiftcard - - name: Gall & Gall - type: gallgall - - name: GCash - type: gcash - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - details: - - key: bic - type: text - name: GiroPay - type: giropay - - name: Givex - type: givex - - name: Globe GCash - type: globegcash - - name: Goldsmiths Card - type: goldsmithscard - - name: GoPay Wallet - type: gopay_wallet - - name: OVO - type: grabpay_ID - - name: GrabPay - type: grabpay_PH - - name: GrabPay - type: grabpay_SG - - name: Hallmark Card - type: hallmarkcard - - name: HDFC - type: hdfc - - name: Hunkemoller Member Card - type: hmclub - - name: Hunkemoller Lingerie Card - type: hmlingerie - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - name: igive - type: igive - - name: Korean Account Transfer (IniPay) - type: inicisIniPay_accounttransfer - - name: Korean Credit Cards (IniPay) - type: inicisIniPay_creditcard - - name: Korean Mobile Phone (IniPay) - type: inicisIniPay_mobilephone - - name: Korean Virtual Account (IniPay) - type: inicisIniPay_virtualaccount - - name: Korean Account Transfer (Mobile) - type: inicisMobile_accounttransfer - - name: Korean Credit Cards (Mobile) - type: inicisMobile_creditcard - - name: Korean Mobile Phone (Mobile) - type: inicisMobile_mobilephone - - name: Korean Virtual Account (Mobile) - type: inicisMobile_virtualaccount - - name: Korean Credit Cards - type: inicis_creditcard - - name: "Interac\xAE Online" - type: interac - - name: Instant EFT - type: ipay - - name: iPay88 - type: ipay88 - - name: isracard - type: isracard - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: KakaoPay - type: kakaopay - - name: Karen Millen Card - type: karenmillen - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Bank Transfer - type: kcp_banktransfer - - name: "Korea\u2013issued cards" - type: kcp_creditcard - - name: PayCo - type: kcp_payco - - name: Naver Pay - type: kcp_naverpay - - name: Virtual Account via KCP - type: kcp_va - - name: Pay later with Klarna. - type: klarna - - name: Pay over time with Klarna. - type: klarna_account - - name: Klarna B2B - type: klarna_b2b - - name: Pay now with Klarna. - type: klarna_paynow - - name: Leisure Card - type: leisurecard - - name: China Credit Card - type: lianlianpay_creditcard - - name: China Debit Card - type: lianlianpay_debitcard - - details: - - key: telephoneNumber - type: tel - name: China Online Banking - Credit Card - type: lianlianpay_ebanking_credit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '4031000' - name: Bank of Beijing - - id: '01040000' - name: Bank of China - - id: '03020000' - name: China Citic Bank - - id: '01050000' - name: China Construction Bank - - id: '03030000' - name: China Everbright Bank - - id: 03080000 - name: China Merchants Bank - - id: '03050000' - name: China Minsheng Banking Group - - id: '03040000' - name: Hua Xia Bank Co - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03070000' - name: PingAn Bank - - id: '1000000' - name: Postal Savings Bank of China - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Debit Card - type: lianlianpay_ebanking_debit - - details: - - items: - - id: '01030000' - name: Agricultural Bank of China - - id: '01050000' - name: China Construction Bank - - id: 03080000 - name: China Merchants Bank - - id: '01020000' - name: Industrial and Commercial Bank of China - - id: '03100000' - name: Shanghai Pudong Development Bank - key: issuer - type: select - - key: telephoneNumber - type: tel - name: China Online Banking - Enterprise - type: lianlianpay_ebanking_enterprise - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - name: Love2Shop GiftCard - type: love2shop - - details: - - key: shopper.firstName - type: text - - key: shopper.lastName - type: text - - key: shopper.gender - type: text - - key: shopperEmail - type: emailAddress - - key: telephoneNumber - type: tel - - key: countryCode - type: text - name: mada - type: mada - - name: Mappin & Webb Card - type: mappinwebbcard - - name: MB WAY - type: mbway - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: Mercado Pago - type: mercadopago - - name: MobilePay - type: mobilepay - - name: AliPay via Razer Merchant Services - type: molpay_alipay - - name: 7-Eleven - type: molpay_cash - - name: CIMB Virtual Account - type: molpay_cimb_va - - name: Malaysia E-Banking via Razer Merchant Services - type: molpay_ebanking_MY - - details: - - items: - - id: vtcpay-vietinbank - name: Vietinbank - - id: vtcpay-bidv - name: BIDV - - id: vtcpay-agribank - name: Agribank - - id: vtcpay-mb - name: MB Bank - - id: vtcpay-sacombank - name: Sacombank - - id: vtcpay-dongabank - name: DongABank - - id: vtcpay-maritimebank - name: MaritimeBank - - id: vtcpay-vietcombank - name: Vietcombank - - id: vtcpay-acb - name: ACB - - id: vtcpay-techcombank - name: Techcombank - key: issuer - type: select - name: Vietnam E-Banking - type: molpay_ebanking_VN - - details: - - items: - - id: fpx_bimb - name: Bank Islam - - id: fpx_uob - name: UOB Bank - - id: fpx_cimbclicks - name: CIMB Clicks - - id: fpx_kfh - name: Kuwait Finance House - - id: fpx_rhb - name: RHB Now - - id: fpx_abmb - name: Alliance Bank - - id: fpx_amb - name: Am Online - - id: fpx_hsbc - name: HSBC - - id: fpx_abb - name: Affin Bank - - id: fpx_ocbc - name: OCBC Bank - - id: fpx_pbb - name: Public Bank - - id: fpx_scb - name: Standard Chartered Bank - - id: fpx_bsn - name: Bank Simpanan Nasional - - id: fpx_mb2u - name: Maybank2u - - id: fpx_hlb - name: Hong Leong Connect - - id: fpx_bmmb - name: Bank Muamalat - - id: fpx_bkrm - name: Bank Rakyat - key: issuer - type: select - name: Malaysia E-Banking - type: molpay_ebanking_fpx_MY - - name: eNETS Debit - type: molpay_enetsd - - name: epay - type: molpay_epay - - name: Esapay - type: molpay_esapay - - name: MyClear FPX - type: molpay_fpx - - name: Maybank2u - type: molpay_maybank2u - - name: Nganluong - type: molpay_nganluong - - name: Tesco Lotus - type: molpay_paysbuy - - name: MOLPoints - type: molpay_points - - name: RHB Now - type: molpay_rhb - - name: SAM by SingPost - type: molpay_singpost - - name: MOLWallet - type: molpay_wallet - - name: MoMo ATM - type: momo_atm - - name: Momo Wallet - type: momo_wallet - - name: Moneybookers - type: moneybookers - - name: Multibanco - type: multibanco - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: BankAxess - type: netaxept_bankaxess - - name: NETELLER - type: neteller - - name: Onebip - type: onebip - - name: One Two Three - type: onetwothree - - name: Local Polish Payment Methods (P24) - type: onlineBanking_PL - - details: - - items: - - id: '1' - name: Model Bank v2 - key: issuer - type: select - name: Online banking - type: openbanking_UK - - name: Oxxo - type: oxxo - - name: Pathe Giftcard - type: pathegiftcard - - name: PayBright - type: paybright - - name: PayMaya Wallet - type: paymaya_wallet - - name: PayPal - type: paypal - - name: Paysafecard - type: paysafecard - - name: Payshop - type: payshop - - name: PayD AMT via Paythru - type: paythru_amt - - name: EFT via Paythru - type: paythru_eft - - name: PayTM - type: paytm - - details: - - key: virtualPaymentAddress - type: text - name: PayU UPI - type: payu_IN_upi - - name: EFT Pro via PayU - type: payu_ZA_eftpro - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: pix - type: pix - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Podium Card - type: podiumcard - - name: POLi - type: poli - - name: PPS - type: pps - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Illicado Gift Card - type: prosodie_illicado - - name: PSE - type: pse - - details: - - items: - - id: '+7' - name: RU - - id: '+9955' - name: GE - - id: '+507' - name: PA - - id: '+44' - name: GB - - id: '+992' - name: TJ - - id: '+370' - name: LT - - id: '+972' - name: IL - - id: '+996' - name: KG - - id: '+380' - name: UA - - id: '+84' - name: VN - - id: '+90' - name: TR - - id: '+994' - name: AZ - - id: '+374' - name: AM - - id: '+371' - name: LV - - id: '+91' - name: IN - - id: '+66' - name: TH - - id: '+373' - name: MD - - id: '+1' - name: US - - id: '+81' - name: JP - - id: '+998' - name: UZ - - id: '+77' - name: KZ - - id: '+375' - name: BY - - id: '+372' - name: EE - - id: '+40' - name: RO - - id: '+82' - name: KR - key: qiwiwallet.telephoneNumberPrefix - type: select - - key: qiwiwallet.telephoneNumber - type: text - name: Qiwi Wallet - type: qiwiwallet - - name: RatePay Invoice - type: ratepay - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: SafetyPay - type: safetypay - - name: SafetyPay Cash - type: safetypay_cash - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: SEB Direktbetalning - type: sebdirectpayment - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: 7-Eleven - type: seveneleven - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: Swish - type: swish - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: TenPay - type: tenpay - - name: The Sting Giftcard - type: thestinggiftcard - - name: TrueMoney - type: truemoney - - name: Trustly - type: trustly - - name: Online Banking by Trustpay - type: trustpay - - name: TWINT - type: twint - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - details: - - key: virtualPaymentAddress - type: text - name: UPI Collect - type: upi_collect - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: telephoneNumber - optional: true - type: tel - name: Vipps - type: vipps - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: VVV Giftcard - type: vvvgiftcard - - name: Webshop Giftcard - type: webshopgiftcard - - name: WeChat Pay - type: wechatpayMiniProgram - - name: WeChat Pay - type: wechatpayQR - - name: WeChat Pay - type: wechatpayWeb - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: WOS Card - type: woscard - - name: Alfa-Click - type: yandex_alfaclick - - name: Pay using bank card - type: yandex_bank_card - - name: Cash terminals - type: yandex_cash - - name: Pay using installments - type: yandex_installments - - name: YooMoney - type: yandex_money - - name: Promsvyazbank - type: yandex_promsvyazbank - - name: Sberbank Online - type: yandex_sberbank - - name: WebMoney - type: yandex_webmoney - - name: Your Gift - type: yourgift - - name: Zip - type: zip - post-paymentMethods-filtered: - summary: Get payment methods based on the country and amount - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - countryCode: NL - shopperLocale: nl-NL - amount: - currency: EUR - value: 1000 - post-paymentMethods-filtered-200: - summary: Example response for request 'filtered' - value: - paymentMethods: - - details: - - items: - - id: '1121' - name: Test Issuer - - id: '1154' - name: Test Issuer 5 - - id: '1153' - name: Test Issuer 4 - - id: '1152' - name: Test Issuer 3 - - id: '1151' - name: Test Issuer 2 - - id: '1162' - name: Test Issuer Cancelled - - id: '1161' - name: Test Issuer Pending - - id: '1160' - name: Test Issuer Refused - - id: '1159' - name: Test Issuer 10 - - id: '1158' - name: Test Issuer 9 - - id: '1157' - name: Test Issuer 8 - - id: '1156' - name: Test Issuer 7 - - id: '1155' - name: Test Issuer 6 - key: issuer - type: select - name: iDEAL - type: ideal - - details: - - key: encryptedCardNumber - type: cardToken - - key: encryptedSecurityCode - type: cardToken - - key: encryptedExpiryMonth - type: cardToken - - key: encryptedExpiryYear - type: cardToken - - key: holderName - optional: true - type: text - name: "Hitelk\xE1rtya" - type: scheme - - name: PayPal - type: paypal - - details: - - details: - - key: firstName - type: text - - key: lastName - type: text - - items: - - id: M - name: male - - id: F - name: female - key: gender - type: radio - - key: dateOfBirth - type: date - - key: telephoneNumber - type: tel - - key: shopperEmail - type: emailAddress - key: personalDetails - type: fieldSet - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: billingAddress - type: address - - key: separateDeliveryAddress - optional: true - type: boolean - value: 'false' - - details: - - key: street - type: text - - key: houseNumberOrName - type: text - - key: city - type: text - - key: postalCode - type: text - - key: stateOrProvince - optional: true - type: text - - items: - - id: NL - name: Netherlands - - id: BE - name: Belgium - key: country - type: select - value: NL - key: deliveryAddress - optional: true - type: address - name: AfterPay Invoice - type: afterpay_default - - name: Pay later with Klarna. - type: klarna - - details: - - key: sepa.ownerName - type: text - - key: sepa.ibanNumber - type: text - name: SEPA Direct Debit - type: sepadirectdebit - - name: Paysafecard - type: paysafecard - - name: Bijenkorf Cadeaucard - type: bijcadeaucard - - name: Fonq Giftcard - type: fonqgiftcard - - name: Bank Transfer (NL) - type: bankTransfer_NL - - name: Pathe Giftcard - type: pathegiftcard - - name: VVV Giftcard - type: vvvgiftcard - - name: Podium Card - type: podiumcard - - name: RatePay Direct Debit - type: ratepay_directdebit - - name: Rituals Giftcard - type: rituals - - name: Hunkemoller Lingerie Card - type: hmlingerie - - name: Primera Cadeaukaart - type: primeracadeaucard - - name: Fashioncheque - type: fashioncheque - - name: NETELLER - type: neteller - - name: Adyen Voucher - type: adyen_test_voucher - - name: AfterPay B2B - type: afterpay_b2b - - name: AfterPay DirectDebit - type: afterpay_directdebit - - name: AliPay - type: alipay - - name: AliPay - type: alipay_wap - - details: - - key: additionalData.androidpay.token - type: androidPayToken - name: Android Pay - type: androidpay - - details: - - key: additionalData.applepay.token - type: applePayToken - name: Apple Pay - type: applepay - - name: Baby Gift Card - type: babygiftcard - - name: SEPA Bank Transfer - type: bankTransfer_IBAN - - name: Bloemen Giftcard - type: bloemengiftcard - - name: Boekenbon Giftcard - type: boekenbon - - name: Cash-Ticket - type: cashticket - - name: Chasin Giftcard - type: chasingiftcard - - name: ClickandBuy - type: clickandbuy - - name: Costes Giftcard - type: costesgiftcard - - name: custom_settlement - type: custom_settlement - - name: eft_directdebit_CA - type: eft_directdebit_CA - - name: Nationale Entertainment Card - type: entertainmentcard - - name: Expert Cadeaukaart - type: expertgiftcard - - name: FijnCadeau - type: fijncadeau - - name: Fleurop Bloemenbon - type: fleuropbloemenbon - - name: Gall & Gall - type: gallgall - - name: Generic GiftCard - type: genericgiftcard - - name: GiftFor2 - type: giftfor2card - - name: Givex - type: givex - - name: Goldsmiths Card - type: goldsmithscard - - name: Hunkemoller Member Card - type: hmclub - - name: Phone Payment - type: ivr - - name: Landline phone - type: ivrLandline - - name: Mobile phone - type: ivrMobile - - name: Kado Wereld - type: kadowereld - - name: Karen Millen GiftCard - type: karenmillengiftcard - - name: Leisure Card - type: leisurecard - - name: Loods5 Cadeaukaart - type: loods5giftcard - - name: Loods5 Tegoedbon - type: loods5prepaidcard - - details: - - key: additionalData.amazonPayToken - type: text - name: Amazon Pay - supportsRecurring: true - type: amazonpay - - name: MOLPoints - type: molpay_points - - name: Moneybookers - type: moneybookers - - name: De Nationale Musicalcard - type: musicalcard - - name: Nationale Bioscoopbon - type: nationalebioscoopbon - - name: Nationale Tuinbon - type: nationaletuinbon - - name: Nationale Verwen Cadeaubon - type: nationaleverwencadeaubon - - name: Onebip - type: onebip - - details: - - key: additionalData.paywithgoogle.token - type: payWithGoogleToken - name: Google Pay - type: paywithgoogle - - name: Plastix - type: plastix - - name: Pluim - type: pluimgiftcard - - name: Illicado Gift Card - type: prosodie_illicado - - name: RatePay Invoice - type: ratepay - - name: Rob Peetoom Giftcard - type: robpeetoomgiftcard - - name: Shoes&Accessories Cadeau - type: sagiftcard - - name: Score Giftcard - type: scoregiftcard - - name: Premium SMS - type: sms - - name: SVS - type: svs - - name: TCS Test GiftCard - type: tcstestgiftcard - - name: The Sting Giftcard - type: thestinggiftcard - - name: Ukash - type: ukash - - name: UnionPay - type: unionpay - - name: Valuelink - type: valuelink - - name: V&D Cadeaukaart - type: vdcadeaucard - - details: - - key: additionalData.visacheckout.callId - type: text - name: Visa Checkout - type: visacheckout - - name: VVV Cadeaubon - type: vvvcadeaubon - - name: Webshop Giftcard - type: webshopgiftcard - - name: WE Fashion Giftcard - type: wefashiongiftcard - - name: Western Union - type: westernunion - - name: Winkel Cheque - type: winkelcheque - - name: Your Gift - type: yourgift - post-paymentMethods-include-oneclick: - summary: Get payment methods including stored card details + scheme: basic + type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string + examples: + generic: + summary: Response code 401. Unauthorized. value: - merchantAccount: YOUR_MERCHANT_ACCOUNT + status: 401 + errorCode: '000' + message: HTTP Status Response - Unauthorized + errorType: security + get-paymentLinks-linkId-basic: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A + patch-paymentLinks-linkId-basic: + summary: Update the status of a payment link + value: + status: expired + post-donations-donations: + summary: Start a transaction for donation + value: amount: currency: EUR value: 1000 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-paymentMethods-include-oneclick-200: - summary: Example response for request 'include-oneclick' + reference: YOUR_DONATION_REFERENCE + paymentMethod: + type: scheme + cvc: '123' + donationToken: YOUR_DONATION_TOKEN + donationOriginalPspReference: 991559660454807J + donationAccount: CHARITY_ACCOUNT + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + shopperInteraction: Ecommerce + post-orders-basic: + summary: Create an order + value: + reference: YOUR_ORDER_REFERENCE + amount: + value: 2500 + currency: EUR + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic: + summary: Cancel an order + value: + order: + pspReference: '8815517812932012' + orderData: 823fh892f8f18f4...148f13f9f3f + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-originKeys-basic: + summary: Get origin keys + value: + originDomains: + - https://www.your-domain1.com + - https://www.your-domain2.com + - https://www.your-domain3.com + post-paymentLinks-basic: + summary: Create a payment link + value: + reference: YOUR_ORDER_NUMBER + amount: + value: 1250 + currency: BRL + countryCode: BR + merchantAccount: YOUR_MERCHANT_ACCOUNT + shopperReference: YOUR_UNIQUE_SHOPPER_ID + shopperEmail: test@email.com + shopperLocale: pt-BR + billingAddress: + street: Roque Petroni Jr + postalCode: '59000060' + city: "S\xE3o Paulo" + houseNumberOrName: '999' + country: BR + stateOrProvince: SP + deliveryAddress: + street: Roque Petroni Jr + postalCode: '59000060' + city: "S\xE3o Paulo" + houseNumberOrName: '999' + country: BR + stateOrProvince: SP + post-paymentMethods-balance-basic: + summary: Retrieve gift card balance + value: + paymentMethod: + type: givex + number: '4126491073027401' + cvc: '737' + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix: + summary: Retrieve gift card balance + value: + paymentMethod: + type: plastix + number: '4010100000000000000' + cvc: '73737' + holderName: BALANCE EUR 888 + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic: + summary: Get available payment methods + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-filtered: + summary: Example response for request 'filtered' value: paymentMethods: - details: @@ -11855,7 +10650,7 @@ components: - key: holderName optional: true type: text - name: Credit Card + name: "Hitelk\xE1rtya" type: scheme - name: PayPal type: paypal @@ -12114,6 +10909,15 @@ components: type: winkelcheque - name: Your Gift type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -12130,24 +10934,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: - summary: Set up a payment session with the option to store card details - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - enableOneClick: true - enableRecurring: true - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.7.0 - post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12195,22 +10981,6 @@ components: sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... @@ -12267,21 +11037,6 @@ components: origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-2-web-200: - summary: Example response for request 'card-3d-secure-2-web' - value: - additionalData: - cvcResult: 1 Matches - authCode: 097410 - avsResult: 4 AVS not supported for this card type - avsResultRaw: C - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VHQOF - pspReference: 993617895214576G - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -12302,21 +11057,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-direct-200: - summary: Example response for request 'card-3d-secure-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 054817 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VIO26 - pspReference: 993617895217578K - resultCode: Authorised - merchantReference: string post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -12337,21 +11077,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields-200: - summary: Example response for request 'card-3d-secure-securedfields' - value: - additionalData: - cvcResult: 1 Matches - authCode: '046773' - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCAVH - pspReference: 993617895196572H - resultCode: Authorised - merchantReference: string post-payments-card-direct: summary: Make a card payment value: @@ -12368,37 +11093,7 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct-200: - summary: Example response for request 'card-direct' - value: - additionalData: - cvcResult: 1 Matches - authCode: 044925 - avsResult: 4 AVS not supported for this card type - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VEP3H - pspReference: 993617895204576J - resultCode: Authorised - merchantReference: string post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields-200: summary: Example response for request 'card-securedfields' value: additionalData: @@ -12424,25 +11119,6 @@ components: details: redirectResult: X6XtfGC3!Y... post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF-200: summary: Example response for request 'enableOneClick-SF' value: additionalData: @@ -12480,24 +11156,6 @@ components: storePaymentMethod: true returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw-200: - summary: Example response for request 'enableOneClick-raw' - value: - additionalData: - cvcResult: 1 Matches - authCode: '003704' - avsResult: 4 AVS not supported for this card type - recurring.recurringDetailReference: '9916178934434753' - recurringProcessingModel: CardOnFile - avsResultRaw: '4' - cvcResultRaw: M - refusalReasonRaw: AUTHORISED - recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCKO0 - pspReference: 993617895197573E - resultCode: Authorised - merchantReference: string post-payments-giropay: summary: Make a giropay payment value: @@ -12509,23 +11167,6 @@ components: type: giropay returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay-200: - summary: Example response for request 'giropay' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - paymentMethodType: giropay - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA post-payments-googlepay: summary: Make a Google Pay payment value: @@ -12550,23 +11191,6 @@ components: issuer: '1121' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal-200: - summary: Example response for request 'ideal' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - paymentMethodType: ideal - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ post-payments-klarna: summary: Make a Klarna payment value: @@ -12677,23 +11301,6 @@ components: type: directEbanking returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-sofort-200: - summary: Example response for request 'sofort' - value: - resultCode: RedirectShopper - action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - paymentMethodType: directEbanking - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA - method: GET - type: redirect - details: - - key: payload - type: text - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== - redirect: - method: GET - url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA post-payments-split: summary: Split a payment between a sub-merchant and a platform account value: @@ -12722,26 +11329,6 @@ components: type: Commission reference: '6124146' post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-subscription-first-transaction-200: summary: Example response for request 'subscription-first-transaction' value: additionalData: diff --git a/yaml/FundService-v3.yaml b/yaml/FundService-v3.yaml index 22ee809f..9e06cb79 100644 --- a/yaml/FundService-v3.yaml +++ b/yaml/FundService-v3.yaml @@ -60,6 +60,8 @@ x-groups: paths: /accountHolderBalance: post: + tags: + - General summary: Retrieve the balance(s) of an account holder. description: 'This endpoint is used to retrieve the balance(s) of the accounts of an account holder. An account''s balances are on a per-currency basis (i.e., @@ -117,6 +119,8 @@ paths: description: Internal Server Error - the server could not process the request. /accountHolderTransactionList: post: + tags: + - General summary: Retrieve a list of transactions. description: This endpoint is used to retrieve a list of Transactions for an account holder's accounts. The accounts and Transaction Statuses to be included @@ -179,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /payoutAccountHolder: post: + tags: + - General summary: Disburse a specified amount from an account to the account holder. description: This endpoint is used to pay out a specified amount from an account to the bank account of the account's account holder. @@ -242,6 +248,8 @@ paths: description: Internal Server Error - the server could not process the request. /refundFundsTransfer: post: + tags: + - General summary: Make a refund of the existing transfer funds transfer. description: 'This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different @@ -306,6 +314,8 @@ paths: description: Internal Server Error - the server could not process the request. /refundNotPaidOutTransfers: post: + tags: + - General summary: Refund all transactions of an account since the most recent payout. description: This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a @@ -374,6 +384,8 @@ paths: description: Internal Server Error - the server could not process the request. /setupBeneficiary: post: + tags: + - General summary: Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary. description: This endpoint is used to define a benefactor and a beneficiary @@ -442,6 +454,8 @@ paths: description: Internal Server Error - the server could not process the request. /transferFunds: post: + tags: + - General summary: Transfer funds from one platform account to another. description: This endpoint is used to transfer funds from one account to another account. Both accounts must be in the same marketplace, but can have different @@ -954,7 +968,7 @@ components: maxLength: 35 type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another. type: string @@ -968,7 +982,7 @@ components: description: The unique ID of the Bank Account to which the payout was made. type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions. type: string @@ -1155,11 +1169,11 @@ components: description: The merchant reference of a transaction. type: string paymentPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related authorisation or transfer. type: string payoutPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related payout. type: string pspReference: @@ -1249,7 +1263,7 @@ components: >The state of the Account Holder of this account must be Active.' type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another. type: string @@ -1273,7 +1287,7 @@ components: TransferFundsResponse: properties: merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions. type: string diff --git a/yaml/FundService-v5.yaml b/yaml/FundService-v5.yaml index 3931ada7..62988918 100644 --- a/yaml/FundService-v5.yaml +++ b/yaml/FundService-v5.yaml @@ -60,6 +60,8 @@ x-groups: paths: /accountHolderBalance: post: + tags: + - General summary: Retrieve the balance(s) of an account holder. description: 'This endpoint is used to retrieve the balance(s) of the accounts of an account holder. An account''s balances are on a per-currency basis (i.e., @@ -117,6 +119,8 @@ paths: description: Internal Server Error - the server could not process the request. /accountHolderTransactionList: post: + tags: + - General summary: Retrieve a list of transactions. description: This endpoint is used to retrieve a list of Transactions for an account holder's accounts. The accounts and Transaction Statuses to be included @@ -179,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /payoutAccountHolder: post: + tags: + - General summary: Disburse a specified amount from an account to the account holder. description: This endpoint is used to pay out a specified amount from an account to the bank account of the account's account holder. @@ -242,6 +248,8 @@ paths: description: Internal Server Error - the server could not process the request. /refundFundsTransfer: post: + tags: + - General summary: Make a refund of the existing transfer funds transfer. description: 'This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different @@ -306,6 +314,8 @@ paths: description: Internal Server Error - the server could not process the request. /refundNotPaidOutTransfers: post: + tags: + - General summary: Refund all transactions of an account since the most recent payout. description: This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a @@ -374,6 +384,8 @@ paths: description: Internal Server Error - the server could not process the request. /setupBeneficiary: post: + tags: + - General summary: Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary. description: This endpoint is used to define a benefactor and a beneficiary @@ -442,6 +454,8 @@ paths: description: Internal Server Error - the server could not process the request. /transferFunds: post: + tags: + - General summary: Transfer funds from one platform account to another. description: This endpoint is used to transfer funds from one account to another account. Both accounts must be in the same marketplace, but can have different @@ -530,7 +544,7 @@ components: $ref: '#/components/schemas/AccountDetailBalance' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -662,7 +676,7 @@ components: $ref: '#/components/schemas/AccountTransactionList' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -725,7 +739,7 @@ components: description: The name of the bank account. type: string bankAccountReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Merchant reference to the bank account. type: string bankAccountUUID: @@ -918,7 +932,7 @@ components: $ref: '#/components/schemas/Amount' type: array onHoldBalance: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The list of on hold balances held by the account. items: $ref: '#/components/schemas/Amount' @@ -1038,6 +1052,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -1058,6 +1073,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -1126,19 +1142,19 @@ components: maxLength: 35 type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another. type: string payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'The unique ID of the payout method held by the Account Holder to which the payout is to be made. If left blank, a payout instrument is automatically selected.' type: string payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' default: STANDARD description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' @@ -1157,19 +1173,19 @@ components: description: The unique ID of the Bank Account to which the payout was made. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: $ref: '#/components/schemas/ErrorFieldType' type: array merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions. type: string payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' default: STANDARD description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' @@ -1203,7 +1219,7 @@ components: RefundFundsTransferResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1241,7 +1257,7 @@ components: RefundNotPaidOutTransfersResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1290,7 +1306,7 @@ components: SetupBeneficiaryResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1338,11 +1354,11 @@ components: description: The merchant reference of a transaction. type: string paymentPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related authorisation or transfer. type: string payoutPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related payout. type: string pspReference: @@ -1432,7 +1448,7 @@ components: >The state of the Account Holder of this account must be Active.' type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another. type: string @@ -1456,14 +1472,14 @@ components: TransferFundsResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: $ref: '#/components/schemas/ErrorFieldType' type: array merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions. type: string diff --git a/yaml/FundService-v6.yaml b/yaml/FundService-v6.yaml index 6fc9a4a8..b33c4605 100644 --- a/yaml/FundService-v6.yaml +++ b/yaml/FundService-v6.yaml @@ -60,6 +60,8 @@ x-groups: paths: /accountHolderBalance: post: + tags: + - General summary: Retrieve the balance(s) of an account holder. description: 'This endpoint is used to retrieve the balance(s) of the accounts of an account holder. An account''s balances are on a per-currency basis (i.e., @@ -117,6 +119,8 @@ paths: description: Internal Server Error - the server could not process the request. /accountHolderTransactionList: post: + tags: + - General summary: Retrieve a list of transactions. description: This endpoint is used to retrieve a list of Transactions for an account holder's accounts. The accounts and Transaction Statuses to be included @@ -179,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /payoutAccountHolder: post: + tags: + - General summary: Disburse a specified amount from an account to the account holder. description: This endpoint is used to pay out a specified amount from an account to the bank account of the account's account holder. @@ -242,6 +248,8 @@ paths: description: Internal Server Error - the server could not process the request. /refundFundsTransfer: post: + tags: + - General summary: Make a refund of the existing transfer funds transfer. description: 'This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different @@ -306,6 +314,8 @@ paths: description: Internal Server Error - the server could not process the request. /refundNotPaidOutTransfers: post: + tags: + - General summary: Refund all transactions of an account since the most recent payout. description: This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a @@ -374,6 +384,8 @@ paths: description: Internal Server Error - the server could not process the request. /setupBeneficiary: post: + tags: + - General summary: Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary. description: This endpoint is used to define a benefactor and a beneficiary @@ -442,6 +454,8 @@ paths: description: Internal Server Error - the server could not process the request. /transferFunds: post: + tags: + - General summary: Transfer funds from one platform account to another. description: This endpoint is used to transfer funds from one account to another account. Both accounts must be in the same marketplace, but can have different @@ -530,7 +544,7 @@ components: $ref: '#/components/schemas/AccountDetailBalance' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -662,7 +676,7 @@ components: $ref: '#/components/schemas/AccountTransactionList' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -725,7 +739,7 @@ components: description: The name of the bank account. type: string bankAccountReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Merchant reference to the bank account. type: string bankAccountUUID: @@ -918,7 +932,7 @@ components: $ref: '#/components/schemas/Amount' type: array onHoldBalance: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The list of on hold balances held by the account. items: $ref: '#/components/schemas/Amount' @@ -1038,6 +1052,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -1058,6 +1073,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -1126,19 +1142,19 @@ components: maxLength: 35 type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another. type: string payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'The unique ID of the payout method held by the Account Holder to which the payout is to be made. If left blank, a payout instrument is automatically selected.' type: string payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' default: STANDARD description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' @@ -1157,19 +1173,19 @@ components: description: The unique ID of the Bank Account to which the payout was made. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: $ref: '#/components/schemas/ErrorFieldType' type: array merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions. type: string payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' default: STANDARD description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' @@ -1203,7 +1219,7 @@ components: RefundFundsTransferResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1241,7 +1257,7 @@ components: RefundNotPaidOutTransfersResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1290,7 +1306,7 @@ components: SetupBeneficiaryResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1338,11 +1354,11 @@ components: description: The merchant reference of a transaction. type: string paymentPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related authorisation or transfer. type: string payoutPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related payout. type: string pspReference: @@ -1432,7 +1448,7 @@ components: >The state of the Account Holder of this account must be Active.' type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another. type: string @@ -1456,14 +1472,14 @@ components: TransferFundsResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: $ref: '#/components/schemas/ErrorFieldType' type: array merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions. type: string diff --git a/yaml/HopService-v1.yaml b/yaml/HopService-v1.yaml index 160ae7f9..164e3877 100644 --- a/yaml/HopService-v1.yaml +++ b/yaml/HopService-v1.yaml @@ -60,6 +60,8 @@ x-groups: paths: /getOnboardingUrl: post: + tags: + - Hosted Onboarding Page summary: Get a link to a Adyen-hosted onboarding page. description: 'Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer @@ -114,6 +116,8 @@ paths: description: Internal Server Error - the server could not process the request. /getPciQuestionnaireUrl: post: + tags: + - PCI Compliance Questionnaire Page summary: Get a link to a PCI compliance questionnaire. description: "Returns a link to a PCI compliance questionnaire that you can\ \ send to your account holder.\n > You should only use this endpoint if you\ @@ -172,19 +176,23 @@ components: properties: bankDetails: description: Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) - must be collected. Defaults to **true**. + must be collected. Default is **true**. type: boolean businessDetails: description: Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) - must be collected. Defaults to **true**. + must be collected. Default is **true**. type: boolean individualDetails: description: Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) - must be collected. Defaults to **true**. + must be collected. Default is **true**. + type: boolean + legalArrangementDetails: + description: Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) + must be collected. Default is **true**. type: boolean pciQuestionnaire: - description: Indicates whether answers to a PCI questionnaire must be collected. - Defaults to **true**. + description: Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/platforms/platforms-for-partners#onboard-partner-platform) + must be collected. Applies only to partner platforms. Default is **true**. type: boolean shareholderDetails: description: Indicates whether [shareholder details](https://docs.adyen.com/platforms/verification-checks/identity-check) @@ -239,7 +247,6 @@ components: - currency - currencyCode - dateOfBirth - - description - destinationAccountCode - document - documentExpirationDate @@ -261,8 +268,6 @@ components: - houseNumberOrName - iban - idCard - - idCardBack - - idCardFront - idNumber - identityDocument - individualDetails @@ -300,13 +305,13 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber - postalCode - primaryCurrency - reason - - registrationNumber - returnUrl - schedule - shareholder @@ -320,6 +325,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -403,7 +409,7 @@ components: GetOnboardingUrlResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Information about any invalid fields. items: $ref: '#/components/schemas/ErrorFieldType' @@ -447,7 +453,7 @@ components: GetPciUrlResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Information about any invalid fields. items: $ref: '#/components/schemas/ErrorFieldType' diff --git a/yaml/HopService-v5.yaml b/yaml/HopService-v5.yaml index b4403019..c4ca3268 100644 --- a/yaml/HopService-v5.yaml +++ b/yaml/HopService-v5.yaml @@ -60,6 +60,8 @@ x-groups: paths: /getOnboardingUrl: post: + tags: + - Hosted Onboarding Page summary: Get a link to a Adyen-hosted onboarding page. description: 'Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer @@ -114,6 +116,8 @@ paths: description: Internal Server Error - the server could not process the request. /getPciQuestionnaireUrl: post: + tags: + - PCI Compliance Questionnaire Page summary: Get a link to a PCI compliance questionnaire. description: "Returns a link to a PCI compliance questionnaire that you can\ \ send to your account holder.\n > You should only use this endpoint if you\ @@ -172,19 +176,23 @@ components: properties: bankDetails: description: Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) - must be collected. Defaults to **true**. + must be collected. Default is **true**. type: boolean businessDetails: description: Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) - must be collected. Defaults to **true**. + must be collected. Default is **true**. type: boolean individualDetails: description: Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) - must be collected. Defaults to **true**. + must be collected. Default is **true**. + type: boolean + legalArrangementDetails: + description: Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) + must be collected. Default is **true**. type: boolean pciQuestionnaire: - description: Indicates whether answers to a PCI questionnaire must be collected. - Defaults to **true**. + description: Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/platforms/platforms-for-partners#onboard-partner-platform) + must be collected. Applies only to partner platforms. Default is **true**. type: boolean shareholderDetails: description: Indicates whether [shareholder details](https://docs.adyen.com/platforms/verification-checks/identity-check) @@ -300,6 +308,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -320,6 +329,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -403,7 +413,7 @@ components: GetOnboardingUrlResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Information about any invalid fields. items: $ref: '#/components/schemas/ErrorFieldType' @@ -436,7 +446,7 @@ components: GetPciUrlResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Information about any invalid fields. items: $ref: '#/components/schemas/ErrorFieldType' diff --git a/yaml/HopService-v6.yaml b/yaml/HopService-v6.yaml index 04fb99a2..2e476429 100644 --- a/yaml/HopService-v6.yaml +++ b/yaml/HopService-v6.yaml @@ -60,6 +60,8 @@ x-groups: paths: /getOnboardingUrl: post: + tags: + - Hosted Onboarding Page summary: Get a link to a Adyen-hosted onboarding page. description: 'Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer @@ -114,6 +116,8 @@ paths: description: Internal Server Error - the server could not process the request. /getPciQuestionnaireUrl: post: + tags: + - PCI Compliance Questionnaire Page summary: Get a link to a PCI compliance questionnaire. description: "Returns a link to a PCI compliance questionnaire that you can\ \ send to your account holder.\n > You should only use this endpoint if you\ @@ -172,19 +176,23 @@ components: properties: bankDetails: description: Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) - must be collected. Defaults to **true**. + must be collected. Default is **true**. type: boolean businessDetails: description: Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) - must be collected. Defaults to **true**. + must be collected. Default is **true**. type: boolean individualDetails: description: Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) - must be collected. Defaults to **true**. + must be collected. Default is **true**. + type: boolean + legalArrangementDetails: + description: Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) + must be collected. Default is **true**. type: boolean pciQuestionnaire: - description: Indicates whether answers to a PCI questionnaire must be collected. - Defaults to **true**. + description: Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/platforms/platforms-for-partners#onboard-partner-platform) + must be collected. Applies only to partner platforms. Default is **true**. type: boolean shareholderDetails: description: Indicates whether [shareholder details](https://docs.adyen.com/platforms/verification-checks/identity-check) @@ -300,6 +308,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -320,6 +329,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -403,7 +413,7 @@ components: GetOnboardingUrlResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Information about any invalid fields. items: $ref: '#/components/schemas/ErrorFieldType' @@ -436,7 +446,7 @@ components: GetPciUrlResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Information about any invalid fields. items: $ref: '#/components/schemas/ErrorFieldType' diff --git a/yaml/MarketPayNotificationService-v3.yaml b/yaml/MarketPayNotificationService-v3.yaml index a169efd2..ba81c73c 100644 --- a/yaml/MarketPayNotificationService-v3.yaml +++ b/yaml/MarketPayNotificationService-v3.yaml @@ -23,6 +23,8 @@ x-staticResponse: response.json webhooks: /ACCOUNT_CLOSED: post: + tags: + - Accounts summary: Triggered upon the closure of an account. description: This notification is sent when an account has been closed. operationId: post-ACCOUNT_CLOSED @@ -51,6 +53,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_CREATED: post: + tags: + - Accounts summary: Triggered upon the creation of an account. description: This notification is sent when an account has been created. operationId: post-ACCOUNT_CREATED @@ -73,6 +77,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_FUNDS_BELOW_THRESHOLD: post: + tags: + - Fund management summary: Triggered when a liable account current funds are below configured threshold. description: This notification is sent when a liable account's current funds @@ -97,6 +103,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_CREATED: post: + tags: + - Account holders summary: Triggered upon the creation of an account holder. description: This notification is sent when an account holder has been created. operationId: post-ACCOUNT_HOLDER_CREATED @@ -119,6 +127,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_PAYOUT: post: + tags: + - Fund management summary: Triggered upon a payout to an account holder. description: This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled. @@ -142,6 +152,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_STATUS_CHANGE: post: + tags: + - Account holders summary: Triggered upon the status change of an account holder. description: This notification is sent when the status of an account holder has been changed. @@ -165,6 +177,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_STORE_STATUS_CHANGE: post: + tags: + - Account holders summary: Triggered upon the status change of a store tied to an account holder. description: This notification is sent when the status of a store tied to an account holder has been changed. @@ -188,6 +202,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_UPCOMING_DEADLINE: post: + tags: + - Account holders summary: Triggered upon an upcoming deadline. description: This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up. @@ -211,6 +227,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_UPDATED: post: + tags: + - Account holders summary: Triggered upon the update of an account holder. description: This notification is sent when an account holder has been updated. operationId: post-ACCOUNT_HOLDER_UPDATED @@ -233,6 +251,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_VERIFICATION: post: + tags: + - Account holders summary: Triggered upon the receipt of KYC Verification results. description: This notification is sent when KYC Verification results are made available. @@ -256,6 +276,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_UPDATED: post: + tags: + - Accounts summary: Triggered upon the update of an account. description: This notification is sent when an account has been updated. operationId: post-ACCOUNT_UPDATED @@ -278,6 +300,8 @@ webhooks: description: OK - the request has succeeded. /BENEFICIARY_SETUP: post: + tags: + - Fund management summary: Triggered upon the setup of a beneficiary. description: This notification is sent when a benefactor/beneficiary relationship between accounts has been set up. @@ -301,6 +325,8 @@ webhooks: description: OK - the request has succeeded. /COMPENSATE_NEGATIVE_BALANCE: post: + tags: + - Fund management summary: Triggered upon the compensation of negative account balances. description: This notification is sent when funds have been transferred from your platform's liable account to an overdrawn account in order to compensate @@ -325,6 +351,8 @@ webhooks: description: OK - the request has succeeded. /DIRECT_DEBIT_INITIATED: post: + tags: + - Fund management summary: Triggered when an automated direct debit is initiated. description: This notification is sent when an automated direct debit is initiated from the Adyen platform. @@ -348,6 +376,8 @@ webhooks: description: OK - the request has succeeded. /PAYMENT_FAILURE: post: + tags: + - Other summary: Triggered when a booking for a capture or refund fails. description: This notification is sent when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid @@ -374,6 +404,8 @@ webhooks: description: OK - the request has succeeded. /REFUND_FUNDS_TRANSFER: post: + tags: + - Fund management summary: Triggered upon the transfer refund of funds between accounts. description: This notification is sent when the refund of funds from an account have been transferred to another account. @@ -397,6 +429,8 @@ webhooks: description: OK - the request has succeeded. /REPORT_AVAILABLE: post: + tags: + - Other summary: Triggered when a report is made available. description: This notification is sent when a report has been made available. operationId: post-REPORT_AVAILABLE @@ -419,6 +453,8 @@ webhooks: description: OK - the request has succeeded. /SCHEDULED_REFUNDS: post: + tags: + - Fund management summary: Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call. description: This notification is sent when a 'Refund Transfers Not Paid Out' @@ -443,6 +479,8 @@ webhooks: description: OK - the request has succeeded. /TRANSFER_FUNDS: post: + tags: + - Fund management summary: Triggered upon the transfer of funds between accounts. description: This notification is sent when the funds from an account have been transferred to another account. @@ -672,6 +710,9 @@ components: > 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 + principalBusinessAddress: + description: The principal business address of the account holder. + $ref: '#/components/schemas/ViasAddress' webAddress: description: The URL of the website of the account holder. type: string @@ -729,7 +770,7 @@ components: description: A description of the payout. type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The merchant reference. type: string status: @@ -798,11 +839,11 @@ components: description: The code of the account holder. type: string newStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' oldStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The former status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' reason: @@ -1030,7 +1071,7 @@ components: if payouts are allowed but limited. $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The payout tier that the account holder occupies. format: int32 type: integer @@ -1053,7 +1094,7 @@ components: into this tier). $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The processing tier that the account holder occupies. format: int32 type: integer @@ -1372,6 +1413,12 @@ components: legalBusinessName: description: The legal name of the company. type: string + listedUltimateParentCompany: + description: Information about the parent public company. Required if the + account holder is 100% owned by a publicly listed company. + items: + $ref: '#/components/schemas/UltimateParentCompany' + type: array shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about @@ -1399,7 +1446,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.' @@ -1485,11 +1532,11 @@ components: description: Details of the new account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the new account holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccountHolder` request to fail. items: @@ -1514,7 +1561,7 @@ components: may result in an error if the providing service is unavailable.' type: boolean verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -1541,7 +1588,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The status of the account. >Permitted values: `Active`.' @@ -1672,7 +1719,6 @@ components: - currency - currencyCode - dateOfBirth - - description - destinationAccountCode - document - documentExpirationDate @@ -1694,8 +1740,6 @@ components: - houseNumberOrName - iban - idCard - - idCardBack - - idCardFront - idNumber - identityDocument - individualDetails @@ -1733,13 +1777,13 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber - postalCode - primaryCurrency - reason - - registrationNumber - returnUrl - schedule - shareholder @@ -1753,6 +1797,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -2458,11 +2503,11 @@ components: description: The merchant reference of a transaction. type: string paymentPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related authorisation or transfer. type: string payoutPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related payout. type: string pspReference: @@ -2562,7 +2607,7 @@ components: description: The code of the Account to which funds were credited. type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The reference provided by the merchant. type: string sourceAccountCode: @@ -2579,6 +2624,37 @@ components: - destinationAccountCode - amount - transferCode + UltimateParentCompany: + properties: + address: + description: Address of the ultimate parent company. + $ref: '#/components/schemas/ViasAddress' + businessDetails: + description: Details about the ultimate parent company's business. + $ref: '#/components/schemas/UltimateParentCompanyBusinessDetails' + ultimateParentCompanyCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + entry, returned in the response when you create an ultimate parent company. + Required when updating an existing entry in an `/updateAccountHolder` + request. + type: string + UltimateParentCompanyBusinessDetails: + properties: + legalBusinessName: + description: The legal name of the company. + type: string + registrationNumber: + description: The registration number of the company. + type: string + stockExchange: + description: Market Identifier Code (MIC). + type: string + stockNumber: + description: International Securities Identification Number (ISIN). + type: string + stockTicker: + description: Stock Ticker symbol. + type: string UpdateAccountHolderResponse: properties: accountHolderCode: @@ -2588,11 +2664,11 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: @@ -2622,7 +2698,7 @@ components: $ref: '#/components/schemas/FieldType' type: array verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -2736,7 +2812,7 @@ components: For example, **2000-01-31**. type: string documentData: - x-addedInVersion: 3 + x-addedInVersion: '3' description: Array that contains information about the person's identification document. You can submit only one entry per document type. items: diff --git a/yaml/MarketPayNotificationService-v4.yaml b/yaml/MarketPayNotificationService-v4.yaml index 59d9a7d7..2dafcba2 100644 --- a/yaml/MarketPayNotificationService-v4.yaml +++ b/yaml/MarketPayNotificationService-v4.yaml @@ -23,6 +23,8 @@ x-staticResponse: response.json webhooks: /ACCOUNT_CLOSED: post: + tags: + - Accounts summary: Triggered upon the closure of an account. description: This notification is sent when an account has been closed. operationId: post-ACCOUNT_CLOSED @@ -51,6 +53,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_CREATED: post: + tags: + - Accounts summary: Triggered upon the creation of an account. description: This notification is sent when an account has been created. operationId: post-ACCOUNT_CREATED @@ -73,6 +77,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_FUNDS_BELOW_THRESHOLD: post: + tags: + - Fund management summary: Triggered when a liable account current funds are below configured threshold. description: This notification is sent when a liable account's current funds @@ -97,6 +103,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_CREATED: post: + tags: + - Account holders summary: Triggered upon the creation of an account holder. description: This notification is sent when an account holder has been created. operationId: post-ACCOUNT_HOLDER_CREATED @@ -119,6 +127,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_PAYOUT: post: + tags: + - Fund management summary: Triggered upon a payout to an account holder. description: This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled. @@ -142,6 +152,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_STATUS_CHANGE: post: + tags: + - Account holders summary: Triggered upon the status change of an account holder. description: This notification is sent when the status of an account holder has been changed. @@ -165,6 +177,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_STORE_STATUS_CHANGE: post: + tags: + - Account holders summary: Triggered upon the status change of a store tied to an account holder. description: This notification is sent when the status of a store tied to an account holder has been changed. @@ -188,6 +202,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_UPCOMING_DEADLINE: post: + tags: + - Account holders summary: Triggered upon an upcoming deadline. description: This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up. @@ -211,6 +227,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_UPDATED: post: + tags: + - Account holders summary: Triggered upon the update of an account holder. description: This notification is sent when an account holder has been updated. operationId: post-ACCOUNT_HOLDER_UPDATED @@ -233,6 +251,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_VERIFICATION: post: + tags: + - Account holders summary: Triggered upon the receipt of KYC Verification results. description: This notification is sent when KYC Verification results are made available. @@ -256,6 +276,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_UPDATED: post: + tags: + - Accounts summary: Triggered upon the update of an account. description: This notification is sent when an account has been updated. operationId: post-ACCOUNT_UPDATED @@ -278,6 +300,8 @@ webhooks: description: OK - the request has succeeded. /BENEFICIARY_SETUP: post: + tags: + - Fund management summary: Triggered upon the setup of a beneficiary. description: This notification is sent when a benefactor/beneficiary relationship between accounts has been set up. @@ -301,6 +325,8 @@ webhooks: description: OK - the request has succeeded. /COMPENSATE_NEGATIVE_BALANCE: post: + tags: + - Fund management summary: Triggered upon the compensation of negative account balances. description: This notification is sent when funds have been transferred from your platform's liable account to an overdrawn account in order to compensate @@ -325,6 +351,8 @@ webhooks: description: OK - the request has succeeded. /DIRECT_DEBIT_INITIATED: post: + tags: + - Fund management summary: Triggered when an automated direct debit is initiated. description: This notification is sent when an automated direct debit is initiated from the Adyen platform. @@ -348,6 +376,8 @@ webhooks: description: OK - the request has succeeded. /PAYMENT_FAILURE: post: + tags: + - Other summary: Triggered when a booking for a capture or refund fails. description: This notification is sent when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid @@ -374,6 +404,8 @@ webhooks: description: OK - the request has succeeded. /REFUND_FUNDS_TRANSFER: post: + tags: + - Fund management summary: Triggered upon the transfer refund of funds between accounts. description: This notification is sent when the refund of funds from an account have been transferred to another account. @@ -397,6 +429,8 @@ webhooks: description: OK - the request has succeeded. /REPORT_AVAILABLE: post: + tags: + - Other summary: Triggered when a report is made available. description: This notification is sent when a report has been made available. operationId: post-REPORT_AVAILABLE @@ -419,6 +453,8 @@ webhooks: description: OK - the request has succeeded. /SCHEDULED_REFUNDS: post: + tags: + - Fund management summary: Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call. description: This notification is sent when a 'Refund Transfers Not Paid Out' @@ -443,6 +479,8 @@ webhooks: description: OK - the request has succeeded. /TRANSFER_FUNDS: post: + tags: + - Fund management summary: Triggered upon the transfer of funds between accounts. description: This notification is sent when the funds from an account have been transferred to another account. @@ -472,7 +510,7 @@ components: description: The details of the Account update. $ref: '#/components/schemas/CloseAccountResponse' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -505,7 +543,7 @@ components: description: The details of the account creation. $ref: '#/components/schemas/CreateAccountResponse' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -561,7 +599,7 @@ components: description: Details of the liable account with funds under threshold. $ref: '#/components/schemas/AccountFundsBelowThresholdNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -614,7 +652,7 @@ components: description: The details of the account holder creation. $ref: '#/components/schemas/CreateAccountHolderResponse' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -696,6 +734,9 @@ components: > 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 + principalBusinessAddress: + description: The principal business address of the account holder. + $ref: '#/components/schemas/ViasAddress' webAddress: description: The URL of the website of the account holder. type: string @@ -709,7 +750,7 @@ components: description: Details of the payout to the Account Holder. $ref: '#/components/schemas/AccountHolderPayoutNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -759,7 +800,7 @@ components: description: A description of the payout. type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The merchant reference. type: string status: @@ -802,7 +843,7 @@ components: description: The details of the Account Holder status change. $ref: '#/components/schemas/AccountHolderStatusChangeNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -834,11 +875,11 @@ components: description: The code of the account holder. type: string newStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' oldStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The former status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' reason: @@ -854,7 +895,7 @@ components: description: The details of the Account Holder Store status change. $ref: '#/components/schemas/AccountHolderStoreStatusChangeNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -887,7 +928,7 @@ components: description: The details of the upcoming event. $ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -955,7 +996,7 @@ components: description: The details of the Account Holder update. $ref: '#/components/schemas/UpdateAccountHolderResponse' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -988,7 +1029,7 @@ components: description: The details of the Account Holder verification. $ref: '#/components/schemas/AccountHolderVerificationNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1030,7 +1071,7 @@ components: description: The code of the signatory that has been verified. type: string statusSummary: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A summary of the verification status. $ref: '#/components/schemas/KYCCheckSummary' verificationStatus: @@ -1088,7 +1129,7 @@ components: if payouts are allowed but limited. $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The payout tier that the account holder occupies. format: int32 type: integer @@ -1111,7 +1152,7 @@ components: into this tier). $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The processing tier that the account holder occupies. format: int32 type: integer @@ -1121,7 +1162,7 @@ components: description: The details of the Account update. $ref: '#/components/schemas/UpdateAccountResponse' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1372,7 +1413,7 @@ components: description: Details of the beneficiary setup. $ref: '#/components/schemas/BeneficiarySetupNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1442,8 +1483,14 @@ components: legalBusinessName: description: The legal name of the company. type: string + listedUltimateParentCompany: + description: Information about the parent public company. Required if the + account holder is 100% owned by a publicly listed company. + items: + $ref: '#/components/schemas/UltimateParentCompany' + type: array registrationNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The registration number of the company. type: string shareholders: @@ -1473,7 +1520,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.' @@ -1502,7 +1549,7 @@ components: description: Details of the negative balance compensation. $ref: '#/components/schemas/CompensateNegativeBalanceNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1565,29 +1612,27 @@ components: description: Details of the new account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the new account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the new account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccountHolder` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The type of legal entity of the new account holder. enum: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string pspReference: description: The reference of a request. Can be used to uniquely identify @@ -1608,7 +1653,7 @@ components: may result in an error if the providing service is unavailable.' type: boolean verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -1626,7 +1671,7 @@ components: description: The code of the account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string payoutSchedule: @@ -1640,7 +1685,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The status of the account. >Permitted values: `Active`.' @@ -1671,7 +1716,7 @@ components: description: Details of the direct debit. $ref: '#/components/schemas/DirectDebitInitiatedNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1838,6 +1883,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -1858,6 +1904,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -2061,7 +2108,7 @@ components: description: The details of the payment failure. $ref: '#/components/schemas/PaymentFailureNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2184,7 +2231,7 @@ components: description: Details of the fund transfer refund. $ref: '#/components/schemas/RefundFundsTransferNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2250,7 +2297,7 @@ components: description: Details of the report. $ref: '#/components/schemas/ReportAvailableNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2301,7 +2348,7 @@ components: description: Details of the scheduling of the refunds. $ref: '#/components/schemas/ScheduledRefundsNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2578,11 +2625,11 @@ components: description: The merchant reference of a transaction. type: string paymentPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related authorisation or transfer. type: string payoutPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related payout. type: string pspReference: @@ -2652,7 +2699,7 @@ components: description: Details of the fund transfer. $ref: '#/components/schemas/TransferFundsNotificationContent' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2688,7 +2735,7 @@ components: description: The code of the Account to which funds were credited. type: string merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The reference provided by the merchant. type: string sourceAccountCode: @@ -2705,6 +2752,37 @@ components: - destinationAccountCode - amount - transferCode + UltimateParentCompany: + properties: + address: + description: Address of the ultimate parent company. + $ref: '#/components/schemas/ViasAddress' + businessDetails: + description: Details about the ultimate parent company's business. + $ref: '#/components/schemas/UltimateParentCompanyBusinessDetails' + ultimateParentCompanyCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + entry, returned in the response when you create an ultimate parent company. + Required when updating an existing entry in an `/updateAccountHolder` + request. + type: string + UltimateParentCompanyBusinessDetails: + properties: + legalBusinessName: + description: The legal name of the company. + type: string + registrationNumber: + description: The registration number of the company. + type: string + stockExchange: + description: Market Identifier Code (MIC). + type: string + stockNumber: + description: International Securities Identification Number (ISIN). + type: string + stockTicker: + description: Stock Ticker symbol. + type: string UpdateAccountHolderResponse: properties: accountHolderCode: @@ -2714,29 +2792,27 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The legal entity of the account holder. enum: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string pspReference: description: The reference of a request. Can be used to uniquely identify @@ -2762,7 +2838,7 @@ components: $ref: '#/components/schemas/FieldType' type: array verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -2775,7 +2851,7 @@ components: description: The code of the account. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string payoutSchedule: @@ -2881,7 +2957,7 @@ components: For example, **2000-01-31**. type: string documentData: - x-addedInVersion: 3 + x-addedInVersion: '3' description: Array that contains information about the person's identification document. You can submit only one entry per document type. items: diff --git a/yaml/MarketPayNotificationService-v5.yaml b/yaml/MarketPayNotificationService-v5.yaml index 594f0d69..2714111e 100644 --- a/yaml/MarketPayNotificationService-v5.yaml +++ b/yaml/MarketPayNotificationService-v5.yaml @@ -23,6 +23,8 @@ x-staticResponse: response.json webhooks: /ACCOUNT_CLOSED: post: + tags: + - Accounts summary: Triggered upon the closure of an account. description: This notification is sent when an account has been closed. operationId: post-ACCOUNT_CLOSED @@ -51,6 +53,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_CREATED: post: + tags: + - Accounts summary: Triggered upon the creation of an account. description: This notification is sent when an account has been created. operationId: post-ACCOUNT_CREATED @@ -73,6 +77,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_FUNDS_BELOW_THRESHOLD: post: + tags: + - Fund management summary: Triggered when a liable account current funds are below configured threshold. description: This notification is sent when a liable account's current funds @@ -97,6 +103,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_CREATED: post: + tags: + - Account holders summary: Triggered upon the creation of an account holder. description: This notification is sent when an account holder has been created. operationId: post-ACCOUNT_HOLDER_CREATED @@ -119,6 +127,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_PAYOUT: post: + tags: + - Fund management summary: Triggered upon a payout to an account holder. description: This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled. @@ -142,6 +152,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_STATUS_CHANGE: post: + tags: + - Account holders summary: Triggered upon the status change of an account holder. description: This notification is sent when the status of an account holder has been changed. @@ -165,6 +177,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_STORE_STATUS_CHANGE: post: + tags: + - Account holders summary: Triggered upon the status change of a store tied to an account holder. description: This notification is sent when the status of a store tied to an account holder has been changed. @@ -188,6 +202,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_UPCOMING_DEADLINE: post: + tags: + - Account holders summary: Triggered upon an upcoming deadline. description: This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up. @@ -211,6 +227,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_UPDATED: post: + tags: + - Account holders summary: Triggered upon the update of an account holder. description: This notification is sent when an account holder has been updated. operationId: post-ACCOUNT_HOLDER_UPDATED @@ -233,6 +251,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_VERIFICATION: post: + tags: + - Account holders summary: Triggered upon the receipt of KYC Verification results. description: This notification is sent when KYC Verification results are made available. @@ -256,6 +276,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_UPDATED: post: + tags: + - Accounts summary: Triggered upon the update of an account. description: This notification is sent when an account has been updated. operationId: post-ACCOUNT_UPDATED @@ -278,6 +300,8 @@ webhooks: description: OK - the request has succeeded. /BENEFICIARY_SETUP: post: + tags: + - Fund management summary: Triggered upon the setup of a beneficiary. description: This notification is sent when a benefactor/beneficiary relationship between accounts has been set up. @@ -301,6 +325,8 @@ webhooks: description: OK - the request has succeeded. /COMPENSATE_NEGATIVE_BALANCE: post: + tags: + - Fund management summary: Triggered upon the compensation of negative account balances. description: This notification is sent when funds have been transferred from your platform's liable account to an overdrawn account in order to compensate @@ -325,6 +351,8 @@ webhooks: description: OK - the request has succeeded. /DIRECT_DEBIT_INITIATED: post: + tags: + - Fund management summary: Triggered when an automated direct debit is initiated. description: This notification is sent when an automated direct debit is initiated from the Adyen platform. @@ -348,6 +376,8 @@ webhooks: description: OK - the request has succeeded. /PAYMENT_FAILURE: post: + tags: + - Other summary: Triggered when a booking for a capture or refund fails. description: This notification is sent when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid @@ -374,6 +404,8 @@ webhooks: description: OK - the request has succeeded. /REFUND_FUNDS_TRANSFER: post: + tags: + - Fund management summary: Triggered upon the transfer refund of funds between accounts. description: This notification is sent when the refund of funds from an account have been transferred to another account. @@ -397,6 +429,8 @@ webhooks: description: OK - the request has succeeded. /REPORT_AVAILABLE: post: + tags: + - Other summary: Triggered when a report is made available. description: This notification is sent when a report has been made available. operationId: post-REPORT_AVAILABLE @@ -419,6 +453,8 @@ webhooks: description: OK - the request has succeeded. /SCHEDULED_REFUNDS: post: + tags: + - Fund management summary: Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call. description: This notification is sent when a 'Refund Transfers Not Paid Out' @@ -443,6 +479,8 @@ webhooks: description: OK - the request has succeeded. /TRANSFER_FUNDS: post: + tags: + - Fund management summary: Triggered upon the transfer of funds between accounts. description: This notification is sent when the funds from an account have been transferred to another account. @@ -472,12 +510,12 @@ components: description: The details of the Account update. $ref: '#/components/schemas/CloseAccountResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -510,12 +548,12 @@ components: description: The details of the account creation. $ref: '#/components/schemas/CreateAccountResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -571,12 +609,12 @@ components: description: Details of the liable account with funds under threshold. $ref: '#/components/schemas/AccountFundsBelowThresholdNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -629,12 +667,12 @@ components: description: The details of the account holder creation. $ref: '#/components/schemas/CreateAccountHolderResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -674,7 +712,7 @@ components: $ref: '#/components/schemas/BankAccountDetail' type: array bankAggregatorDataReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The opaque reference value returned by the Adyen API during bank account login. type: string @@ -722,15 +760,18 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethods: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards). items: $ref: '#/components/schemas/PayoutMethod' type: array + principalBusinessAddress: + description: The principal business address of the account holder. + $ref: '#/components/schemas/ViasAddress' storeDetails: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos). items: @@ -749,12 +790,12 @@ components: description: Details of the payout to the Account Holder. $ref: '#/components/schemas/AccountHolderPayoutNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -804,25 +845,25 @@ components: description: A description of the payout. type: string estimatedArrivalDate: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The estimated date of arrival. $ref: '#/components/schemas/LocalDate' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Invalid fields list. items: $ref: '#/components/schemas/ErrorFieldType' type: array merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The merchant reference. type: string originalPspReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The PSP reference of the original payout. type: string payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -870,12 +911,12 @@ components: description: The details of the Account Holder status change. $ref: '#/components/schemas/AccountHolderStatusChangeNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -907,18 +948,18 @@ components: description: The code of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array newStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' oldStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The former status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' reason: @@ -934,12 +975,12 @@ components: description: The details of the Account Holder Store status change. $ref: '#/components/schemas/AccountHolderStoreStatusChangeNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -968,18 +1009,18 @@ components: AccountHolderStoreStatusChangeNotificationContent: properties: accountHolderCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The code of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: In case the store status has not been updated, contains fields that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array newStatus: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The new status of the account holder. enum: - Active @@ -989,7 +1030,7 @@ components: - Pending type: string oldStatus: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The former status of the account holder. enum: - Active @@ -999,15 +1040,15 @@ components: - Pending type: string reason: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The reason for the status change. type: string store: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Alphanumeric identifier of the store. type: string storeReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Store store reference. type: string required: @@ -1022,12 +1063,12 @@ components: description: The details of the upcoming event. $ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1095,12 +1136,12 @@ components: description: The details of the Account Holder update. $ref: '#/components/schemas/UpdateAccountHolderResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1133,12 +1174,12 @@ components: description: The details of the Account Holder verification. $ref: '#/components/schemas/AccountHolderVerificationNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1174,7 +1215,7 @@ components: description: The unique ID of the bank account that has been verified. type: string kycCheckStatusData: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Information on the verification status $ref: '#/components/schemas/KYCCheckStatusData' shareholderCode: @@ -1208,7 +1249,7 @@ components: depending on other factors. type: boolean notAllowedReason: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not @@ -1219,7 +1260,7 @@ components: if payouts are allowed but limited. $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The payout tier that the account holder occupies. format: int32 type: integer @@ -1242,7 +1283,7 @@ components: into this tier). $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The processing tier that the account holder occupies. format: int32 type: integer @@ -1252,12 +1293,12 @@ components: description: The details of the Account update. $ref: '#/components/schemas/UpdateAccountResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1321,7 +1362,7 @@ components: description: The name of the bank account. type: string bankAccountReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Merchant reference to the bank account. type: string bankAccountUUID: @@ -1512,12 +1553,12 @@ components: description: Details of the beneficiary setup. $ref: '#/components/schemas/BeneficiarySetupNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1553,7 +1594,7 @@ components: description: The code of the beneficiary Account Holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A listing of the invalid fields which have caused the Setup Beneficiary request to fail. If this is empty, the Setup Beneficiary request has succeeded. @@ -1589,8 +1630,14 @@ components: legalBusinessName: description: The legal name of the company. type: string + listedUltimateParentCompany: + description: Information about the parent public company. Required if the + account holder is 100% owned by a publicly listed company. + items: + $ref: '#/components/schemas/UltimateParentCompany' + type: array registrationNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The registration number of the company. type: string shareholders: @@ -1613,11 +1660,11 @@ components: CloseAccountResponse: properties: accountCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The account code of the account that is closed. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1631,7 +1678,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.' @@ -1649,12 +1696,12 @@ components: description: Details of the negative balance compensation. $ref: '#/components/schemas/CompensateNegativeBalanceNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1717,32 +1764,30 @@ components: description: Details of the new account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the new account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the new account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccountHolder` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The type of legal entity of the new account holder. enum: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string primaryCurrency: - x-addedInVersion: 5 + x-addedInVersion: '5' 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 @@ -1754,7 +1799,7 @@ components: description: The result code. type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -1772,7 +1817,7 @@ components: description: The code of the account holder. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -1780,24 +1825,24 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccount` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: A set of key and value pairs containing metadata. type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -1806,7 +1851,7 @@ components: description: The payout schedule of the account. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -1822,7 +1867,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The status of the account. >Permitted values: `Active`.' @@ -1842,12 +1887,12 @@ components: description: Details of the direct debit. $ref: '#/components/schemas/DirectDebitInitiatedNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2014,6 +2059,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -2034,6 +2080,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -2163,13 +2210,13 @@ components: KYCCheckSummary: properties: kycCheckCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes). format: int32 type: integer kycCheckDescription: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A description of the check. type: string KYCShareholderCheckResult: @@ -2203,7 +2250,7 @@ components: $ref: '#/components/schemas/KYCBankAccountCheckResult' type: array cards: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The results of the checks on the cards. items: $ref: '#/components/schemas/KYCCardCheckResult' @@ -2262,12 +2309,12 @@ components: description: The details of the payment failure. $ref: '#/components/schemas/PaymentFailureNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2408,12 +2455,12 @@ components: description: Details of the fund transfer refund. $ref: '#/components/schemas/RefundFundsTransferNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2446,7 +2493,7 @@ components: description: The amount to be refunded. $ref: '#/components/schemas/Amount' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Invalid fields list. items: $ref: '#/components/schemas/ErrorFieldType' @@ -2485,12 +2532,12 @@ components: description: Details of the report. $ref: '#/components/schemas/ReportAvailableNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2541,12 +2588,12 @@ components: description: Details of the scheduling of the refunds. $ref: '#/components/schemas/ScheduledRefundsNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2582,7 +2629,7 @@ components: description: The code of the Account Holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Invalid fields list. items: $ref: '#/components/schemas/ErrorFieldType' @@ -2658,7 +2705,7 @@ components: ' type: string shareholderReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Your reference for the shareholder entry. type: string shareholderType: @@ -2823,14 +2870,14 @@ components: readOnly: true $ref: '#/components/schemas/ViasPhoneNumber' shopperInteraction: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'The sales channel. Possible values: **Ecommerce**, **POS**.' enum: - Ecommerce - POS type: string splitConfigurationUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and @@ -2865,12 +2912,12 @@ components: This value will be shown as the store description in your Customer Area.' type: string virtualAccount: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`. type: string webAddress: - x-addedInVersion: 5 + x-addedInVersion: '5' description: URL of the ecommerce store. type: string required: @@ -2913,11 +2960,11 @@ components: description: The merchant reference of a transaction. type: string paymentPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related authorisation or transfer. type: string payoutPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related payout. type: string pspReference: @@ -2987,12 +3034,12 @@ components: description: Details of the fund transfer. $ref: '#/components/schemas/TransferFundsNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -3028,13 +3075,13 @@ components: description: The code of the Account to which funds were credited. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Invalid fields list. items: $ref: '#/components/schemas/ErrorFieldType' type: array merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The reference provided by the merchant. type: string sourceAccountCode: @@ -3051,6 +3098,37 @@ components: - destinationAccountCode - amount - transferCode + UltimateParentCompany: + properties: + address: + description: Address of the ultimate parent company. + $ref: '#/components/schemas/ViasAddress' + businessDetails: + description: Details about the ultimate parent company's business. + $ref: '#/components/schemas/UltimateParentCompanyBusinessDetails' + ultimateParentCompanyCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + entry, returned in the response when you create an ultimate parent company. + Required when updating an existing entry in an `/updateAccountHolder` + request. + type: string + UltimateParentCompanyBusinessDetails: + properties: + legalBusinessName: + description: The legal name of the company. + type: string + registrationNumber: + description: The registration number of the company. + type: string + stockExchange: + description: Market Identifier Code (MIC). + type: string + stockNumber: + description: International Securities Identification Number (ISIN). + type: string + stockTicker: + description: Stock Ticker symbol. + type: string UpdateAccountHolderResponse: properties: accountHolderCode: @@ -3060,32 +3138,30 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The legal entity of the account holder. enum: - Business - Individual - NonProfit - - Partnership - - PublicCompany type: string primaryCurrency: - x-addedInVersion: 5 + x-addedInVersion: '5' 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 @@ -3097,7 +3173,7 @@ components: description: The result code. type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' required: @@ -3110,7 +3186,7 @@ components: description: The code of the account. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -3118,24 +3194,24 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/updateAccount` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: A set of key and value pairs containing metadata. type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -3144,7 +3220,7 @@ components: description: The payout schedule of the account. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -3241,7 +3317,7 @@ components: For example, **2000-01-31**. type: string documentData: - x-addedInVersion: 3 + x-addedInVersion: '3' description: Array that contains information about the person's identification document. You can submit only one entry per document type. items: diff --git a/yaml/MarketPayNotificationService-v6.yaml b/yaml/MarketPayNotificationService-v6.yaml index 19b69e77..b8530fff 100644 --- a/yaml/MarketPayNotificationService-v6.yaml +++ b/yaml/MarketPayNotificationService-v6.yaml @@ -23,6 +23,8 @@ x-staticResponse: response.json webhooks: /ACCOUNT_CLOSED: post: + tags: + - Accounts summary: Triggered upon the closure of an account. description: This notification is sent when an account has been closed. operationId: post-ACCOUNT_CLOSED @@ -51,6 +53,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_CREATED: post: + tags: + - Accounts summary: Triggered upon the creation of an account. description: This notification is sent when an account has been created. operationId: post-ACCOUNT_CREATED @@ -73,6 +77,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_FUNDS_BELOW_THRESHOLD: post: + tags: + - Fund management summary: Triggered when a liable account current funds are below configured threshold. description: This notification is sent when a liable account's current funds @@ -97,6 +103,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_CREATED: post: + tags: + - Account holders summary: Triggered upon the creation of an account holder. description: This notification is sent when an account holder has been created. operationId: post-ACCOUNT_HOLDER_CREATED @@ -119,6 +127,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_PAYOUT: post: + tags: + - Fund management summary: Triggered upon a payout to an account holder. description: This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled. @@ -142,6 +152,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_STATUS_CHANGE: post: + tags: + - Account holders summary: Triggered upon the status change of an account holder. description: This notification is sent when the status of an account holder has been changed. @@ -165,6 +177,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_STORE_STATUS_CHANGE: post: + tags: + - Account holders summary: Triggered upon the status change of a store tied to an account holder. description: This notification is sent when the status of a store tied to an account holder has been changed. @@ -188,6 +202,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_UPCOMING_DEADLINE: post: + tags: + - Account holders summary: Triggered upon an upcoming deadline. description: This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up. @@ -211,6 +227,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_UPDATED: post: + tags: + - Account holders summary: Triggered upon the update of an account holder. description: This notification is sent when an account holder has been updated. operationId: post-ACCOUNT_HOLDER_UPDATED @@ -233,6 +251,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_HOLDER_VERIFICATION: post: + tags: + - Account holders summary: Triggered upon the receipt of KYC Verification results. description: This notification is sent when KYC Verification results are made available. @@ -256,6 +276,8 @@ webhooks: description: OK - the request has succeeded. /ACCOUNT_UPDATED: post: + tags: + - Accounts summary: Triggered upon the update of an account. description: This notification is sent when an account has been updated. operationId: post-ACCOUNT_UPDATED @@ -278,6 +300,8 @@ webhooks: description: OK - the request has succeeded. /BENEFICIARY_SETUP: post: + tags: + - Fund management summary: Triggered upon the setup of a beneficiary. description: This notification is sent when a benefactor/beneficiary relationship between accounts has been set up. @@ -301,6 +325,8 @@ webhooks: description: OK - the request has succeeded. /COMPENSATE_NEGATIVE_BALANCE: post: + tags: + - Fund management summary: Triggered upon the compensation of negative account balances. description: This notification is sent when funds have been transferred from your platform's liable account to an overdrawn account in order to compensate @@ -325,6 +351,8 @@ webhooks: description: OK - the request has succeeded. /DIRECT_DEBIT_INITIATED: post: + tags: + - Fund management summary: Triggered when an automated direct debit is initiated. description: This notification is sent when an automated direct debit is initiated from the Adyen platform. @@ -348,6 +376,8 @@ webhooks: description: OK - the request has succeeded. /PAYMENT_FAILURE: post: + tags: + - Other summary: Triggered when a booking for a capture or refund fails. description: This notification is sent when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid @@ -374,6 +404,8 @@ webhooks: description: OK - the request has succeeded. /REFUND_FUNDS_TRANSFER: post: + tags: + - Fund management summary: Triggered upon the transfer refund of funds between accounts. description: This notification is sent when the refund of funds from an account have been transferred to another account. @@ -397,6 +429,8 @@ webhooks: description: OK - the request has succeeded. /REPORT_AVAILABLE: post: + tags: + - Other summary: Triggered when a report is made available. description: This notification is sent when a report has been made available. operationId: post-REPORT_AVAILABLE @@ -419,6 +453,8 @@ webhooks: description: OK - the request has succeeded. /SCHEDULED_REFUNDS: post: + tags: + - Fund management summary: Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call. description: This notification is sent when a 'Refund Transfers Not Paid Out' @@ -443,6 +479,8 @@ webhooks: description: OK - the request has succeeded. /TRANSFER_FUNDS: post: + tags: + - Fund management summary: Triggered upon the transfer of funds between accounts. description: This notification is sent when the funds from an account have been transferred to another account. @@ -472,12 +510,12 @@ components: description: The details of the Account update. $ref: '#/components/schemas/CloseAccountResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -510,12 +548,12 @@ components: description: The details of the account creation. $ref: '#/components/schemas/CreateAccountResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -571,12 +609,12 @@ components: description: Details of the liable account with funds under threshold. $ref: '#/components/schemas/AccountFundsBelowThresholdNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -629,12 +667,12 @@ components: description: The details of the account holder creation. $ref: '#/components/schemas/CreateAccountHolderResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -674,7 +712,7 @@ components: $ref: '#/components/schemas/BankAccountDetail' type: array bankAggregatorDataReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The opaque reference value returned by the Adyen API during bank account login. type: string @@ -701,10 +739,9 @@ components: ' $ref: '#/components/schemas/IndividualDetails' legalArrangements: - x-addedInVersion: 6 - description: Array that contains information about legal arrangements, used - when the account holder is acting on behalf of different parties or is - part of a contractual business agreement. + x-addedInVersion: '6' + description: An array containing information about the account holder's + [legal arrangements](https://docs.adyen.com/platforms/verification-checks/legal-arrangements). items: $ref: '#/components/schemas/LegalArrangementDetail' type: array @@ -730,7 +767,7 @@ components: pairs will result in the deletion of those key-value pairs.' type: object payoutMethods: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards). @@ -738,11 +775,10 @@ components: $ref: '#/components/schemas/PayoutMethod' type: array principalBusinessAddress: - x-addedInVersion: 6 - description: The prinicipal business address of the account holder. + description: The principal business address of the account holder. $ref: '#/components/schemas/ViasAddress' storeDetails: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos). items: @@ -761,12 +797,12 @@ components: description: Details of the payout to the Account Holder. $ref: '#/components/schemas/AccountHolderPayoutNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -813,46 +849,46 @@ components: description: A description of the payout. type: string estimatedArrivalDate: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The estimated date of arrival. $ref: '#/components/schemas/LocalDate' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Invalid fields list. items: $ref: '#/components/schemas/ErrorFieldType' type: array merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The merchant reference. type: string originalPspReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The PSP reference of the original payout. type: string payoutAccountCountry: - x-addedInVersion: 6 + x-addedInVersion: '6' description: Payout account country. type: string payoutAccountNumber: - x-addedInVersion: 6 + x-addedInVersion: '6' description: Payout bank account number. type: string payoutBankName: - x-addedInVersion: 6 + x-addedInVersion: '6' description: Payout bank name. type: string payoutBranchCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: Payout branch code. type: string payoutReference: - x-addedInVersion: 6 + x-addedInVersion: '6' description: Payout transaction id. format: int64 type: integer payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -900,12 +936,12 @@ components: description: The details of the Account Holder status change. $ref: '#/components/schemas/AccountHolderStatusChangeNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -937,18 +973,18 @@ components: description: The code of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array newStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' oldStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The former status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' reason: @@ -964,12 +1000,12 @@ components: description: The details of the Account Holder Store status change. $ref: '#/components/schemas/AccountHolderStoreStatusChangeNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -998,18 +1034,18 @@ components: AccountHolderStoreStatusChangeNotificationContent: properties: accountHolderCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The code of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: In case the store status has not been updated, contains fields that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array newStatus: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The new status of the account holder. enum: - Active @@ -1019,7 +1055,7 @@ components: - Pending type: string oldStatus: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The former status of the account holder. enum: - Active @@ -1029,15 +1065,15 @@ components: - Pending type: string reason: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The reason for the status change. type: string store: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Alphanumeric identifier of the store. type: string storeReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Store store reference. type: string required: @@ -1052,12 +1088,12 @@ components: description: The details of the upcoming event. $ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1125,12 +1161,12 @@ components: description: The details of the Account Holder update. $ref: '#/components/schemas/UpdateAccountHolderResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1163,12 +1199,12 @@ components: description: The details of the Account Holder verification. $ref: '#/components/schemas/AccountHolderVerificationNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1201,20 +1237,20 @@ components: description: The code of the account holder. type: string kycCheckStatusData: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Information on the verification status $ref: '#/components/schemas/KYCCheckStatusData' legalArrangementCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The unique ID of the legal arrangement that has been verified. type: string legalArrangementEntityCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The unique ID of the legal arrangement entity that has been verified. type: string payoutMethodCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The unique code of the payout method that has been verified. type: string shareholderCode: @@ -1248,7 +1284,7 @@ components: depending on other factors. type: boolean notAllowedReason: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not @@ -1259,7 +1295,7 @@ components: if payouts are allowed but limited. $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The payout tier that the account holder occupies. format: int32 type: integer @@ -1282,7 +1318,7 @@ components: into this tier). $ref: '#/components/schemas/Amount' tierNumber: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The processing tier that the account holder occupies. format: int32 type: integer @@ -1292,12 +1328,12 @@ components: description: The details of the Account update. $ref: '#/components/schemas/UpdateAccountResponse' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1361,7 +1397,7 @@ components: description: The name of the bank account. type: string bankAccountReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Merchant reference to the bank account. type: string bankAccountUUID: @@ -1552,12 +1588,12 @@ components: description: Details of the beneficiary setup. $ref: '#/components/schemas/BeneficiarySetupNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1593,7 +1629,7 @@ components: description: The code of the beneficiary Account Holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A listing of the invalid fields which have caused the Setup Beneficiary request to fail. If this is empty, the Setup Beneficiary request has succeeded. @@ -1630,14 +1666,13 @@ components: description: The legal name of the company. type: string listedUltimateParentCompany: - x-addedInVersion: 6 description: Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company. items: $ref: '#/components/schemas/UltimateParentCompany' type: array registrationNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The registration number of the company. type: string shareholders: @@ -1655,15 +1690,15 @@ components: $ref: '#/components/schemas/SignatoryContact' type: array stockExchange: - x-addedInVersion: 6 + x-addedInVersion: '6' description: Market Identifier Code (MIC). type: string stockNumber: - x-addedInVersion: 6 + x-addedInVersion: '6' description: International Securities Identification Number (ISIN). type: string stockTicker: - x-addedInVersion: 6 + x-addedInVersion: '6' description: Stock Ticker symbol. type: string taxId: @@ -1672,11 +1707,11 @@ components: CloseAccountResponse: properties: accountCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The account code of the account that is closed. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -1690,7 +1725,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.' @@ -1708,12 +1743,12 @@ components: description: Details of the negative balance compensation. $ref: '#/components/schemas/CompensateNegativeBalanceNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -1776,22 +1811,22 @@ components: description: Details of the new account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The status of the new account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the new account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccountHolder` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The type of legal entity of the new account holder. enum: - Business @@ -1801,7 +1836,7 @@ components: - PublicCompany type: string primaryCurrency: - x-addedInVersion: 5 + x-addedInVersion: '5' 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 @@ -1813,11 +1848,11 @@ components: description: The result code. type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' verificationProfile: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The identifier of the profile that applies to this entity. type: string required: @@ -1835,7 +1870,7 @@ components: description: The code of the account holder. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -1843,24 +1878,24 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/createAccount` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: A set of key and value pairs containing metadata. type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -1869,7 +1904,7 @@ components: description: The payout schedule of the account. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -1885,7 +1920,7 @@ components: description: The result code. type: string status: - x-addedInVersion: 2 + x-addedInVersion: '2' description: 'The status of the account. >Permitted values: `Active`.' @@ -1905,12 +1940,12 @@ components: description: Details of the direct debit. $ref: '#/components/schemas/DirectDebitInitiatedNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2077,6 +2112,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -2097,6 +2133,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -2206,13 +2243,13 @@ components: KYCCheckSummary: properties: kycCheckCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes). format: int32 type: integer kycCheckDescription: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A description of the check. type: string KYCLegalArrangementCheckResult: @@ -2258,12 +2295,12 @@ components: $ref: '#/components/schemas/KYCCheckStatusData' type: array legalArrangementCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The unique ID of the legal arrangement to which the shareholder belongs, if applicable. type: string legalArrangementEntityCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The unique ID of the legal arrangement entity to which the shareholder belongs, if applicable. type: string @@ -2288,7 +2325,7 @@ components: $ref: '#/components/schemas/KYCCheckStatusData' type: array ultimateParentCompanyCode: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The code of the Ultimate Parent Company to which the check applies. type: string @@ -2298,19 +2335,19 @@ components: description: The results of the checks on the account holder. $ref: '#/components/schemas/KYCCheckResult2' legalArrangements: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The results of the checks on the legal arrangements. items: $ref: '#/components/schemas/KYCLegalArrangementCheckResult' type: array legalArrangementsEntities: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The results of the checks on the legal arrangement entities. items: $ref: '#/components/schemas/KYCLegalArrangementEntityCheckResult' type: array payoutMethods: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The results of the checks on the payout methods. items: $ref: '#/components/schemas/KYCPayoutMethodCheckResult' @@ -2326,7 +2363,7 @@ components: $ref: '#/components/schemas/KYCSignatoryCheckResult' type: array ultimateParentCompany: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The result of the check on the Ultimate Parent Company. items: $ref: '#/components/schemas/KYCUltimateParentCompanyCheckResult' @@ -2334,7 +2371,7 @@ components: LegalArrangementDetail: properties: address: - description: The address of the legal arrangement member. + description: The address of the legal arrangement. $ref: '#/components/schemas/ViasAddress' legalArrangementCode: description: Adyen-generated unique alphanumeric identifier (UUID) for the @@ -2343,8 +2380,8 @@ components: request. type: string legalArrangementEntities: - description: Array that contains information about the entities or members - that are part of the legal arrangement. + description: An array containing information about other entities that are + part of the legal arrangement. items: $ref: '#/components/schemas/LegalArrangementEntityDetail' type: array @@ -2353,14 +2390,22 @@ components: to 128 characters. type: string legalForm: - description: "The structure of the legal arrangement as defined according\ - \ to legislations in the country.\n\n Possible values: **CashManagementTrust**,\ - \ **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**,\ - \ **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**,\ - \ **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**,\ - \ **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**,\ - \ **PublicTradingTrust**, **UnlistedPublicUnitTrust**, **LimitedPartnership**,\ - \ **FamilyPartnership**, **OtherPartnership**." + description: 'The form of legal arrangement. Required if `type` is **Trust** + or **Partnership**. + + + The possible values depend on the `type`. + + + - For `type` **Trust**: **CashManagementTrust**, **CorporateUnitTrust**, + **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, + **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, + **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, + **PooledSuperannuationTrust**, **PublicTradingTrust**, or **UnlistedPublicUnitTrust**. + + + - For `type` **Partnership**: **LimitedPartnership**, **FamilyPartnership**, + or **OtherPartnership**' enum: - CashManagementTrust - CorporateUnitTrust @@ -2382,7 +2427,8 @@ components: - OtherPartnership type: string name: - description: The legal name of the legal arrangement. + description: 'The legal name of the legal arrangement. Minimum length: 3 + characters.' type: string registrationNumber: description: The registration number of the legal arrangement. @@ -2391,22 +2437,19 @@ components: description: The tax identification number of the legal arrangement. type: string type: - description: 'The type of legal arrangement. - - - Possible values: - - - - **Trust** - A legal agreement where the account holder is a trustee - that manages assets for beneficiaries. - - - **Partnership** - A legal arrangement where the account holder is a - partner that has an agreement with one or more partners to manage, operate - and share profits of their jointly-owned business.' + description: "The [type of legal arrangement](https://docs.adyen.com/platforms/verification-checks/legal-arrangements#types-of-legal-arrangements).\n\ + \nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship**\ + \ \n\n- **Trust** \n\n" enum: + - Association - Partnership + - SoleProprietorship - Trust type: string + required: + - type + - name + - address LegalArrangementEntityDetail: properties: address: @@ -2431,35 +2474,38 @@ components: legalArrangementEntityCode: description: Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity. + Required when updating an existing legal arrangement entity entry in an + `/updateAccountHolder` request. type: string legalArrangementEntityReference: description: Your reference for the legal arrangement entity. type: string legalArrangementMembers: - description: 'The roles of the entity in the legal arrangement. The values - depend on the `legalArragementType`. + description: 'An array containing the roles of the entity in the legal arrangement. + + The possible values depend on the legal arrangement `type`. - Possible values: + - For `type` **Association**: **ControllingPerson** and **Shareholder**. - - For `legalArragementType` **Trust**, you can use **Trustee**, **Settlor**, - **Protector**, **Beneficiary**, or **Shareholder**. + - For `type` **Partnership**: **Partner** and **Shareholder**. - - For `legalArragementType` **Partnership**, you can use **Partner** or - **Shareholder**. ' + + - For `type` **Trust**: **Trustee**, **Settlor**, **Protector**, **Beneficiary**, and + **Shareholder**. + + + ' items: enum: - - Associate - Beneficiary - - Chairman + - ControllingPerson - Partner - Protector - - Secretary - Settlor - Shareholder - - Treasurer - Trustee type: string type: array @@ -2528,12 +2574,12 @@ components: description: The details of the payment failure. $ref: '#/components/schemas/PaymentFailureNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2674,12 +2720,12 @@ components: description: Details of the fund transfer refund. $ref: '#/components/schemas/RefundFundsTransferNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2712,7 +2758,7 @@ components: description: The amount to be refunded. $ref: '#/components/schemas/Amount' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Invalid fields list. items: $ref: '#/components/schemas/ErrorFieldType' @@ -2751,12 +2797,12 @@ components: description: Details of the report. $ref: '#/components/schemas/ReportAvailableNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2807,12 +2853,12 @@ components: description: Details of the scheduling of the refunds. $ref: '#/components/schemas/ScheduledRefundsNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -2848,7 +2894,7 @@ components: description: The code of the Account Holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Invalid fields list. items: $ref: '#/components/schemas/ErrorFieldType' @@ -2924,7 +2970,7 @@ components: ' type: string shareholderReference: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Your reference for the shareholder entry. type: string shareholderType: @@ -3089,14 +3135,14 @@ components: readOnly: true $ref: '#/components/schemas/ViasPhoneNumber' shopperInteraction: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'The sales channel. Possible values: **Ecommerce**, **POS**.' enum: - Ecommerce - POS type: string splitConfigurationUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and @@ -3131,12 +3177,12 @@ components: This value will be shown as the store description in your Customer Area.' type: string virtualAccount: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`. type: string webAddress: - x-addedInVersion: 5 + x-addedInVersion: '5' description: URL of the ecommerce store. type: string required: @@ -3179,11 +3225,11 @@ components: description: The merchant reference of a transaction. type: string paymentPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related authorisation or transfer. type: string payoutPspReference: - x-addedInVersion: 3 + x-addedInVersion: '3' description: The psp reference of the related payout. type: string pspReference: @@ -3253,12 +3299,12 @@ components: description: Details of the fund transfer. $ref: '#/components/schemas/TransferFundsNotificationContent' error: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Error information of failed request. No value provided here if no error occurred on processing. $ref: '#/components/schemas/NotificationErrorContainer' eventDate: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The date and time when an event has been completed. format: date-time type: string @@ -3294,13 +3340,13 @@ components: description: The code of the Account to which funds were credited. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Invalid fields list. items: $ref: '#/components/schemas/ErrorFieldType' type: array merchantReference: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The reference provided by the merchant. type: string sourceAccountCode: @@ -3320,15 +3366,12 @@ components: UltimateParentCompany: properties: address: - x-addedInVersion: 6 description: Address of the ultimate parent company. $ref: '#/components/schemas/ViasAddress' businessDetails: - x-addedInVersion: 6 description: Details about the ultimate parent company's business. $ref: '#/components/schemas/UltimateParentCompanyBusinessDetails' ultimateParentCompanyCode: - x-addedInVersion: 6 description: Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` @@ -3340,19 +3383,15 @@ components: description: The legal name of the company. type: string registrationNumber: - x-addedInVersion: 4 description: The registration number of the company. type: string stockExchange: - x-addedInVersion: 6 description: Market Identifier Code (MIC). type: string stockNumber: - x-addedInVersion: 6 description: International Securities Identification Number (ISIN). type: string stockTicker: - x-addedInVersion: 6 description: Stock Ticker symbol. type: string UpdateAccountHolderResponse: @@ -3364,22 +3403,22 @@ components: description: Details of the account holder. $ref: '#/components/schemas/AccountHolderDetails' accountHolderStatus: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The new status of the account holder. $ref: '#/components/schemas/AccountHolderStatus' description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account holder. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation. items: $ref: '#/components/schemas/ErrorFieldType' type: array legalEntity: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The legal entity of the account holder. enum: - Business @@ -3389,7 +3428,7 @@ components: - PublicCompany type: string primaryCurrency: - x-addedInVersion: 5 + x-addedInVersion: '5' 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 @@ -3401,11 +3440,11 @@ components: description: The result code. type: string verification: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The details of KYC Verification of the account holder. $ref: '#/components/schemas/KYCVerificationResult2' verificationProfile: - x-addedInVersion: 6 + x-addedInVersion: '6' description: The identifier of the profile that applies to this entity. type: string required: @@ -3418,7 +3457,7 @@ components: description: The code of the account. type: string bankAccountUUID: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts @@ -3426,24 +3465,24 @@ components: account holder. type: string description: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The description of the account. type: string invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: A list of fields that caused the `/updateAccount` request to fail. items: $ref: '#/components/schemas/ErrorFieldType' type: array metadata: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: A set of key and value pairs containing metadata. type: object payoutMethodCode: - x-addedInVersion: 5 + x-addedInVersion: '5' description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. @@ -3452,7 +3491,7 @@ components: description: The payout schedule of the account. $ref: '#/components/schemas/PayoutScheduleResponse' payoutSpeed: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.' enum: @@ -3549,7 +3588,7 @@ components: For example, **2000-01-31**. type: string documentData: - x-addedInVersion: 3 + x-addedInVersion: '3' description: Array that contains information about the person's identification document. You can submit only one entry per document type. items: diff --git a/yaml/NotificationConfigurationService-v1.yaml b/yaml/NotificationConfigurationService-v1.yaml index 1cf839a3..d437696d 100644 --- a/yaml/NotificationConfigurationService-v1.yaml +++ b/yaml/NotificationConfigurationService-v1.yaml @@ -60,6 +60,8 @@ x-groups: paths: /createNotificationConfiguration: post: + tags: + - General summary: Subscribe to notifications. description: Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified @@ -88,8 +90,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -125,6 +127,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteNotificationConfigurations: post: + tags: + - General summary: Delete an existing notification subscription configuration. description: This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications @@ -179,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfiguration: post: + tags: + - General summary: Retrieve an existing notification subscription configuration. description: This endpoint is used to retrieve the details of the configuration of a notification subscription. @@ -232,6 +238,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfigurationList: post: + tags: + - General summary: Retrieve a list of existing notification subscription configurations. description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing @@ -286,6 +294,8 @@ paths: description: Internal Server Error - the server could not process the request. /testNotificationConfiguration: post: + tags: + - General summary: Test an existing notification configuration. description: This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be @@ -340,6 +350,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateNotificationConfiguration: post: + tags: + - General summary: Update an existing notification subscription configuration. description: This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be @@ -363,8 +375,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -519,7 +531,8 @@ components: description: A description of the notification subscription configuration. type: string eventConfigs: - description: The types of events whose notifications apply to this configuration. + description: Contains objects that define event types and their subscription + settings. items: $ref: '#/components/schemas/NotificationEventConfiguration' type: array @@ -533,10 +546,9 @@ components: - SOAP type: string notificationId: - description: 'The ID of the configuration. - - >Required if updating an existing configuration, ignored during the creation - of a configuration.' + description: Adyen-generated ID for the entry, returned in the response + when you create a notification configuration. Required when updating an + existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration). format: int64 type: integer notifyPassword: @@ -575,13 +587,16 @@ components: NotificationEventConfiguration: properties: eventType: - description: 'The type of event triggering the notification. + description: 'The type of event. - >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, - `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, - `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, - `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, - `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.' + + Possible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, + **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, + **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, + **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, + **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, + **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, + **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.' enum: - ACCOUNT_CLOSED - ACCOUNT_CREATED @@ -606,16 +621,15 @@ components: - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: - description: 'Indicates whether the specified eventType is to be sent to - the endpoint or all events other than the specified eventType (and other - specified eventTypes) are to be sent. + description: 'Indicates whether the specified `eventType` is sent to your + webhook endpoint. - >Permitted values: `INCLUDE`, `EXCLUDE`. + Possible values: - >- `INCLUDE`: send the specified eventType. + * **INCLUDE**: Send the specified `eventType`. - >- `EXCLUDE`: send all eventTypes other than the specified eventType (and - other eventTypes marked with `EXCLUDE`).' + * **EXCLUDE**: Send all event types except the specified `eventType` and + other event types with the `includeMode` set to **EXCLUDE**.' enum: - EXCLUDE - INCLUDE @@ -794,23 +808,6 @@ components: notifyPassword: testPassword sendActionHeader: true sslProtocol: SSL - post-createNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178952143018' - submittedAsync: 'false' - configurationDetails: - active: 'true' - description: Test notification769551 - eventConfigs: - - NotificationEventConfiguration: - eventType: ACCOUNT_HOLDER_VERIFICATION - includeMode: INCLUDE - messageFormat: SOAP - notificationId: 28467 - notifyURL: https://www.adyen.com/notification-handler - sendActionHeader: 'true' - sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -830,23 +827,3 @@ components: notifyUsername: testUserName2 sendActionHeader: false sslProtocol: TLSv10 - post-updateNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8516178951636344' - submittedAsync: 'false' - configurationDetails: - active: 'false' - description: new description799847 - eventConfigs: - - NotificationEventConfiguration: - eventType: ACCOUNT_CREATED - includeMode: INCLUDE - - NotificationEventConfiguration: - eventType: ACCOUNT_HOLDER_CREATED - includeMode: EXCLUDE - messageFormat: JSON - notificationId: 21259 - notifyURL: http://www.adyen.com - sendActionHeader: 'false' - sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v2.yaml b/yaml/NotificationConfigurationService-v2.yaml index d05c280c..cc611f1d 100644 --- a/yaml/NotificationConfigurationService-v2.yaml +++ b/yaml/NotificationConfigurationService-v2.yaml @@ -60,6 +60,8 @@ x-groups: paths: /createNotificationConfiguration: post: + tags: + - General summary: Subscribe to notifications. description: Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified @@ -88,8 +90,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -125,6 +127,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteNotificationConfigurations: post: + tags: + - General summary: Delete an existing notification subscription configuration. description: This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications @@ -179,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfiguration: post: + tags: + - General summary: Retrieve an existing notification subscription configuration. description: This endpoint is used to retrieve the details of the configuration of a notification subscription. @@ -232,6 +238,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfigurationList: post: + tags: + - General summary: Retrieve a list of existing notification subscription configurations. description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing @@ -286,6 +294,8 @@ paths: description: Internal Server Error - the server could not process the request. /testNotificationConfiguration: post: + tags: + - General summary: Test an existing notification configuration. description: This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be @@ -340,6 +350,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateNotificationConfiguration: post: + tags: + - General summary: Update an existing notification subscription configuration. description: This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be @@ -363,8 +375,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -519,7 +531,8 @@ components: description: A description of the notification subscription configuration. type: string eventConfigs: - description: The types of events whose notifications apply to this configuration. + description: Contains objects that define event types and their subscription + settings. items: $ref: '#/components/schemas/NotificationEventConfiguration' type: array @@ -533,10 +546,9 @@ components: - SOAP type: string notificationId: - description: 'The ID of the configuration. - - >Required if updating an existing configuration, ignored during the creation - of a configuration.' + description: Adyen-generated ID for the entry, returned in the response + when you create a notification configuration. Required when updating an + existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration). format: int64 type: integer notifyPassword: @@ -575,13 +587,16 @@ components: NotificationEventConfiguration: properties: eventType: - description: 'The type of event triggering the notification. + description: 'The type of event. - >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, - `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, - `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, - `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, - `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.' + + Possible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, + **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, + **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, + **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, + **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, + **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, + **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.' enum: - ACCOUNT_CLOSED - ACCOUNT_CREATED @@ -606,16 +621,15 @@ components: - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: - description: 'Indicates whether the specified eventType is to be sent to - the endpoint or all events other than the specified eventType (and other - specified eventTypes) are to be sent. + description: 'Indicates whether the specified `eventType` is sent to your + webhook endpoint. - >Permitted values: `INCLUDE`, `EXCLUDE`. + Possible values: - >- `INCLUDE`: send the specified eventType. + * **INCLUDE**: Send the specified `eventType`. - >- `EXCLUDE`: send all eventTypes other than the specified eventType (and - other eventTypes marked with `EXCLUDE`).' + * **EXCLUDE**: Send all event types except the specified `eventType` and + other event types with the `includeMode` set to **EXCLUDE**.' enum: - EXCLUDE - INCLUDE @@ -794,23 +808,6 @@ components: notifyPassword: testPassword sendActionHeader: true sslProtocol: SSL - post-createNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178952143018' - submittedAsync: 'false' - configurationDetails: - active: 'true' - description: Test notification769551 - eventConfigs: - - NotificationEventConfiguration: - eventType: ACCOUNT_HOLDER_VERIFICATION - includeMode: INCLUDE - messageFormat: SOAP - notificationId: 28467 - notifyURL: https://www.adyen.com/notification-handler - sendActionHeader: 'true' - sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -830,23 +827,3 @@ components: notifyUsername: testUserName2 sendActionHeader: false sslProtocol: TLSv10 - post-updateNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8516178951636344' - submittedAsync: 'false' - configurationDetails: - active: 'false' - description: new description799847 - eventConfigs: - - NotificationEventConfiguration: - eventType: ACCOUNT_CREATED - includeMode: INCLUDE - - NotificationEventConfiguration: - eventType: ACCOUNT_HOLDER_CREATED - includeMode: EXCLUDE - messageFormat: JSON - notificationId: 21259 - notifyURL: http://www.adyen.com - sendActionHeader: 'false' - sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v3.yaml b/yaml/NotificationConfigurationService-v3.yaml index 3dffb4af..34cfdf13 100644 --- a/yaml/NotificationConfigurationService-v3.yaml +++ b/yaml/NotificationConfigurationService-v3.yaml @@ -60,6 +60,8 @@ x-groups: paths: /createNotificationConfiguration: post: + tags: + - General summary: Subscribe to notifications. description: Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified @@ -88,8 +90,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -125,6 +127,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteNotificationConfigurations: post: + tags: + - General summary: Delete an existing notification subscription configuration. description: This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications @@ -179,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfiguration: post: + tags: + - General summary: Retrieve an existing notification subscription configuration. description: This endpoint is used to retrieve the details of the configuration of a notification subscription. @@ -232,6 +238,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfigurationList: post: + tags: + - General summary: Retrieve a list of existing notification subscription configurations. description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing @@ -286,6 +294,8 @@ paths: description: Internal Server Error - the server could not process the request. /testNotificationConfiguration: post: + tags: + - General summary: Test an existing notification configuration. description: This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be @@ -340,6 +350,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateNotificationConfiguration: post: + tags: + - General summary: Update an existing notification subscription configuration. description: This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be @@ -363,8 +375,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -519,7 +531,8 @@ components: description: A description of the notification subscription configuration. type: string eventConfigs: - description: The types of events whose notifications apply to this configuration. + description: Contains objects that define event types and their subscription + settings. items: $ref: '#/components/schemas/NotificationEventConfiguration' type: array @@ -533,10 +546,9 @@ components: - SOAP type: string notificationId: - description: 'The ID of the configuration. - - >Required if updating an existing configuration, ignored during the creation - of a configuration.' + description: Adyen-generated ID for the entry, returned in the response + when you create a notification configuration. Required when updating an + existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration). format: int64 type: integer notifyPassword: @@ -575,13 +587,16 @@ components: NotificationEventConfiguration: properties: eventType: - description: 'The type of event triggering the notification. + description: 'The type of event. - >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, - `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, - `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, - `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, - `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.' + + Possible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, + **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, + **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, + **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, + **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, + **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, + **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.' enum: - ACCOUNT_CLOSED - ACCOUNT_CREATED @@ -606,16 +621,15 @@ components: - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: - description: 'Indicates whether the specified eventType is to be sent to - the endpoint or all events other than the specified eventType (and other - specified eventTypes) are to be sent. + description: 'Indicates whether the specified `eventType` is sent to your + webhook endpoint. - >Permitted values: `INCLUDE`, `EXCLUDE`. + Possible values: - >- `INCLUDE`: send the specified eventType. + * **INCLUDE**: Send the specified `eventType`. - >- `EXCLUDE`: send all eventTypes other than the specified eventType (and - other eventTypes marked with `EXCLUDE`).' + * **EXCLUDE**: Send all event types except the specified `eventType` and + other event types with the `includeMode` set to **EXCLUDE**.' enum: - EXCLUDE - INCLUDE @@ -794,23 +808,6 @@ components: notifyPassword: testPassword sendActionHeader: true sslProtocol: SSL - post-createNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178952143018' - submittedAsync: 'false' - configurationDetails: - active: 'true' - description: Test notification769551 - eventConfigs: - - NotificationEventConfiguration: - eventType: ACCOUNT_HOLDER_VERIFICATION - includeMode: INCLUDE - messageFormat: SOAP - notificationId: 28467 - notifyURL: https://www.adyen.com/notification-handler - sendActionHeader: 'true' - sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -830,23 +827,3 @@ components: notifyUsername: testUserName2 sendActionHeader: false sslProtocol: TLSv10 - post-updateNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8516178951636344' - submittedAsync: 'false' - configurationDetails: - active: 'false' - description: new description799847 - eventConfigs: - - NotificationEventConfiguration: - eventType: ACCOUNT_CREATED - includeMode: INCLUDE - - NotificationEventConfiguration: - eventType: ACCOUNT_HOLDER_CREATED - includeMode: EXCLUDE - messageFormat: JSON - notificationId: 21259 - notifyURL: http://www.adyen.com - sendActionHeader: 'false' - sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v4.yaml b/yaml/NotificationConfigurationService-v4.yaml index 6c8b60a2..537a41e2 100644 --- a/yaml/NotificationConfigurationService-v4.yaml +++ b/yaml/NotificationConfigurationService-v4.yaml @@ -60,6 +60,8 @@ x-groups: paths: /createNotificationConfiguration: post: + tags: + - General summary: Subscribe to notifications. description: Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified @@ -88,8 +90,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -125,6 +127,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteNotificationConfigurations: post: + tags: + - General summary: Delete an existing notification subscription configuration. description: This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications @@ -179,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfiguration: post: + tags: + - General summary: Retrieve an existing notification subscription configuration. description: This endpoint is used to retrieve the details of the configuration of a notification subscription. @@ -232,6 +238,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfigurationList: post: + tags: + - General summary: Retrieve a list of existing notification subscription configurations. description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing @@ -286,6 +294,8 @@ paths: description: Internal Server Error - the server could not process the request. /testNotificationConfiguration: post: + tags: + - General summary: Test an existing notification configuration. description: This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be @@ -340,6 +350,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateNotificationConfiguration: post: + tags: + - General summary: Update an existing notification subscription configuration. description: This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be @@ -363,8 +375,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -519,7 +531,8 @@ components: description: A description of the notification subscription configuration. type: string eventConfigs: - description: The types of events whose notifications apply to this configuration. + description: Contains objects that define event types and their subscription + settings. items: $ref: '#/components/schemas/NotificationEventConfiguration' type: array @@ -533,10 +546,9 @@ components: - SOAP type: string notificationId: - description: 'The ID of the configuration. - - >Required if updating an existing configuration, ignored during the creation - of a configuration.' + description: Adyen-generated ID for the entry, returned in the response + when you create a notification configuration. Required when updating an + existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration). format: int64 type: integer notifyPassword: @@ -575,13 +587,16 @@ components: NotificationEventConfiguration: properties: eventType: - description: 'The type of event triggering the notification. + description: 'The type of event. - >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, - `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, - `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, - `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, - `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.' + + Possible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, + **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, + **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, + **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, + **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, + **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, + **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.' enum: - ACCOUNT_CLOSED - ACCOUNT_CREATED @@ -606,16 +621,15 @@ components: - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: - description: 'Indicates whether the specified eventType is to be sent to - the endpoint or all events other than the specified eventType (and other - specified eventTypes) are to be sent. + description: 'Indicates whether the specified `eventType` is sent to your + webhook endpoint. - >Permitted values: `INCLUDE`, `EXCLUDE`. + Possible values: - >- `INCLUDE`: send the specified eventType. + * **INCLUDE**: Send the specified `eventType`. - >- `EXCLUDE`: send all eventTypes other than the specified eventType (and - other eventTypes marked with `EXCLUDE`).' + * **EXCLUDE**: Send all event types except the specified `eventType` and + other event types with the `includeMode` set to **EXCLUDE**.' enum: - EXCLUDE - INCLUDE @@ -794,23 +808,6 @@ components: notifyPassword: testPassword sendActionHeader: true sslProtocol: SSL - post-createNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8616178952143018' - submittedAsync: 'false' - configurationDetails: - active: 'true' - description: Test notification769551 - eventConfigs: - - NotificationEventConfiguration: - eventType: ACCOUNT_HOLDER_VERIFICATION - includeMode: INCLUDE - messageFormat: SOAP - notificationId: 28467 - notifyURL: https://www.adyen.com/notification-handler - sendActionHeader: 'true' - sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -830,23 +827,3 @@ components: notifyUsername: testUserName2 sendActionHeader: false sslProtocol: TLSv10 - post-updateNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8516178951636344' - submittedAsync: 'false' - configurationDetails: - active: 'false' - description: new description799847 - eventConfigs: - - NotificationEventConfiguration: - eventType: ACCOUNT_CREATED - includeMode: INCLUDE - - NotificationEventConfiguration: - eventType: ACCOUNT_HOLDER_CREATED - includeMode: EXCLUDE - messageFormat: JSON - notificationId: 21259 - notifyURL: http://www.adyen.com - sendActionHeader: 'false' - sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v5.yaml b/yaml/NotificationConfigurationService-v5.yaml index eacc21d3..c1574808 100644 --- a/yaml/NotificationConfigurationService-v5.yaml +++ b/yaml/NotificationConfigurationService-v5.yaml @@ -60,6 +60,8 @@ x-groups: paths: /createNotificationConfiguration: post: + tags: + - General summary: Subscribe to notifications. description: Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified @@ -88,8 +90,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -125,6 +127,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteNotificationConfigurations: post: + tags: + - General summary: Delete an existing notification subscription configuration. description: This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications @@ -179,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfiguration: post: + tags: + - General summary: Retrieve an existing notification subscription configuration. description: This endpoint is used to retrieve the details of the configuration of a notification subscription. @@ -232,6 +238,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfigurationList: post: + tags: + - General summary: Retrieve a list of existing notification subscription configurations. description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing @@ -286,6 +294,8 @@ paths: description: Internal Server Error - the server could not process the request. /testNotificationConfiguration: post: + tags: + - General summary: Test an existing notification configuration. description: This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be @@ -340,6 +350,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateNotificationConfiguration: post: + tags: + - General summary: Update an existing notification subscription configuration. description: This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be @@ -363,8 +375,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -535,6 +547,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -555,6 +568,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -598,7 +612,7 @@ components: GenericResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -619,7 +633,7 @@ components: $ref: '#/components/schemas/NotificationConfigurationDetails' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -649,7 +663,7 @@ components: description: Details of the notification subscription configuration. $ref: '#/components/schemas/NotificationConfigurationDetails' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -677,12 +691,13 @@ components: description: A description of the notification subscription configuration. type: string eventConfigs: - description: The types of events whose notifications apply to this configuration. + description: Contains objects that define event types and their subscription + settings. items: $ref: '#/components/schemas/NotificationEventConfiguration' type: array hmacSignatureKey: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the @@ -700,10 +715,9 @@ components: and `Protocol` headers in notification(s).' type: string notificationId: - description: 'The ID of the configuration. - - >Required if updating an existing configuration, ignored during the creation - of a configuration.' + description: Adyen-generated ID for the entry, returned in the response + when you create a notification configuration. Required when updating an + existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration). format: int64 type: integer notifyPassword: @@ -736,13 +750,16 @@ components: NotificationEventConfiguration: properties: eventType: - description: 'The type of event triggering the notification. + description: 'The type of event. - >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, - `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, - `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, - `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, - `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.' + + Possible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, + **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, + **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, + **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, + **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, + **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, + **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.' enum: - ACCOUNT_CLOSED - ACCOUNT_CREATED @@ -767,16 +784,15 @@ components: - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: - description: 'Indicates whether the specified eventType is to be sent to - the endpoint or all events other than the specified eventType (and other - specified eventTypes) are to be sent. + description: 'Indicates whether the specified `eventType` is sent to your + webhook endpoint. - >Permitted values: `INCLUDE`, `EXCLUDE`. + Possible values: - >- `INCLUDE`: send the specified eventType. + * **INCLUDE**: Send the specified `eventType`. - >- `EXCLUDE`: send all eventTypes other than the specified eventType (and - other eventTypes marked with `EXCLUDE`).' + * **EXCLUDE**: Send all event types except the specified `eventType` and + other event types with the `includeMode` set to **EXCLUDE**.' enum: - EXCLUDE - INCLUDE @@ -891,7 +907,7 @@ components: $ref: '#/components/schemas/ExchangeMessage' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -948,19 +964,6 @@ components: notifyUsername: testUserName notifyPassword: testPassword sslProtocol: SSL - post-createNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8516178952380553' - configurationDetails: - active: true - description: Unique description 123 - eventConfigs: - - eventType: ACCOUNT_HOLDER_VERIFICATION - includeMode: INCLUDE - notificationId: 28468 - notifyURL: https://www.adyen.com/notification-handler - sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -977,18 +980,3 @@ components: notifyURL: https://www.adyen.com/notification-handler notifyUsername: testUserName2 sslProtocol: TLSv10 - post-updateNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8516178952580574' - configurationDetails: - active: false - description: Test notif config 756 - eventConfigs: - - eventType: ACCOUNT_CREATED - includeMode: INCLUDE - - eventType: ACCOUNT_HOLDER_CREATED - includeMode: EXCLUDE - notificationId: 21259 - notifyURL: https://www.adyen.com/notification-handler - sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v6.yaml b/yaml/NotificationConfigurationService-v6.yaml index 49ed34e2..4ad58d13 100644 --- a/yaml/NotificationConfigurationService-v6.yaml +++ b/yaml/NotificationConfigurationService-v6.yaml @@ -60,6 +60,8 @@ x-groups: paths: /createNotificationConfiguration: post: + tags: + - General summary: Subscribe to notifications. description: Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified @@ -88,8 +90,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -125,6 +127,8 @@ paths: description: Internal Server Error - the server could not process the request. /deleteNotificationConfigurations: post: + tags: + - General summary: Delete an existing notification subscription configuration. description: This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications @@ -179,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfiguration: post: + tags: + - General summary: Retrieve an existing notification subscription configuration. description: This endpoint is used to retrieve the details of the configuration of a notification subscription. @@ -232,6 +238,8 @@ paths: description: Internal Server Error - the server could not process the request. /getNotificationConfigurationList: post: + tags: + - General summary: Retrieve a list of existing notification subscription configurations. description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing @@ -286,6 +294,8 @@ paths: description: Internal Server Error - the server could not process the request. /testNotificationConfiguration: post: + tags: + - General summary: Test an existing notification configuration. description: This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be @@ -340,6 +350,8 @@ paths: description: Internal Server Error - the server could not process the request. /updateNotificationConfiguration: post: + tags: + - General summary: Update an existing notification subscription configuration. description: This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be @@ -363,8 +375,8 @@ paths: content: application/json: examples: - basic-200: - $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -535,6 +547,7 @@ components: - passport - passportNumber - payoutMethodCode + - payoutSchedule - personalData - phoneCountryCode - phoneNumber @@ -555,6 +568,7 @@ components: - socialSecurityNumber - sourceAccountCode - splitAccount + - splitConfigurationUUID - splitCurrency - splitValue - splits @@ -598,7 +612,7 @@ components: GenericResponse: properties: invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -619,7 +633,7 @@ components: $ref: '#/components/schemas/NotificationConfigurationDetails' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -649,7 +663,7 @@ components: description: Details of the notification subscription configuration. $ref: '#/components/schemas/NotificationConfigurationDetails' invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -677,12 +691,13 @@ components: description: A description of the notification subscription configuration. type: string eventConfigs: - description: The types of events whose notifications apply to this configuration. + description: Contains objects that define event types and their subscription + settings. items: $ref: '#/components/schemas/NotificationEventConfiguration' type: array hmacSignatureKey: - x-addedInVersion: 5 + x-addedInVersion: '5' description: 'A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the @@ -700,10 +715,9 @@ components: and `Protocol` headers in notification(s).' type: string notificationId: - description: 'The ID of the configuration. - - >Required if updating an existing configuration, ignored during the creation - of a configuration.' + description: Adyen-generated ID for the entry, returned in the response + when you create a notification configuration. Required when updating an + existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration). format: int64 type: integer notifyPassword: @@ -736,13 +750,16 @@ components: NotificationEventConfiguration: properties: eventType: - description: 'The type of event triggering the notification. + description: 'The type of event. - >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, - `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, - `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, - `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, - `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.' + + Possible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, + **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, + **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, + **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, + **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, + **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, + **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.' enum: - ACCOUNT_CLOSED - ACCOUNT_CREATED @@ -767,16 +784,15 @@ components: - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: - description: 'Indicates whether the specified eventType is to be sent to - the endpoint or all events other than the specified eventType (and other - specified eventTypes) are to be sent. + description: 'Indicates whether the specified `eventType` is sent to your + webhook endpoint. - >Permitted values: `INCLUDE`, `EXCLUDE`. + Possible values: - >- `INCLUDE`: send the specified eventType. + * **INCLUDE**: Send the specified `eventType`. - >- `EXCLUDE`: send all eventTypes other than the specified eventType (and - other eventTypes marked with `EXCLUDE`).' + * **EXCLUDE**: Send all event types except the specified `eventType` and + other event types with the `includeMode` set to **EXCLUDE**.' enum: - EXCLUDE - INCLUDE @@ -891,7 +907,7 @@ components: $ref: '#/components/schemas/ExchangeMessage' type: array invalidFields: - x-addedInVersion: 5 + x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: @@ -948,19 +964,6 @@ components: notifyUsername: testUserName notifyPassword: testPassword sslProtocol: SSL - post-createNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8516178952380553' - configurationDetails: - active: true - description: Unique description 123 - eventConfigs: - - eventType: ACCOUNT_HOLDER_VERIFICATION - includeMode: INCLUDE - notificationId: 28468 - notifyURL: https://www.adyen.com/notification-handler - sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -977,18 +980,3 @@ components: notifyURL: https://www.adyen.com/notification-handler notifyUsername: testUserName2 sslProtocol: TLSv10 - post-updateNotificationConfiguration-basic-200: - summary: Example response for request 'basic' - value: - pspReference: '8516178952580574' - configurationDetails: - active: false - description: Test notif config 756 - eventConfigs: - - eventType: ACCOUNT_CREATED - includeMode: INCLUDE - - eventType: ACCOUNT_HOLDER_CREATED - includeMode: EXCLUDE - notificationId: 21259 - notifyURL: https://www.adyen.com/notification-handler - sslProtocol: TLSv10 diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index 05d57758..06fa293a 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payment/v25 info: @@ -63,6 +63,8 @@ x-groups: paths: /authorise: post: + tags: + - General summary: Creates a payment authorisation. description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -76,6 +78,9 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -97,8 +102,8 @@ paths: content: application/json: examples: - authorise-recurringcontauth-200: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth-200' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' schema: $ref: '#/components/schemas/PaymentResult' description: OK - the request has succeeded. @@ -106,8 +111,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -115,8 +120,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -136,13 +141,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3d: post: + tags: + - General summary: Completes a 3D Secure payment authorisation. description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -156,6 +163,9 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -175,8 +185,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -184,8 +194,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -205,13 +215,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancel: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only @@ -228,6 +240,9 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -247,8 +262,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -256,8 +271,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -277,13 +292,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancelOrRefund: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: "Cancels a payment if it has not been captured yet, or refunds\ \ it if it has already been captured. This is useful when it is not certain\ @@ -301,6 +318,9 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -314,8 +334,8 @@ paths: content: application/json: examples: - cancelOrRefund-200: - $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -323,8 +343,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -332,8 +352,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -353,13 +373,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /capture: post: + tags: + - Modifications summary: Captures an authorised payment. description: 'Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, @@ -386,6 +408,9 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -399,8 +424,8 @@ paths: content: application/json: examples: - capture-200: - $ref: '#/components/examples/post-capture-capture-200' + capture: + $ref: '#/components/examples/post-capture-capture' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -408,8 +433,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -417,8 +442,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -438,13 +463,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /refund: post: + tags: + - Modifications summary: Refunds a captured payment. description: 'Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured @@ -470,6 +497,9 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -483,8 +513,8 @@ paths: content: application/json: examples: - refund-200: - $ref: '#/components/examples/post-refund-refund-200' + refund: + $ref: '#/components/examples/post-refund-refund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -492,8 +522,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -501,8 +531,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -522,13 +552,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /voidPendingRefund: post: + tags: + - Modifications summary: Cancels a POS refund request before it has been completed. description: 'This endpoint allows you to cancel the refund request before it has been completed. @@ -541,10 +573,13 @@ paths: For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' - x-addedInVersion: 25 + x-addedInVersion: '25' operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -560,10 +595,10 @@ paths: content: application/json: examples: - voidpendingrefund-pspreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -571,8 +606,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -580,8 +615,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -601,8 +636,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1140,6 +1175,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1619,19 +1662,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -1857,68 +1887,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2110,7 +2078,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2149,7 +2117,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2218,12 +2186,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2281,12 +2249,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2349,12 +2317,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2666,7 +2634,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -2682,7 +2650,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -2693,7 +2661,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -2707,7 +2675,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -2718,13 +2686,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -2736,7 +2704,7 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -2744,7 +2712,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -2754,7 +2722,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -2769,7 +2737,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -2789,7 +2757,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -2881,12 +2849,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -2902,21 +2870,23 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 @@ -2967,7 +2937,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -2983,13 +2953,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3003,7 +2973,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3014,7 +2984,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -3025,12 +2995,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3043,7 +3013,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3058,7 +3028,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3165,12 +3135,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3186,21 +3156,23 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 @@ -3261,7 +3233,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3351,7 +3323,7 @@ components: description: A descriptive name for this detail. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -3413,12 +3385,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3444,6 +3416,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -3756,6 +3731,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -4215,12 +4222,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4235,28 +4242,13 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' post-authorise-authorise-3dsecure: summary: Initiate a 3D Secure payment value: @@ -4290,21 +4282,6 @@ components: reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth-200: summary: Example response for request 'authorise-recurringcontauth' value: additionalData: @@ -4369,11 +4346,6 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-cancelOrRefund-cancelOrRefund-200: - summary: Example response for request 'cancelOrRefund' - value: - pspReference: 851617892359708H - response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -4383,11 +4355,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-capture-capture-200: - summary: Example response for request 'capture' - value: - pspReference: 861617892359057J - response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -4397,29 +4364,12 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-refund-refund-200: - summary: Example response for request 'refund' - value: - pspReference: 861617892360059B - response: '[refund-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' - post-voidPendingRefund-voidpendingrefund-pspreference-200: - summary: Example response for request 'voidpendingrefund-pspreference' - value: - pspReference: 861617892360062F - response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: - summary: Cancels a POS refund request with tender reference before it has been - completed - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - tenderReference: 5Iw8001176969533005 - uniqueTerminalId: VX820-123456789 - post-voidPendingRefund-voidpendingrefund-tenderreference-200: summary: Example response for request 'voidpendingrefund-tenderreference' value: pspReference: 881617892360409G diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 685a9a54..34111686 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payment/v30 info: @@ -63,6 +63,8 @@ x-groups: paths: /adjustAuthorisation: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for @@ -81,10 +83,13 @@ paths: > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.' - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -98,8 +103,8 @@ paths: content: application/json: examples: - adjustAuthorisation-200: - $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -107,8 +112,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -116,8 +121,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -137,13 +142,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise: post: + tags: + - General summary: Creates a payment authorisation. description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -157,6 +164,9 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -186,8 +196,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -195,8 +205,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -216,13 +226,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3d: post: + tags: + - General summary: Completes a 3D Secure payment authorisation. description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -236,6 +248,9 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -255,8 +270,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -264,8 +279,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -285,13 +300,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancel: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only @@ -308,6 +325,9 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -327,8 +347,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -336,8 +356,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -357,13 +377,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancelOrRefund: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: "Cancels a payment if it has not been captured yet, or refunds\ \ it if it has already been captured. This is useful when it is not certain\ @@ -381,6 +403,9 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -394,8 +419,8 @@ paths: content: application/json: examples: - cancelOrRefund-200: - $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -403,8 +428,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -412,8 +437,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -433,13 +458,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /capture: post: + tags: + - Modifications summary: Captures an authorised payment. description: 'Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, @@ -466,6 +493,9 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -479,8 +509,8 @@ paths: content: application/json: examples: - capture-200: - $ref: '#/components/examples/post-capture-capture-200' + capture: + $ref: '#/components/examples/post-capture-capture' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -488,8 +518,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -497,8 +527,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -518,13 +548,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /refund: post: + tags: + - Modifications summary: Refunds a captured payment. description: 'Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured @@ -550,6 +582,9 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -563,8 +598,8 @@ paths: content: application/json: examples: - refund-200: - $ref: '#/components/examples/post-refund-refund-200' + refund: + $ref: '#/components/examples/post-refund-refund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -572,8 +607,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -581,8 +616,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -602,13 +637,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /technicalCancel: post: + tags: + - Modifications summary: Cancels a payment using your custom reference. description: "This endpoint allows you to cancel a payment if you do not have\ \ the PSP reference of the original payment request available.\n\nIn your\ @@ -618,10 +655,13 @@ paths: \ If using a [newer integration](https://docs.adyen.com/online-payments),\ \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ \ endpoint under Checkout API instead." - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -635,8 +675,8 @@ paths: content: application/json: examples: - technicalCancel-200: - $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -644,8 +684,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -653,8 +693,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -674,13 +714,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /voidPendingRefund: post: + tags: + - Modifications summary: Cancels a POS refund request before it has been completed. description: 'This endpoint allows you to cancel the refund request before it has been completed. @@ -693,10 +735,13 @@ paths: For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' - x-addedInVersion: 25 + x-addedInVersion: '25' operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -712,10 +757,10 @@ paths: content: application/json: examples: - voidpendingrefund-pspreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -723,8 +768,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -732,8 +777,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -753,8 +798,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1292,6 +1337,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1771,19 +1824,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -2009,68 +2049,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2280,7 +2258,7 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2302,12 +2280,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2335,7 +2313,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2374,7 +2352,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2425,7 +2403,7 @@ components: description: The merchant account that is used to process the payment. type: string originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2447,12 +2425,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2492,7 +2470,7 @@ components: description: The merchant account that is used to process the payment. type: string originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2514,12 +2492,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2564,7 +2542,7 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2586,12 +2564,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2903,7 +2881,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -2919,7 +2897,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -2930,7 +2908,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -2944,7 +2922,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -2955,13 +2933,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -2973,7 +2951,7 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -2981,7 +2959,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -2991,7 +2969,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3006,7 +2984,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3026,7 +3004,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -3041,7 +3019,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3135,12 +3113,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3156,21 +3134,23 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 @@ -3221,7 +3201,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3237,13 +3217,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3257,7 +3237,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3268,7 +3248,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -3279,12 +3259,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3297,7 +3277,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3312,7 +3292,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3342,7 +3322,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3436,12 +3416,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3457,21 +3437,23 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 @@ -3532,7 +3514,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3622,7 +3604,7 @@ components: description: A descriptive name for this detail. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -3666,7 +3648,7 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3688,12 +3670,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3719,6 +3701,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -4031,6 +4016,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -4425,7 +4442,7 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string reference: @@ -4435,12 +4452,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4533,7 +4550,7 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -4555,12 +4572,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4575,28 +4592,13 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' post-adjustAuthorisation-adjustAuthorisation: summary: Increases or decreases the authorised amount value: @@ -4606,11 +4608,6 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-adjustAuthorisation-adjustAuthorisation-200: - summary: Example response for request 'adjustAuthorisation' - value: - pspReference: 851617892360718D - response: '[adjustAuthorisation-received]' post-authorise-authorise-3dsecure: summary: Initiate a 3D Secure payment value: @@ -4740,11 +4737,6 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-cancelOrRefund-cancelOrRefund-200: - summary: Example response for request 'cancelOrRefund' - value: - pspReference: 851617892359708H - response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -4754,11 +4746,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-capture-capture-200: - summary: Example response for request 'capture' - value: - pspReference: 861617892359057J - response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -4768,18 +4755,7 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-refund-refund-200: - summary: Example response for request 'refund' - value: - pspReference: 861617892360059B - response: '[refund-received]' post-technicalCancel-technicalCancel: - summary: Cancel a payment without a PSP reference - value: - originalMerchantReference: YOUR_MERCHANT_REFERENCE - reference: YOUR_MODIFICATION_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-technicalCancel-technicalCancel-200: summary: Example response for request 'technicalCancel' value: pspReference: 881617892361436J @@ -4789,19 +4765,7 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' - post-voidPendingRefund-voidpendingrefund-pspreference-200: - summary: Example response for request 'voidpendingrefund-pspreference' - value: - pspReference: 861617892360062F - response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: - summary: Cancels a POS refund request with tender reference before it has been - completed - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - tenderReference: 5Iw8001176969533005 - uniqueTerminalId: VX820-123456789 - post-voidPendingRefund-voidpendingrefund-tenderreference-200: summary: Example response for request 'voidpendingrefund-tenderreference' value: pspReference: 881617892360409G diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index 8ad27770..e7de6a1b 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payment/v40 info: @@ -63,6 +63,8 @@ x-groups: paths: /adjustAuthorisation: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for @@ -81,10 +83,13 @@ paths: > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.' - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -98,8 +103,8 @@ paths: content: application/json: examples: - adjustAuthorisation-200: - $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -107,8 +112,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -116,8 +121,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -137,13 +142,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise: post: + tags: + - General summary: Creates a payment authorisation. description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -157,6 +164,9 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -188,8 +198,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -197,8 +207,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -218,13 +228,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3d: post: + tags: + - General summary: Completes a 3D Secure payment authorisation. description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -238,6 +250,9 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +272,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -266,8 +281,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -287,13 +302,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3ds2: post: + tags: + - General summary: Completes a 3D Secure 2 payment authorisation. description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -304,10 +321,13 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' - x-addedInVersion: 37 + x-addedInVersion: '37' operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -327,8 +347,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -336,8 +356,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -357,13 +377,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancel: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only @@ -380,6 +402,9 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -399,8 +424,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -408,8 +433,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -429,13 +454,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancelOrRefund: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: "Cancels a payment if it has not been captured yet, or refunds\ \ it if it has already been captured. This is useful when it is not certain\ @@ -453,6 +480,9 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -466,8 +496,8 @@ paths: content: application/json: examples: - cancelOrRefund-200: - $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -475,8 +505,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -484,8 +514,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -505,13 +535,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /capture: post: + tags: + - Modifications summary: Captures an authorised payment. description: 'Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, @@ -538,6 +570,9 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -551,8 +586,8 @@ paths: content: application/json: examples: - capture-200: - $ref: '#/components/examples/post-capture-capture-200' + capture: + $ref: '#/components/examples/post-capture-capture' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -560,8 +595,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -569,8 +604,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -590,24 +625,32 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /donate: post: + tags: + - Modifications summary: Creates a payment for the specified donation. description: 'Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment. - For more information, see [Donate](https://docs.adyen.com/online-payments/donate).' - x-addedInVersion: 40 + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) + endpoint under Checkout API instead.' + x-addedInVersion: '40' operationId: post-donate x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -627,8 +670,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -636,8 +679,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -657,13 +700,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /refund: post: + tags: + - Modifications summary: Refunds a captured payment. description: 'Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured @@ -689,6 +734,9 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -702,8 +750,8 @@ paths: content: application/json: examples: - refund-200: - $ref: '#/components/examples/post-refund-refund-200' + refund: + $ref: '#/components/examples/post-refund-refund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -711,8 +759,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -720,8 +768,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -741,21 +789,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /retrieve3ds2Result: post: + tags: + - General summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. - x-addedInVersion: 40 + x-addedInVersion: '40' operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -775,8 +828,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -784,8 +837,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -805,13 +858,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /technicalCancel: post: + tags: + - Modifications summary: Cancels a payment using your custom reference. description: "This endpoint allows you to cancel a payment if you do not have\ \ the PSP reference of the original payment request available.\n\nIn your\ @@ -821,10 +876,13 @@ paths: \ If using a [newer integration](https://docs.adyen.com/online-payments),\ \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ \ endpoint under Checkout API instead." - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -838,8 +896,8 @@ paths: content: application/json: examples: - technicalCancel-200: - $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -847,8 +905,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -856,8 +914,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -877,13 +935,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /voidPendingRefund: post: + tags: + - Modifications summary: Cancels a POS refund request before it has been completed. description: 'This endpoint allows you to cancel the refund request before it has been completed. @@ -896,10 +956,13 @@ paths: For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' - x-addedInVersion: 25 + x-addedInVersion: '25' operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -915,10 +978,10 @@ paths: content: application/json: examples: - voidpendingrefund-pspreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -926,8 +989,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -935,8 +998,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -956,8 +1019,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1651,6 +1714,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2130,19 +2201,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -2368,68 +2426,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2639,7 +2635,7 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2661,7 +2657,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2669,12 +2665,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2728,7 +2724,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2767,7 +2763,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2778,41 +2774,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2864,7 +2860,7 @@ components: description: The merchant account that is used to process the payment. type: string originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2886,12 +2882,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2931,7 +2927,7 @@ components: description: The merchant account that is used to process the payment. type: string originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2953,7 +2949,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2961,12 +2957,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3011,7 +3007,7 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3033,7 +3029,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3041,12 +3037,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3499,7 +3495,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3544,7 +3540,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -3555,7 +3551,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3571,7 +3567,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -3582,7 +3578,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3596,7 +3592,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3607,13 +3603,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -3625,7 +3621,7 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -3633,7 +3629,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3643,7 +3639,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3658,14 +3654,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3685,7 +3681,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -3700,7 +3696,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3794,12 +3790,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3815,11 +3811,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3827,30 +3823,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3860,7 +3858,7 @@ components: PaymentRequest3d: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3905,12 +3903,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3926,13 +3924,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3946,7 +3944,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3957,7 +3955,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -3968,12 +3966,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3986,7 +3984,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4001,14 +3999,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4038,7 +4036,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4132,12 +4130,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4153,11 +4151,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4165,30 +4163,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4198,7 +4198,7 @@ components: PaymentRequest3ds2: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4243,12 +4243,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4264,13 +4264,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4284,7 +4284,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4295,7 +4295,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4306,12 +4306,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4321,7 +4321,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4336,14 +4336,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4369,7 +4369,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4463,12 +4463,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4484,11 +4484,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4496,17 +4496,19 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. @@ -4518,14 +4520,14 @@ components: description: The ThreeDS2Token that was returned in the /authorise call. type: string totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4583,7 +4585,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -4673,18 +4675,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -4728,7 +4730,7 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -4750,7 +4752,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -4758,12 +4760,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4789,6 +4791,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5101,6 +5106,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -5184,7 +5221,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -5199,11 +5236,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -5598,7 +5635,7 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string reference: @@ -5608,7 +5645,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5616,12 +5653,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -5717,7 +5754,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -5823,7 +5860,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -5831,7 +5868,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -5878,7 +5915,7 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -5900,7 +5937,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5908,12 +5945,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -5928,28 +5965,13 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' post-adjustAuthorisation-adjustAuthorisation: summary: Increases or decreases the authorised amount value: @@ -5959,11 +5981,6 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-adjustAuthorisation-adjustAuthorisation-200: - summary: Example response for request 'adjustAuthorisation' - value: - pspReference: 851617892360718D - response: '[adjustAuthorisation-received]' post-authorise-authorise-3d-secure-2: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -6136,11 +6153,6 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-cancelOrRefund-cancelOrRefund-200: - summary: Example response for request 'cancelOrRefund' - value: - pspReference: 851617892359708H - response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6150,11 +6162,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-capture-capture-200: - summary: Example response for request 'capture' - value: - pspReference: 861617892359057J - response: '[capture-received]' post-donate-donate: summary: Create a payment for the specified donation value: @@ -6174,11 +6181,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-refund-refund-200: - summary: Example response for request 'refund' - value: - pspReference: 861617892360059B - response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6186,12 +6188,6 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT pspReference: '9935272408535455' post-technicalCancel-technicalCancel: - summary: Cancel a payment without a PSP reference - value: - originalMerchantReference: YOUR_MERCHANT_REFERENCE - reference: YOUR_MODIFICATION_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-technicalCancel-technicalCancel-200: summary: Example response for request 'technicalCancel' value: pspReference: 881617892361436J @@ -6201,19 +6197,7 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' - post-voidPendingRefund-voidpendingrefund-pspreference-200: - summary: Example response for request 'voidpendingrefund-pspreference' - value: - pspReference: 861617892360062F - response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: - summary: Cancels a POS refund request with tender reference before it has been - completed - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - tenderReference: 5Iw8001176969533005 - uniqueTerminalId: VX820-123456789 - post-voidPendingRefund-voidpendingrefund-tenderreference-200: summary: Example response for request 'voidpendingrefund-tenderreference' value: pspReference: 881617892360409G diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index 366f1af0..e6e6ccfd 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payment/v46 info: @@ -63,6 +63,8 @@ x-groups: paths: /adjustAuthorisation: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for @@ -81,10 +83,13 @@ paths: > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.' - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -98,8 +103,8 @@ paths: content: application/json: examples: - adjustAuthorisation-200: - $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -107,8 +112,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -116,8 +121,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -137,13 +142,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise: post: + tags: + - General summary: Creates a payment authorisation. description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -157,6 +164,9 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -188,8 +198,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -197,8 +207,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -218,13 +228,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3d: post: + tags: + - General summary: Completes a 3D Secure payment authorisation. description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -238,6 +250,9 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +272,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -266,8 +281,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -287,13 +302,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3ds2: post: + tags: + - General summary: Completes a 3D Secure 2 payment authorisation. description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -304,10 +321,13 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' - x-addedInVersion: 37 + x-addedInVersion: '37' operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -327,8 +347,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -336,8 +356,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -357,13 +377,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancel: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only @@ -380,6 +402,9 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -399,8 +424,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -408,8 +433,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -429,13 +454,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancelOrRefund: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: "Cancels a payment if it has not been captured yet, or refunds\ \ it if it has already been captured. This is useful when it is not certain\ @@ -453,6 +480,9 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -466,8 +496,8 @@ paths: content: application/json: examples: - cancelOrRefund-200: - $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -475,8 +505,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -484,8 +514,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -505,13 +535,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /capture: post: + tags: + - Modifications summary: Captures an authorised payment. description: 'Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, @@ -538,6 +570,9 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -551,8 +586,8 @@ paths: content: application/json: examples: - capture-200: - $ref: '#/components/examples/post-capture-capture-200' + capture: + $ref: '#/components/examples/post-capture-capture' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -560,8 +595,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -569,8 +604,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -590,24 +625,32 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /donate: post: + tags: + - Modifications summary: Creates a payment for the specified donation. description: 'Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment. - For more information, see [Donate](https://docs.adyen.com/online-payments/donate).' - x-addedInVersion: 40 + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) + endpoint under Checkout API instead.' + x-addedInVersion: '40' operationId: post-donate x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -627,8 +670,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -636,8 +679,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -657,13 +700,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /refund: post: + tags: + - Modifications summary: Refunds a captured payment. description: 'Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured @@ -689,6 +734,9 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -702,8 +750,8 @@ paths: content: application/json: examples: - refund-200: - $ref: '#/components/examples/post-refund-refund-200' + refund: + $ref: '#/components/examples/post-refund-refund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -711,8 +759,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -720,8 +768,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -741,21 +789,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /retrieve3ds2Result: post: + tags: + - General summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. - x-addedInVersion: 40 + x-addedInVersion: '40' operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -775,8 +828,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -784,8 +837,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -805,13 +858,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /technicalCancel: post: + tags: + - Modifications summary: Cancels a payment using your custom reference. description: "This endpoint allows you to cancel a payment if you do not have\ \ the PSP reference of the original payment request available.\n\nIn your\ @@ -821,10 +876,13 @@ paths: \ If using a [newer integration](https://docs.adyen.com/online-payments),\ \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ \ endpoint under Checkout API instead." - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -838,8 +896,8 @@ paths: content: application/json: examples: - technicalCancel-200: - $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -847,8 +905,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -856,8 +914,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -877,13 +935,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /voidPendingRefund: post: + tags: + - Modifications summary: Cancels a POS refund request before it has been completed. description: 'This endpoint allows you to cancel the refund request before it has been completed. @@ -896,10 +956,13 @@ paths: For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' - x-addedInVersion: 25 + x-addedInVersion: '25' operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -915,10 +978,10 @@ paths: content: application/json: examples: - voidpendingrefund-pspreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -926,8 +989,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -935,8 +998,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -956,8 +1019,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1651,6 +1714,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2130,19 +2201,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -2368,68 +2426,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2639,12 +2635,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2666,7 +2662,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2674,12 +2670,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2733,7 +2729,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2772,7 +2768,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2783,41 +2779,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2869,12 +2865,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2896,12 +2892,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2941,12 +2937,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2968,7 +2964,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2976,12 +2972,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3026,12 +3022,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3053,7 +3049,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3061,12 +3057,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3519,7 +3515,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3564,7 +3560,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -3575,7 +3571,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3591,7 +3587,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -3602,7 +3598,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3616,7 +3612,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3627,13 +3623,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -3645,7 +3641,7 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -3653,7 +3649,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3663,7 +3659,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3678,14 +3674,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3705,7 +3701,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -3720,7 +3716,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3814,12 +3810,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3835,11 +3831,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3847,30 +3843,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3880,7 +3878,7 @@ components: PaymentRequest3d: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3925,12 +3923,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3946,13 +3944,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3966,7 +3964,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3977,7 +3975,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -3988,12 +3986,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4006,7 +4004,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4021,14 +4019,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4058,7 +4056,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4152,12 +4150,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4173,11 +4171,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4185,30 +4183,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4218,7 +4218,7 @@ components: PaymentRequest3ds2: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4263,12 +4263,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4284,13 +4284,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4304,7 +4304,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4315,7 +4315,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4326,12 +4326,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4341,7 +4341,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4356,14 +4356,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4389,7 +4389,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4483,12 +4483,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4504,11 +4504,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4516,17 +4516,19 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. @@ -4538,14 +4540,14 @@ components: description: The ThreeDS2Token that was returned in the /authorise call. type: string totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4603,7 +4605,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -4693,18 +4695,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -4748,12 +4750,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -4775,7 +4777,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -4783,12 +4785,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4814,6 +4816,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5126,6 +5131,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -5209,7 +5246,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -5224,11 +5261,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -5496,7 +5533,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -5631,12 +5668,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string reference: @@ -5646,7 +5683,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5654,12 +5691,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -5755,7 +5792,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -5861,7 +5898,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -5869,7 +5906,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -5916,12 +5953,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -5943,7 +5980,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5951,12 +5988,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -5971,28 +6008,13 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' post-adjustAuthorisation-adjustAuthorisation: summary: Increases or decreases the authorised amount value: @@ -6002,11 +6024,6 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-adjustAuthorisation-adjustAuthorisation-200: - summary: Example response for request 'adjustAuthorisation' - value: - pspReference: 851617892360718D - response: '[adjustAuthorisation-received]' post-authorise-authorise-3d-secure-2: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -6179,11 +6196,6 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-cancelOrRefund-cancelOrRefund-200: - summary: Example response for request 'cancelOrRefund' - value: - pspReference: 851617892359708H - response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6193,11 +6205,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-capture-capture-200: - summary: Example response for request 'capture' - value: - pspReference: 861617892359057J - response: '[capture-received]' post-donate-donate: summary: Create a payment for the specified donation value: @@ -6217,11 +6224,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-refund-refund-200: - summary: Example response for request 'refund' - value: - pspReference: 861617892360059B - response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6229,12 +6231,6 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT pspReference: '9935272408535455' post-technicalCancel-technicalCancel: - summary: Cancel a payment without a PSP reference - value: - originalMerchantReference: YOUR_MERCHANT_REFERENCE - reference: YOUR_MODIFICATION_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-technicalCancel-technicalCancel-200: summary: Example response for request 'technicalCancel' value: pspReference: 881617892361436J @@ -6244,19 +6240,7 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' - post-voidPendingRefund-voidpendingrefund-pspreference-200: - summary: Example response for request 'voidpendingrefund-pspreference' - value: - pspReference: 861617892360062F - response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: - summary: Cancels a POS refund request with tender reference before it has been - completed - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - tenderReference: 5Iw8001176969533005 - uniqueTerminalId: VX820-123456789 - post-voidPendingRefund-voidpendingrefund-tenderreference-200: summary: Example response for request 'voidpendingrefund-tenderreference' value: pspReference: 881617892360409G diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index b19e57a5..a9eb6103 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payment/v49 info: @@ -63,6 +63,8 @@ x-groups: paths: /adjustAuthorisation: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for @@ -81,10 +83,13 @@ paths: > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.' - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -98,8 +103,8 @@ paths: content: application/json: examples: - adjustAuthorisation-200: - $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -107,8 +112,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -116,8 +121,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -137,13 +142,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise: post: + tags: + - General summary: Creates a payment authorisation. description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -157,6 +164,9 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -188,8 +198,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -197,8 +207,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -218,13 +228,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3d: post: + tags: + - General summary: Completes a 3D Secure payment authorisation. description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -238,6 +250,9 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +272,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -266,8 +281,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -287,13 +302,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3ds2: post: + tags: + - General summary: Completes a 3D Secure 2 payment authorisation. description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -304,10 +321,13 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' - x-addedInVersion: 37 + x-addedInVersion: '37' operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -327,8 +347,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -336,8 +356,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -357,13 +377,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancel: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only @@ -380,6 +402,9 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -399,8 +424,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -408,8 +433,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -429,13 +454,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancelOrRefund: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: "Cancels a payment if it has not been captured yet, or refunds\ \ it if it has already been captured. This is useful when it is not certain\ @@ -453,6 +480,9 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -466,8 +496,8 @@ paths: content: application/json: examples: - cancelOrRefund-200: - $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -475,8 +505,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -484,8 +514,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -505,13 +535,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /capture: post: + tags: + - Modifications summary: Captures an authorised payment. description: 'Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, @@ -538,6 +570,9 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -551,8 +586,8 @@ paths: content: application/json: examples: - capture-200: - $ref: '#/components/examples/post-capture-capture-200' + capture: + $ref: '#/components/examples/post-capture-capture' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -560,8 +595,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -569,8 +604,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -590,24 +625,32 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /donate: post: + tags: + - Modifications summary: Creates a payment for the specified donation. description: 'Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment. - For more information, see [Donate](https://docs.adyen.com/online-payments/donate).' - x-addedInVersion: 40 + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) + endpoint under Checkout API instead.' + x-addedInVersion: '40' operationId: post-donate x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -627,8 +670,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -636,8 +679,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -657,13 +700,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /refund: post: + tags: + - Modifications summary: Refunds a captured payment. description: 'Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured @@ -689,6 +734,9 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -702,8 +750,8 @@ paths: content: application/json: examples: - refund-200: - $ref: '#/components/examples/post-refund-refund-200' + refund: + $ref: '#/components/examples/post-refund-refund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -711,8 +759,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -720,8 +768,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -741,21 +789,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /retrieve3ds2Result: post: + tags: + - General summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. - x-addedInVersion: 40 + x-addedInVersion: '40' operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -775,8 +828,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -784,8 +837,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -805,13 +858,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /technicalCancel: post: + tags: + - Modifications summary: Cancels a payment using your custom reference. description: "This endpoint allows you to cancel a payment if you do not have\ \ the PSP reference of the original payment request available.\n\nIn your\ @@ -821,10 +876,13 @@ paths: \ If using a [newer integration](https://docs.adyen.com/online-payments),\ \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ \ endpoint under Checkout API instead." - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -838,8 +896,8 @@ paths: content: application/json: examples: - technicalCancel-200: - $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -847,8 +905,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -856,8 +914,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -877,13 +935,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /voidPendingRefund: post: + tags: + - Modifications summary: Cancels a POS refund request before it has been completed. description: 'This endpoint allows you to cancel the refund request before it has been completed. @@ -896,10 +956,13 @@ paths: For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' - x-addedInVersion: 25 + x-addedInVersion: '25' operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -915,10 +978,10 @@ paths: content: application/json: examples: - voidpendingrefund-pspreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -926,8 +989,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -935,8 +998,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -956,8 +1019,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1651,6 +1714,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2130,19 +2201,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -2368,68 +2426,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2639,12 +2635,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2666,7 +2662,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2674,12 +2670,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2733,7 +2729,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2772,7 +2768,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2783,41 +2779,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2869,12 +2865,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2896,12 +2892,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2941,12 +2937,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2968,7 +2964,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2976,12 +2972,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3026,12 +3022,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3053,7 +3049,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3061,12 +3057,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3519,7 +3515,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3564,7 +3560,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -3575,7 +3571,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3591,7 +3587,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -3602,7 +3598,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3616,7 +3612,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3627,13 +3623,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -3645,7 +3641,7 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -3653,7 +3649,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3663,7 +3659,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3678,14 +3674,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3705,7 +3701,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -3720,7 +3716,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3814,12 +3810,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3835,11 +3831,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3847,30 +3843,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3880,7 +3878,7 @@ components: PaymentRequest3d: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3925,12 +3923,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3946,13 +3944,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3966,7 +3964,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3977,7 +3975,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -3988,12 +3986,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4006,7 +4004,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4021,14 +4019,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4058,7 +4056,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4152,12 +4150,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4173,11 +4171,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4185,30 +4183,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4218,7 +4218,7 @@ components: PaymentRequest3ds2: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4263,12 +4263,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4284,13 +4284,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4304,7 +4304,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4315,7 +4315,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4326,12 +4326,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4341,7 +4341,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4356,14 +4356,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4389,7 +4389,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4483,12 +4483,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4504,11 +4504,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4516,17 +4516,19 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. @@ -4538,14 +4540,14 @@ components: description: The ThreeDS2Token that was returned in the /authorise call. type: string totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4603,7 +4605,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -4693,18 +4695,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -4748,12 +4750,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -4775,7 +4777,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -4783,12 +4785,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4814,6 +4816,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5126,6 +5131,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -5209,7 +5246,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -5224,11 +5261,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -5496,7 +5533,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -5631,12 +5668,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string reference: @@ -5646,7 +5683,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5654,12 +5691,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -5669,13 +5706,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -5722,14 +5759,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -5786,7 +5823,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -5808,7 +5845,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -5827,7 +5864,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -5845,7 +5882,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDS2ResultRequest: @@ -5905,7 +5942,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -5913,7 +5950,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -5960,12 +5997,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -5987,7 +6024,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5995,12 +6032,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -6015,28 +6052,13 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' post-adjustAuthorisation-adjustAuthorisation: summary: Increases or decreases the authorised amount value: @@ -6046,11 +6068,6 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-adjustAuthorisation-adjustAuthorisation-200: - summary: Example response for request 'adjustAuthorisation' - value: - pspReference: 851617892360718D - response: '[adjustAuthorisation-received]' post-authorise-authorise-3d-secure-2: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -6223,11 +6240,6 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-cancelOrRefund-cancelOrRefund-200: - summary: Example response for request 'cancelOrRefund' - value: - pspReference: 851617892359708H - response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6237,11 +6249,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-capture-capture-200: - summary: Example response for request 'capture' - value: - pspReference: 861617892359057J - response: '[capture-received]' post-donate-donate: summary: Create a payment for the specified donation value: @@ -6261,11 +6268,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-refund-refund-200: - summary: Example response for request 'refund' - value: - pspReference: 861617892360059B - response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6273,12 +6275,6 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT pspReference: '9935272408535455' post-technicalCancel-technicalCancel: - summary: Cancel a payment without a PSP reference - value: - originalMerchantReference: YOUR_MERCHANT_REFERENCE - reference: YOUR_MODIFICATION_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-technicalCancel-technicalCancel-200: summary: Example response for request 'technicalCancel' value: pspReference: 881617892361436J @@ -6288,19 +6284,7 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' - post-voidPendingRefund-voidpendingrefund-pspreference-200: - summary: Example response for request 'voidpendingrefund-pspreference' - value: - pspReference: 861617892360062F - response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: - summary: Cancels a POS refund request with tender reference before it has been - completed - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - tenderReference: 5Iw8001176969533005 - uniqueTerminalId: VX820-123456789 - post-voidPendingRefund-voidpendingrefund-tenderreference-200: summary: Example response for request 'voidpendingrefund-tenderreference' value: pspReference: 881617892360409G diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index f46b8075..e30f19fe 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payment/v50 info: @@ -63,6 +63,8 @@ x-groups: paths: /adjustAuthorisation: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for @@ -81,10 +83,13 @@ paths: > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.' - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -98,8 +103,8 @@ paths: content: application/json: examples: - adjustAuthorisation-200: - $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -107,8 +112,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -116,8 +121,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -137,13 +142,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise: post: + tags: + - General summary: Creates a payment authorisation. description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -157,6 +164,9 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -188,8 +198,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -197,8 +207,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -218,13 +228,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3d: post: + tags: + - General summary: Completes a 3D Secure payment authorisation. description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -238,6 +250,9 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +272,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -266,8 +281,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -287,13 +302,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3ds2: post: + tags: + - General summary: Completes a 3D Secure 2 payment authorisation. description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -304,10 +321,13 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' - x-addedInVersion: 37 + x-addedInVersion: '37' operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -327,8 +347,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -336,8 +356,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -357,13 +377,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancel: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only @@ -380,6 +402,9 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -399,8 +424,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -408,8 +433,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -429,13 +454,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancelOrRefund: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: "Cancels a payment if it has not been captured yet, or refunds\ \ it if it has already been captured. This is useful when it is not certain\ @@ -453,6 +480,9 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -466,8 +496,8 @@ paths: content: application/json: examples: - cancelOrRefund-200: - $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -475,8 +505,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -484,8 +514,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -505,13 +535,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /capture: post: + tags: + - Modifications summary: Captures an authorised payment. description: 'Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, @@ -538,6 +570,9 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -551,8 +586,8 @@ paths: content: application/json: examples: - capture-200: - $ref: '#/components/examples/post-capture-capture-200' + capture: + $ref: '#/components/examples/post-capture-capture' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -560,8 +595,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -569,8 +604,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -590,24 +625,32 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /donate: post: + tags: + - Modifications summary: Creates a payment for the specified donation. description: 'Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment. - For more information, see [Donate](https://docs.adyen.com/online-payments/donate).' - x-addedInVersion: 40 + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) + endpoint under Checkout API instead.' + x-addedInVersion: '40' operationId: post-donate x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -627,8 +670,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -636,8 +679,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -657,13 +700,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /refund: post: + tags: + - Modifications summary: Refunds a captured payment. description: 'Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured @@ -689,6 +734,9 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -702,8 +750,8 @@ paths: content: application/json: examples: - refund-200: - $ref: '#/components/examples/post-refund-refund-200' + refund: + $ref: '#/components/examples/post-refund-refund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -711,8 +759,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -720,8 +768,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -741,21 +789,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /retrieve3ds2Result: post: + tags: + - General summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. - x-addedInVersion: 40 + x-addedInVersion: '40' operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -775,8 +828,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -784,8 +837,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -805,13 +858,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /technicalCancel: post: + tags: + - Modifications summary: Cancels a payment using your custom reference. description: "This endpoint allows you to cancel a payment if you do not have\ \ the PSP reference of the original payment request available.\n\nIn your\ @@ -821,10 +876,13 @@ paths: \ If using a [newer integration](https://docs.adyen.com/online-payments),\ \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ \ endpoint under Checkout API instead." - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -838,8 +896,8 @@ paths: content: application/json: examples: - technicalCancel-200: - $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -847,8 +905,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -856,8 +914,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -877,13 +935,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /voidPendingRefund: post: + tags: + - Modifications summary: Cancels a POS refund request before it has been completed. description: 'This endpoint allows you to cancel the refund request before it has been completed. @@ -896,10 +956,13 @@ paths: For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' - x-addedInVersion: 25 + x-addedInVersion: '25' operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -915,10 +978,10 @@ paths: content: application/json: examples: - voidpendingrefund-pspreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -926,8 +989,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -935,8 +998,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -956,8 +1019,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1015,7 +1078,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -1668,6 +1731,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2147,19 +2218,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -2385,68 +2443,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2656,12 +2652,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2683,7 +2679,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2691,12 +2687,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2750,7 +2746,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2789,7 +2785,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2800,41 +2796,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2886,12 +2882,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2913,12 +2909,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2958,12 +2954,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2985,7 +2981,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2993,12 +2989,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3043,12 +3039,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3070,7 +3066,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3078,12 +3074,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3536,7 +3532,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3581,7 +3577,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -3592,7 +3588,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3608,7 +3604,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -3619,7 +3615,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3633,7 +3629,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3644,13 +3640,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -3662,7 +3658,7 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -3670,7 +3666,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3680,7 +3676,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3695,14 +3691,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3722,7 +3718,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -3737,7 +3733,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3831,12 +3827,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3852,11 +3848,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3864,36 +3860,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3903,7 +3901,7 @@ components: PaymentRequest3d: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3948,12 +3946,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3969,13 +3967,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3989,7 +3987,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4000,7 +3998,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4011,12 +4009,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4029,7 +4027,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4044,14 +4042,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4081,7 +4079,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4175,12 +4173,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4196,11 +4194,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4208,36 +4206,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4247,7 +4247,7 @@ components: PaymentRequest3ds2: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4292,12 +4292,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4313,13 +4313,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4333,7 +4333,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4344,7 +4344,7 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 @@ -4355,12 +4355,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4370,7 +4370,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4385,14 +4385,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4418,7 +4418,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4512,12 +4512,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4533,11 +4533,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4545,17 +4545,19 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. @@ -4567,20 +4569,20 @@ components: description: The ThreeDS2Token that was returned in the /authorise call. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4638,7 +4640,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -4728,18 +4730,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -4783,12 +4785,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -4810,7 +4812,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -4818,12 +4820,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4849,6 +4851,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5161,6 +5166,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -5244,7 +5281,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -5259,11 +5296,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -5531,7 +5568,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -5666,12 +5703,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string reference: @@ -5681,7 +5718,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5689,12 +5726,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -5704,13 +5741,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -5718,7 +5755,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -5760,14 +5797,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -5824,7 +5861,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -5846,7 +5883,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -5856,7 +5893,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -5869,7 +5906,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -5880,7 +5917,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -5898,7 +5935,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDS2ResultRequest: @@ -5958,7 +5995,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -5966,7 +6003,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -6013,12 +6050,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -6040,7 +6077,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -6048,12 +6085,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -6068,28 +6105,13 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' post-adjustAuthorisation-adjustAuthorisation: summary: Increases or decreases the authorised amount value: @@ -6099,11 +6121,6 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-adjustAuthorisation-adjustAuthorisation-200: - summary: Example response for request 'adjustAuthorisation' - value: - pspReference: 851617892360718D - response: '[adjustAuthorisation-received]' post-authorise-authorise-3d-secure-2: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -6276,11 +6293,6 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-cancelOrRefund-cancelOrRefund-200: - summary: Example response for request 'cancelOrRefund' - value: - pspReference: 851617892359708H - response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6290,11 +6302,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-capture-capture-200: - summary: Example response for request 'capture' - value: - pspReference: 861617892359057J - response: '[capture-received]' post-donate-donate: summary: Create a payment for the specified donation value: @@ -6314,11 +6321,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-refund-refund-200: - summary: Example response for request 'refund' - value: - pspReference: 861617892360059B - response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6326,12 +6328,6 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT pspReference: '9935272408535455' post-technicalCancel-technicalCancel: - summary: Cancel a payment without a PSP reference - value: - originalMerchantReference: YOUR_MERCHANT_REFERENCE - reference: YOUR_MODIFICATION_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-technicalCancel-technicalCancel-200: summary: Example response for request 'technicalCancel' value: pspReference: 881617892361436J @@ -6341,19 +6337,7 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' - post-voidPendingRefund-voidpendingrefund-pspreference-200: - summary: Example response for request 'voidpendingrefund-pspreference' - value: - pspReference: 861617892360062F - response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: - summary: Cancels a POS refund request with tender reference before it has been - completed - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - tenderReference: 5Iw8001176969533005 - uniqueTerminalId: VX820-123456789 - post-voidPendingRefund-voidpendingrefund-tenderreference-200: summary: Example response for request 'voidpendingrefund-tenderreference' value: pspReference: 881617892360409G diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index 1fdc5193..88bf6bc5 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payment/v51 info: @@ -63,6 +63,8 @@ x-groups: paths: /adjustAuthorisation: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for @@ -81,10 +83,13 @@ paths: > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.' - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -98,8 +103,8 @@ paths: content: application/json: examples: - adjustAuthorisation-200: - $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -107,8 +112,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -116,8 +121,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -137,13 +142,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise: post: + tags: + - General summary: Creates a payment authorisation. description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -157,6 +164,9 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -188,8 +198,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -197,8 +207,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -218,13 +228,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3d: post: + tags: + - General summary: Completes a 3D Secure payment authorisation. description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -238,6 +250,9 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +272,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -266,8 +281,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -287,13 +302,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3ds2: post: + tags: + - General summary: Completes a 3D Secure 2 payment authorisation. description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -304,10 +321,13 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' - x-addedInVersion: 37 + x-addedInVersion: '37' operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -327,8 +347,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -336,8 +356,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -357,13 +377,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancel: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only @@ -380,6 +402,9 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -399,8 +424,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -408,8 +433,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -429,13 +454,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancelOrRefund: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: "Cancels a payment if it has not been captured yet, or refunds\ \ it if it has already been captured. This is useful when it is not certain\ @@ -453,6 +480,9 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -466,8 +496,8 @@ paths: content: application/json: examples: - cancelOrRefund-200: - $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -475,8 +505,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -484,8 +514,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -505,13 +535,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /capture: post: + tags: + - Modifications summary: Captures an authorised payment. description: 'Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, @@ -538,6 +570,9 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -551,8 +586,8 @@ paths: content: application/json: examples: - capture-200: - $ref: '#/components/examples/post-capture-capture-200' + capture: + $ref: '#/components/examples/post-capture-capture' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -560,8 +595,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -569,8 +604,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -590,24 +625,32 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /donate: post: + tags: + - Modifications summary: Creates a payment for the specified donation. description: 'Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment. - For more information, see [Donate](https://docs.adyen.com/online-payments/donate).' - x-addedInVersion: 40 + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) + endpoint under Checkout API instead.' + x-addedInVersion: '40' operationId: post-donate x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -627,8 +670,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -636,8 +679,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -657,21 +700,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /getAuthenticationResult: post: + tags: + - General summary: Return the authentication result after doing a 3D Secure authentication only. description: Return the authentication result after doing a 3D Secure authentication only. - x-addedInVersion: 51 + x-addedInVersion: '51' operationId: post-getAuthenticationResult x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -691,8 +739,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -700,8 +748,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -721,13 +769,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /refund: post: + tags: + - Modifications summary: Refunds a captured payment. description: 'Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured @@ -753,6 +803,9 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -766,8 +819,8 @@ paths: content: application/json: examples: - refund-200: - $ref: '#/components/examples/post-refund-refund-200' + refund: + $ref: '#/components/examples/post-refund-refund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -775,8 +828,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -784,8 +837,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -805,21 +858,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /retrieve3ds2Result: post: + tags: + - General summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. - x-addedInVersion: 40 + x-addedInVersion: '40' operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -839,8 +897,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -848,8 +906,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -869,13 +927,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /technicalCancel: post: + tags: + - Modifications summary: Cancels a payment using your custom reference. description: "This endpoint allows you to cancel a payment if you do not have\ \ the PSP reference of the original payment request available.\n\nIn your\ @@ -885,10 +945,13 @@ paths: \ If using a [newer integration](https://docs.adyen.com/online-payments),\ \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ \ endpoint under Checkout API instead." - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -902,8 +965,8 @@ paths: content: application/json: examples: - technicalCancel-200: - $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -911,8 +974,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -920,8 +983,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -941,13 +1004,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /voidPendingRefund: post: + tags: + - Modifications summary: Cancels a POS refund request before it has been completed. description: 'This endpoint allows you to cancel the refund request before it has been completed. @@ -960,10 +1025,13 @@ paths: For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' - x-addedInVersion: 25 + x-addedInVersion: '25' operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -979,10 +1047,10 @@ paths: content: application/json: examples: - voidpendingrefund-pspreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -990,8 +1058,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -999,8 +1067,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1020,8 +1088,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1079,7 +1147,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -1732,6 +1800,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2211,19 +2287,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -2449,68 +2512,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2720,12 +2721,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2747,7 +2748,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2755,12 +2756,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2834,7 +2835,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2873,7 +2874,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2884,41 +2885,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2970,12 +2971,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2997,12 +2998,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3042,12 +3043,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3069,7 +3070,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3077,12 +3078,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3127,12 +3128,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3154,7 +3155,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3162,12 +3163,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3620,7 +3621,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3665,7 +3666,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -3676,7 +3677,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3692,7 +3693,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -3703,7 +3704,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3717,7 +3718,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3728,19 +3729,19 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -3752,7 +3753,7 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -3760,7 +3761,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3770,7 +3771,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3785,14 +3786,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3812,7 +3813,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -3827,7 +3828,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3921,12 +3922,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3942,11 +3943,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3954,36 +3955,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3993,7 +3996,7 @@ components: PaymentRequest3d: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4038,12 +4041,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4059,13 +4062,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4079,7 +4082,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4090,13 +4093,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4107,12 +4110,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4125,7 +4128,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4140,14 +4143,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4177,7 +4180,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4271,12 +4274,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4292,11 +4295,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4304,36 +4307,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4343,7 +4348,7 @@ components: PaymentRequest3ds2: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4388,12 +4393,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4409,13 +4414,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4429,7 +4434,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4440,13 +4445,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4457,12 +4462,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4472,7 +4477,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4487,14 +4492,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4520,7 +4525,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4614,12 +4619,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4635,11 +4640,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4647,17 +4652,19 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. @@ -4669,20 +4676,20 @@ components: description: The ThreeDS2Token that was returned in the /authorise call. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4740,7 +4747,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -4830,18 +4837,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -4885,12 +4892,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -4912,7 +4919,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -4920,12 +4927,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4951,6 +4958,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5263,6 +5273,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -5346,7 +5388,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -5361,11 +5403,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -5633,7 +5675,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -5768,12 +5810,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string reference: @@ -5783,7 +5825,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5791,12 +5833,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -5827,13 +5869,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -5841,7 +5883,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -5883,14 +5925,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -5947,7 +5989,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -5969,7 +6011,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -5979,7 +6021,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -5992,7 +6034,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -6003,7 +6045,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -6021,7 +6063,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDS2ResultRequest: @@ -6081,7 +6123,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -6089,7 +6131,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -6136,12 +6178,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -6163,7 +6205,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -6171,12 +6213,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -6191,28 +6233,13 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' post-adjustAuthorisation-adjustAuthorisation: summary: Increases or decreases the authorised amount value: @@ -6222,11 +6249,6 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-adjustAuthorisation-adjustAuthorisation-200: - summary: Example response for request 'adjustAuthorisation' - value: - pspReference: 851617892360718D - response: '[adjustAuthorisation-received]' post-authorise-authorise-3d-secure-2: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -6399,11 +6421,6 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-cancelOrRefund-cancelOrRefund-200: - summary: Example response for request 'cancelOrRefund' - value: - pspReference: 851617892359708H - response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6413,11 +6430,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-capture-capture-200: - summary: Example response for request 'capture' - value: - pspReference: 861617892359057J - response: '[capture-received]' post-donate-donate: summary: Create a payment for the specified donation value: @@ -6443,11 +6455,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-refund-refund-200: - summary: Example response for request 'refund' - value: - pspReference: 861617892360059B - response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6455,12 +6462,6 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT pspReference: '9935272408535455' post-technicalCancel-technicalCancel: - summary: Cancel a payment without a PSP reference - value: - originalMerchantReference: YOUR_MERCHANT_REFERENCE - reference: YOUR_MODIFICATION_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-technicalCancel-technicalCancel-200: summary: Example response for request 'technicalCancel' value: pspReference: 881617892361436J @@ -6470,19 +6471,7 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' - post-voidPendingRefund-voidpendingrefund-pspreference-200: - summary: Example response for request 'voidpendingrefund-pspreference' - value: - pspReference: 861617892360062F - response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: - summary: Cancels a POS refund request with tender reference before it has been - completed - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - tenderReference: 5Iw8001176969533005 - uniqueTerminalId: VX820-123456789 - post-voidPendingRefund-voidpendingrefund-tenderreference-200: summary: Example response for request 'voidpendingrefund-tenderreference' value: pspReference: 881617892360409G diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index eae40be3..47f098f1 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payment/v52 info: @@ -63,6 +63,8 @@ x-groups: paths: /adjustAuthorisation: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for @@ -81,10 +83,13 @@ paths: > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.' - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -98,8 +103,8 @@ paths: content: application/json: examples: - adjustAuthorisation-200: - $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -107,8 +112,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -116,8 +121,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -137,13 +142,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise: post: + tags: + - General summary: Creates a payment authorisation. description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -157,6 +164,9 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -188,8 +198,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -197,8 +207,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -218,13 +228,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3d: post: + tags: + - General summary: Completes a 3D Secure payment authorisation. description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -238,6 +250,9 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +272,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -266,8 +281,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -287,13 +302,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3ds2: post: + tags: + - General summary: Completes a 3D Secure 2 payment authorisation. description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -304,10 +321,13 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' - x-addedInVersion: 37 + x-addedInVersion: '37' operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -327,8 +347,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -336,8 +356,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -357,13 +377,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancel: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only @@ -380,6 +402,9 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -399,8 +424,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -408,8 +433,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -429,13 +454,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancelOrRefund: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: "Cancels a payment if it has not been captured yet, or refunds\ \ it if it has already been captured. This is useful when it is not certain\ @@ -453,6 +480,9 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -466,8 +496,8 @@ paths: content: application/json: examples: - cancelOrRefund-200: - $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -475,8 +505,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -484,8 +514,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -505,13 +535,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /capture: post: + tags: + - Modifications summary: Captures an authorised payment. description: 'Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, @@ -538,6 +570,9 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -551,8 +586,8 @@ paths: content: application/json: examples: - capture-200: - $ref: '#/components/examples/post-capture-capture-200' + capture: + $ref: '#/components/examples/post-capture-capture' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -560,8 +595,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -569,8 +604,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -590,24 +625,32 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /donate: post: + tags: + - Modifications summary: Creates a payment for the specified donation. description: 'Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment. - For more information, see [Donate](https://docs.adyen.com/online-payments/donate).' - x-addedInVersion: 40 + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) + endpoint under Checkout API instead.' + x-addedInVersion: '40' operationId: post-donate x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -627,8 +670,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -636,8 +679,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -657,21 +700,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /getAuthenticationResult: post: + tags: + - General summary: Return the authentication result after doing a 3D Secure authentication only. description: Return the authentication result after doing a 3D Secure authentication only. - x-addedInVersion: 51 + x-addedInVersion: '51' operationId: post-getAuthenticationResult x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -691,8 +739,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -700,8 +748,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -721,13 +769,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /refund: post: + tags: + - Modifications summary: Refunds a captured payment. description: 'Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured @@ -753,6 +803,9 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -766,8 +819,8 @@ paths: content: application/json: examples: - refund-200: - $ref: '#/components/examples/post-refund-refund-200' + refund: + $ref: '#/components/examples/post-refund-refund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -775,8 +828,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -784,8 +837,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -805,21 +858,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /retrieve3ds2Result: post: + tags: + - General summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. - x-addedInVersion: 40 + x-addedInVersion: '40' operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -839,8 +897,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -848,8 +906,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -869,13 +927,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /technicalCancel: post: + tags: + - Modifications summary: Cancels a payment using your custom reference. description: "This endpoint allows you to cancel a payment if you do not have\ \ the PSP reference of the original payment request available.\n\nIn your\ @@ -885,10 +945,13 @@ paths: \ If using a [newer integration](https://docs.adyen.com/online-payments),\ \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ \ endpoint under Checkout API instead." - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -902,8 +965,8 @@ paths: content: application/json: examples: - technicalCancel-200: - $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -911,8 +974,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -920,8 +983,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -941,13 +1004,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /voidPendingRefund: post: + tags: + - Modifications summary: Cancels a POS refund request before it has been completed. description: 'This endpoint allows you to cancel the refund request before it has been completed. @@ -960,10 +1025,13 @@ paths: For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' - x-addedInVersion: 25 + x-addedInVersion: '25' operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -979,10 +1047,10 @@ paths: content: application/json: examples: - voidpendingrefund-pspreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -990,8 +1058,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -999,8 +1067,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1020,8 +1088,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1079,7 +1147,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -1732,6 +1800,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2211,19 +2287,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -2449,68 +2512,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2720,12 +2721,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2747,7 +2748,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2755,12 +2756,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2834,7 +2835,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2873,7 +2874,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2884,41 +2885,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2970,12 +2971,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2997,12 +2998,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3042,12 +3043,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3069,7 +3070,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3077,12 +3078,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3127,12 +3128,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3154,7 +3155,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3162,12 +3163,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3620,7 +3621,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3665,7 +3666,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -3676,7 +3677,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3692,7 +3693,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -3703,7 +3704,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3717,7 +3718,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3728,19 +3729,19 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -3752,7 +3753,7 @@ components: format: int32 type: integer fundingSource: - x-addedInVersion: 52 + x-addedInVersion: '52' description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. @@ -3760,7 +3761,7 @@ components: - debit type: string installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -3768,7 +3769,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3778,7 +3779,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3793,14 +3794,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3820,7 +3821,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -3835,7 +3836,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3929,12 +3930,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3950,11 +3951,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3962,36 +3963,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4001,7 +4004,7 @@ components: PaymentRequest3d: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4046,12 +4049,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4067,13 +4070,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4087,7 +4090,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4098,13 +4101,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4115,12 +4118,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4133,7 +4136,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4148,14 +4151,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4185,7 +4188,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4279,12 +4282,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4300,11 +4303,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4312,36 +4315,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4351,7 +4356,7 @@ components: PaymentRequest3ds2: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4396,12 +4401,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4417,13 +4422,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4437,7 +4442,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4448,13 +4453,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4465,12 +4470,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4480,7 +4485,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4495,14 +4500,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4528,7 +4533,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4622,12 +4627,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4643,11 +4648,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4655,17 +4660,19 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. @@ -4677,20 +4684,20 @@ components: description: The ThreeDS2Token that was returned in the /authorise call. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4748,7 +4755,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -4838,18 +4845,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -4893,12 +4900,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -4920,7 +4927,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -4928,12 +4935,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4959,6 +4966,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5271,6 +5281,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -5354,7 +5396,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -5369,11 +5411,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -5641,7 +5683,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -5776,12 +5818,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string reference: @@ -5791,7 +5833,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5799,12 +5841,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -5835,13 +5877,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -5849,7 +5891,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -5891,14 +5933,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -5955,7 +5997,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -5977,7 +6019,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -5987,7 +6029,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -6000,7 +6042,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -6011,7 +6053,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -6029,7 +6071,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDS2ResultRequest: @@ -6089,7 +6131,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -6097,7 +6139,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -6144,12 +6186,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -6171,7 +6213,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -6179,12 +6221,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -6199,28 +6241,13 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' post-adjustAuthorisation-adjustAuthorisation: summary: Increases or decreases the authorised amount value: @@ -6230,11 +6257,6 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-adjustAuthorisation-adjustAuthorisation-200: - summary: Example response for request 'adjustAuthorisation' - value: - pspReference: 851617892360718D - response: '[adjustAuthorisation-received]' post-authorise-authorise-3d-secure-2: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -6407,11 +6429,6 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-cancelOrRefund-cancelOrRefund-200: - summary: Example response for request 'cancelOrRefund' - value: - pspReference: 851617892359708H - response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6421,11 +6438,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-capture-capture-200: - summary: Example response for request 'capture' - value: - pspReference: 861617892359057J - response: '[capture-received]' post-donate-donate: summary: Create a payment for the specified donation value: @@ -6451,11 +6463,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-refund-refund-200: - summary: Example response for request 'refund' - value: - pspReference: 861617892360059B - response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6463,12 +6470,6 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT pspReference: '9935272408535455' post-technicalCancel-technicalCancel: - summary: Cancel a payment without a PSP reference - value: - originalMerchantReference: YOUR_MERCHANT_REFERENCE - reference: YOUR_MODIFICATION_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-technicalCancel-technicalCancel-200: summary: Example response for request 'technicalCancel' value: pspReference: 881617892361436J @@ -6478,19 +6479,7 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' - post-voidPendingRefund-voidpendingrefund-pspreference-200: - summary: Example response for request 'voidpendingrefund-pspreference' - value: - pspReference: 861617892360062F - response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: - summary: Cancels a POS refund request with tender reference before it has been - completed - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - tenderReference: 5Iw8001176969533005 - uniqueTerminalId: VX820-123456789 - post-voidPendingRefund-voidpendingrefund-tenderreference-200: summary: Example response for request 'voidpendingrefund-tenderreference' value: pspReference: 881617892360409G diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index 0728d70f..81c2d3e2 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payment/v64 info: @@ -63,6 +63,8 @@ x-groups: paths: /adjustAuthorisation: post: + tags: + - Modifications summary: Increases or decreases the authorised amount. description: 'Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for @@ -81,10 +83,13 @@ paths: > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.' - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -98,8 +103,8 @@ paths: content: application/json: examples: - adjustAuthorisation-200: - $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -107,8 +112,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -116,8 +121,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -137,13 +142,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise: post: + tags: + - General summary: Creates a payment authorisation. description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -157,6 +164,9 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -188,8 +198,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -197,8 +207,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -218,13 +228,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3d: post: + tags: + - General summary: Completes a 3D Secure payment authorisation. description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -238,6 +250,9 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +272,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -266,8 +281,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -287,13 +302,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /authorise3ds2: post: + tags: + - General summary: Completes a 3D Secure 2 payment authorisation. description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -304,10 +321,13 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' - x-addedInVersion: 37 + x-addedInVersion: '37' operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -327,8 +347,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -336,8 +356,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -357,13 +377,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancel: post: + tags: + - Modifications summary: Cancels an authorised payment. description: 'Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only @@ -380,6 +402,9 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -399,8 +424,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -408,8 +433,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -429,13 +454,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /cancelOrRefund: post: + tags: + - Modifications summary: Cancels or refunds a payment. description: "Cancels a payment if it has not been captured yet, or refunds\ \ it if it has already been captured. This is useful when it is not certain\ @@ -453,6 +480,9 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -466,8 +496,8 @@ paths: content: application/json: examples: - cancelOrRefund-200: - $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -475,8 +505,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -484,8 +514,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -505,13 +535,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /capture: post: + tags: + - Modifications summary: Captures an authorised payment. description: 'Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, @@ -538,6 +570,9 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -551,8 +586,8 @@ paths: content: application/json: examples: - capture-200: - $ref: '#/components/examples/post-capture-capture-200' + capture: + $ref: '#/components/examples/post-capture-capture' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -560,8 +595,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -569,8 +604,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -590,24 +625,32 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /donate: post: + tags: + - Modifications summary: Creates a payment for the specified donation. description: 'Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment. - For more information, see [Donate](https://docs.adyen.com/online-payments/donate).' - x-addedInVersion: 40 + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) + endpoint under Checkout API instead.' + x-addedInVersion: '40' operationId: post-donate x-groupName: Modifications x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -627,8 +670,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -636,8 +679,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -657,21 +700,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /getAuthenticationResult: post: + tags: + - General summary: Return the authentication result after doing a 3D Secure authentication only. description: Return the authentication result after doing a 3D Secure authentication only. - x-addedInVersion: 51 + x-addedInVersion: '51' operationId: post-getAuthenticationResult x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -691,8 +739,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -700,8 +748,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -721,13 +769,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /refund: post: + tags: + - Modifications summary: Refunds a captured payment. description: 'Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured @@ -753,6 +803,9 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -766,8 +819,8 @@ paths: content: application/json: examples: - refund-200: - $ref: '#/components/examples/post-refund-refund-200' + refund: + $ref: '#/components/examples/post-refund-refund' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -775,8 +828,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -784,8 +837,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -805,21 +858,26 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /retrieve3ds2Result: post: + tags: + - General summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. - x-addedInVersion: 40 + x-addedInVersion: '40' operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -839,8 +897,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -848,8 +906,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -869,13 +927,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /technicalCancel: post: + tags: + - Modifications summary: Cancels a payment using your custom reference. description: "This endpoint allows you to cancel a payment if you do not have\ \ the PSP reference of the original payment request available.\n\nIn your\ @@ -885,10 +945,13 @@ paths: \ If using a [newer integration](https://docs.adyen.com/online-payments),\ \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ \ endpoint under Checkout API instead." - x-addedInVersion: 30 + x-addedInVersion: '30' operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -902,8 +965,8 @@ paths: content: application/json: examples: - technicalCancel-200: - $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -911,8 +974,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -920,8 +983,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -941,13 +1004,15 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. /voidPendingRefund: post: + tags: + - Modifications summary: Cancels a POS refund request before it has been completed. description: 'This endpoint allows you to cancel the refund request before it has been completed. @@ -960,10 +1025,13 @@ paths: For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' - x-addedInVersion: 25 + x-addedInVersion: '25' operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -979,10 +1047,10 @@ paths: content: application/json: examples: - voidpendingrefund-pspreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -990,8 +1058,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -999,8 +1067,8 @@ paths: content: application/json: examples: - generic-401: - $ref: '#/components/examples/generic-401' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -1020,8 +1088,8 @@ paths: content: application/json: examples: - generic-500: - $ref: '#/components/examples/generic-500' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1079,7 +1147,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -1732,6 +1800,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2211,19 +2287,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -2449,68 +2512,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2720,12 +2721,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2747,7 +2748,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -2755,12 +2756,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -2834,7 +2835,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2873,7 +2874,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2884,41 +2885,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2970,12 +2971,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -2997,12 +2998,12 @@ components: Maximum length: 80 characters.' type: string tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3042,12 +3043,12 @@ components: description: The merchant account that is used to process the payment. type: string mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3069,7 +3070,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3077,12 +3078,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3127,12 +3128,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -3154,7 +3155,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -3162,12 +3163,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -3416,7 +3417,7 @@ components: Installments: properties: plan: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -3635,7 +3636,7 @@ components: PaymentRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -3680,7 +3681,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -3691,7 +3692,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -3707,7 +3708,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -3718,7 +3719,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -3732,7 +3733,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -3743,19 +3744,19 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -3767,7 +3768,7 @@ components: format: int32 type: integer fundingSource: - x-addedInVersion: 52 + x-addedInVersion: '52' description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. @@ -3775,7 +3776,7 @@ components: - debit type: string installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -3783,7 +3784,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -3793,7 +3794,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -3808,14 +3809,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -3835,7 +3836,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -3850,7 +3851,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -3944,12 +3945,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3965,11 +3966,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3977,36 +3978,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4016,7 +4019,7 @@ components: PaymentRequest3d: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4061,12 +4064,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4082,13 +4085,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4102,7 +4105,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4113,13 +4116,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4130,12 +4133,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4148,7 +4151,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4163,14 +4166,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4200,7 +4203,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4294,12 +4297,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4315,11 +4318,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4327,36 +4330,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4366,7 +4371,7 @@ components: PaymentRequest3ds2: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -4411,12 +4416,12 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -4432,13 +4437,13 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -4452,7 +4457,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -4463,13 +4468,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. @@ -4480,12 +4485,12 @@ components: format: int32 type: integer installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -4495,7 +4500,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -4510,14 +4515,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -4543,7 +4548,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -4637,12 +4642,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -4658,11 +4663,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -4670,17 +4675,19 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. @@ -4692,20 +4699,20 @@ components: description: The ThreeDS2Token that was returned in the /authorise call. type: string threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -4763,7 +4770,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -4853,18 +4860,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -4908,12 +4915,12 @@ components: equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -4935,7 +4942,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -4943,12 +4950,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -4974,6 +4981,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5286,6 +5296,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -5369,7 +5411,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -5384,11 +5426,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -5656,7 +5698,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -5791,12 +5833,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string reference: @@ -5806,7 +5848,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -5814,12 +5856,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -5850,13 +5892,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -5864,7 +5906,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -5906,14 +5948,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -5970,7 +6012,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -5992,7 +6034,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -6002,7 +6044,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -6015,7 +6057,7 @@ components: 2 specification. type: string cavvAlgorithm: - x-addedInVersion: 50 + x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations. type: string @@ -6026,7 +6068,7 @@ components: description: The `eci` value as defined in the 3D Secure 2 specification. type: string messageVersion: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `messageVersion` value as defined in the 3D Secure 2 specification. type: string threeDSServerTransID: @@ -6044,7 +6086,7 @@ components: specification. type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string ThreeDS2ResultRequest: @@ -6104,7 +6146,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -6112,7 +6154,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -6159,12 +6201,12 @@ components: than or equal to the authorised amount. $ref: '#/components/schemas/Amount' mpiData: - x-addedInVersion: 46 + x-addedInVersion: '46' description: Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: - x-addedInVersion: 30 + x-addedInVersion: '30' description: The original merchant reference to cancel. type: string originalReference: @@ -6186,7 +6228,7 @@ components: Maximum length: 80 characters.' type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). @@ -6194,12 +6236,12 @@ components: $ref: '#/components/schemas/Split' type: array tenderReference: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The transaction reference provided by the PED. For point-of-sale integrations only. type: string uniqueTerminalId: - x-addedInVersion: 25 + x-addedInVersion: '25' description: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. type: string @@ -6214,28 +6256,13 @@ components: scheme: basic type: http examples: - generic-400: - summary: Response code 400. Bad request. - value: - status: 400 - errorCode: '702' - message: 'Unexpected input: ", expected: }' - errorType: validation - generic-401: + generic: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security - generic-500: - summary: Response code 500. Internal server error. - value: - status: 500 - errorCode: '905' - message: Payment details are not supported - errorType: configuration - pspReference: '8516091485743033' post-adjustAuthorisation-adjustAuthorisation: summary: Increases or decreases the authorised amount value: @@ -6245,11 +6272,6 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-adjustAuthorisation-adjustAuthorisation-200: - summary: Example response for request 'adjustAuthorisation' - value: - pspReference: 851617892360718D - response: '[adjustAuthorisation-received]' post-authorise-authorise-3d-secure-2: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -6422,11 +6444,6 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-cancelOrRefund-cancelOrRefund-200: - summary: Example response for request 'cancelOrRefund' - value: - pspReference: 851617892359708H - response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6436,11 +6453,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-capture-capture-200: - summary: Example response for request 'capture' - value: - pspReference: 861617892359057J - response: '[capture-received]' post-donate-donate: summary: Create a payment for the specified donation value: @@ -6466,11 +6478,6 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-refund-refund-200: - summary: Example response for request 'refund' - value: - pspReference: 861617892360059B - response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6478,12 +6485,6 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT pspReference: '9935272408535455' post-technicalCancel-technicalCancel: - summary: Cancel a payment without a PSP reference - value: - originalMerchantReference: YOUR_MERCHANT_REFERENCE - reference: YOUR_MODIFICATION_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-technicalCancel-technicalCancel-200: summary: Example response for request 'technicalCancel' value: pspReference: 881617892361436J @@ -6493,19 +6494,7 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' - post-voidPendingRefund-voidpendingrefund-pspreference-200: - summary: Example response for request 'voidpendingrefund-pspreference' - value: - pspReference: 861617892360062F - response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: - summary: Cancels a POS refund request with tender reference before it has been - completed - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - tenderReference: 5Iw8001176969533005 - uniqueTerminalId: VX820-123456789 - post-voidPendingRefund-voidpendingrefund-tenderreference-200: summary: Example response for request 'voidpendingrefund-tenderreference' value: pspReference: 881617892360409G diff --git a/yaml/PayoutService-v30.yaml b/yaml/PayoutService-v30.yaml index 483c3f85..1569e09b 100644 --- a/yaml/PayoutService-v30.yaml +++ b/yaml/PayoutService-v30.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payout/v30 info: @@ -52,15 +52,20 @@ x-groups: paths: /confirmThirdParty: post: + tags: + - Reviewing summary: Confirms a payout. description: 'Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-confirmThirdParty x-groupName: Reviewing x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -74,8 +79,8 @@ paths: content: application/json: examples: - confirmThirdParty-200: - $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -83,8 +88,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -114,15 +119,20 @@ paths: description: Internal Server Error - the server could not process the request. /declineThirdParty: post: + tags: + - Reviewing summary: Cancels a payout. description: 'Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-declineThirdParty x-groupName: Reviewing x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -136,8 +146,8 @@ paths: content: application/json: examples: - declineThirdParty-200: - $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -145,8 +155,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -176,15 +186,20 @@ paths: description: Internal Server Error - the server could not process the request. /payout: post: + tags: + - Instant payouts summary: Pay out directly. description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards. - x-addedInVersion: 11 + x-addedInVersion: '11' operationId: post-payout x-groupName: Instant payouts x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -206,8 +221,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -237,6 +252,8 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetail: post: + tags: + - Initialization summary: Stores payout details. description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` @@ -244,6 +261,9 @@ paths: operationId: post-storeDetail x-groupName: Initialization x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +277,8 @@ paths: content: application/json: examples: - storeDetail-200: - $ref: '#/components/examples/post-storeDetail-storeDetail-200' + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -266,8 +286,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -297,16 +317,21 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetailAndSubmitThirdParty: post: + tags: + - Initialization summary: Stores details and submits a payout. description: 'Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-storeDetailAndSubmitThirdParty x-groupName: Initialization x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -334,8 +359,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -365,6 +390,8 @@ paths: description: Internal Server Error - the server could not process the request. /submitThirdParty: post: + tags: + - Initialization summary: Submits a payout. description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -372,10 +399,13 @@ paths: The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-submitThirdParty x-groupName: Initialization x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -395,8 +425,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -958,6 +988,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1431,19 +1469,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -1669,68 +1694,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -1922,7 +1885,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -1961,7 +1924,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2318,7 +2281,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -2334,7 +2297,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -2345,7 +2308,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -2359,7 +2322,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -2370,13 +2333,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -2391,7 +2354,7 @@ components: description: The person or entity funding the money. $ref: '#/components/schemas/FundSource' installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -2399,7 +2362,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -2409,7 +2372,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -2424,7 +2387,7 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -2444,7 +2407,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -2459,7 +2422,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -2553,12 +2516,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -2574,21 +2537,23 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 @@ -2649,7 +2614,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -2739,7 +2704,7 @@ components: description: A descriptive name for this detail. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -2763,6 +2728,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -3075,6 +3043,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -3448,7 +3448,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -3457,7 +3457,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -3469,7 +3469,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -3485,7 +3485,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -3504,7 +3504,7 @@ components: Although it is a good idea to make sure it is unique, this is not a requirement. type: string selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -3514,7 +3514,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -3525,13 +3525,13 @@ components: description: The shopper's reference for the payment transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -3583,7 +3583,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -3592,7 +3592,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -3604,7 +3604,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -3620,7 +3620,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -3634,7 +3634,7 @@ components: The recurring.contract must be set to `PAYOUT`' $ref: '#/components/schemas/Recurring' selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -3644,7 +3644,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -3655,7 +3655,7 @@ components: description: The shopper's reference for the payment transaction. type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -3701,7 +3701,7 @@ components: transaction. $ref: '#/components/schemas/Amount' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\ \nFor Paysafecard it must be the same as used when registering the Paysafecard\ \ account.\n\n> This field is mandatory for natural persons. \n> This\ @@ -3710,7 +3710,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The type of the entity the payout is processed for. @@ -3736,7 +3736,7 @@ components: request with. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -3769,7 +3769,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -3784,13 +3784,13 @@ components: description: The shopper's reference for the payout transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -3881,7 +3881,7 @@ components: scheme: basic type: http examples: - generic-400: + generic: summary: Response code 400. Bad Request. value: status: 400 @@ -3894,22 +3894,12 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-confirmThirdParty-confirmThirdParty-200: - summary: Example response for request 'confirmThirdParty' - value: - pspReference: 991617894325358C - response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-declineThirdParty-declineThirdParty-200: - summary: Example response for request 'declineThirdParty' - value: - pspReference: 991617894325360J - response: '[payout-decline-received]' post-payout-payout-b2c: summary: Instant card payout (B2C) description: Pay out to your sellers, customers, freelancers, etc @@ -3972,37 +3962,6 @@ components: dateOfBirth: '1990-01-01' nationality: NL post-storeDetail-storeDetail: - summary: Store payout details - description: Store payment details under the PAYOUT recurring contract - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - bank: - bankName: AbnAmro - bic: ABNANL2A - countryCode: NL - iban: NL32ABNA0515071439 - ownerName: Adyen - bankCity: Amsterdam - taxId: bankTaxId - shopperEmail: shopper@email.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperName: - firstName: Adyen - gender: MALE - lastName: Test - dateOfBirth: '1990-01-01' - entityType: Company - nationality: NL - billingAddress: - houseNumberOrName: '17' - street: Teststreet 1 - city: Amsterdam - stateOrProvince: NY - country: US - postalCode: '12345' - post-storeDetail-storeDetail-200: summary: Example response for request 'storeDetail' value: pspReference: 991617894326362D diff --git a/yaml/PayoutService-v40.yaml b/yaml/PayoutService-v40.yaml index 5cd7c795..7d1db5bf 100644 --- a/yaml/PayoutService-v40.yaml +++ b/yaml/PayoutService-v40.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payout/v40 info: @@ -52,15 +52,20 @@ x-groups: paths: /confirmThirdParty: post: + tags: + - Reviewing summary: Confirms a payout. description: 'Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-confirmThirdParty x-groupName: Reviewing x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -74,8 +79,8 @@ paths: content: application/json: examples: - confirmThirdParty-200: - $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -83,8 +88,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -114,15 +119,20 @@ paths: description: Internal Server Error - the server could not process the request. /declineThirdParty: post: + tags: + - Reviewing summary: Cancels a payout. description: 'Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-declineThirdParty x-groupName: Reviewing x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -136,8 +146,8 @@ paths: content: application/json: examples: - declineThirdParty-200: - $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -145,8 +155,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -176,15 +186,20 @@ paths: description: Internal Server Error - the server could not process the request. /payout: post: + tags: + - Instant payouts summary: Pay out directly. description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards. - x-addedInVersion: 11 + x-addedInVersion: '11' operationId: post-payout x-groupName: Instant payouts x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -206,8 +221,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -237,6 +252,8 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetail: post: + tags: + - Initialization summary: Stores payout details. description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` @@ -244,6 +261,9 @@ paths: operationId: post-storeDetail x-groupName: Initialization x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +277,8 @@ paths: content: application/json: examples: - storeDetail-200: - $ref: '#/components/examples/post-storeDetail-storeDetail-200' + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -266,8 +286,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -297,16 +317,21 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetailAndSubmitThirdParty: post: + tags: + - Initialization summary: Stores details and submits a payout. description: 'Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-storeDetailAndSubmitThirdParty x-groupName: Initialization x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -334,8 +359,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -365,6 +390,8 @@ paths: description: Internal Server Error - the server could not process the request. /submitThirdParty: post: + tags: + - Initialization summary: Submits a payout. description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -372,10 +399,13 @@ paths: The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-submitThirdParty x-groupName: Initialization x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -395,8 +425,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1114,6 +1144,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1587,19 +1625,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -1825,68 +1850,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2104,7 +2067,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2143,7 +2106,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2154,41 +2117,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2652,7 +2615,7 @@ components: PayoutRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -2697,7 +2660,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -2708,7 +2671,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -2724,7 +2687,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -2735,7 +2698,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -2749,7 +2712,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -2760,13 +2723,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -2781,7 +2744,7 @@ components: description: The person or entity funding the money. $ref: '#/components/schemas/FundSource' installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -2789,7 +2752,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -2799,7 +2762,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -2814,14 +2777,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -2841,7 +2804,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -2856,7 +2819,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -2950,12 +2913,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -2971,11 +2934,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -2983,30 +2946,32 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3064,7 +3029,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3154,18 +3119,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -3189,6 +3154,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -3501,6 +3469,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -3584,7 +3584,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -3599,11 +3599,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -3977,7 +3977,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -3986,7 +3986,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -3998,7 +3998,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4014,7 +4014,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4033,7 +4033,7 @@ components: Although it is a good idea to make sure it is unique, this is not a requirement. type: string selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4043,7 +4043,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4054,13 +4054,13 @@ components: description: The shopper's reference for the payment transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4112,7 +4112,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -4121,7 +4121,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -4133,7 +4133,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4149,7 +4149,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4163,7 +4163,7 @@ components: The recurring.contract must be set to `PAYOUT`' $ref: '#/components/schemas/Recurring' selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4173,7 +4173,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4184,7 +4184,7 @@ components: description: The shopper's reference for the payment transaction. type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4230,7 +4230,7 @@ components: transaction. $ref: '#/components/schemas/Amount' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\ \nFor Paysafecard it must be the same as used when registering the Paysafecard\ \ account.\n\n> This field is mandatory for natural persons. \n> This\ @@ -4239,7 +4239,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The type of the entity the payout is processed for. @@ -4265,7 +4265,7 @@ components: request with. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4298,7 +4298,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4313,13 +4313,13 @@ components: description: The shopper's reference for the payout transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4443,7 +4443,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -4506,7 +4506,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -4514,7 +4514,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -4531,7 +4531,7 @@ components: scheme: basic type: http examples: - generic-400: + generic: summary: Response code 400. Bad Request. value: status: 400 @@ -4544,22 +4544,12 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-confirmThirdParty-confirmThirdParty-200: - summary: Example response for request 'confirmThirdParty' - value: - pspReference: 991617894325358C - response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-declineThirdParty-declineThirdParty-200: - summary: Example response for request 'declineThirdParty' - value: - pspReference: 991617894325360J - response: '[payout-decline-received]' post-payout-payout-b2c: summary: Instant card payout (B2C) description: Pay out to your sellers, customers, freelancers, etc @@ -4622,37 +4612,6 @@ components: dateOfBirth: '1990-01-01' nationality: NL post-storeDetail-storeDetail: - summary: Store payout details - description: Store payment details under the PAYOUT recurring contract - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - bank: - bankName: AbnAmro - bic: ABNANL2A - countryCode: NL - iban: NL32ABNA0515071439 - ownerName: Adyen - bankCity: Amsterdam - taxId: bankTaxId - shopperEmail: shopper@email.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperName: - firstName: Adyen - gender: MALE - lastName: Test - dateOfBirth: '1990-01-01' - entityType: Company - nationality: NL - billingAddress: - houseNumberOrName: '17' - street: Teststreet 1 - city: Amsterdam - stateOrProvince: NY - country: US - postalCode: '12345' - post-storeDetail-storeDetail-200: summary: Example response for request 'storeDetail' value: pspReference: 991617894326362D diff --git a/yaml/PayoutService-v50.yaml b/yaml/PayoutService-v50.yaml index 0eb1bcbc..c7082f88 100644 --- a/yaml/PayoutService-v50.yaml +++ b/yaml/PayoutService-v50.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payout/v50 info: @@ -52,15 +52,20 @@ x-groups: paths: /confirmThirdParty: post: + tags: + - Reviewing summary: Confirms a payout. description: 'Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-confirmThirdParty x-groupName: Reviewing x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -74,8 +79,8 @@ paths: content: application/json: examples: - confirmThirdParty-200: - $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -83,8 +88,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -114,15 +119,20 @@ paths: description: Internal Server Error - the server could not process the request. /declineThirdParty: post: + tags: + - Reviewing summary: Cancels a payout. description: 'Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-declineThirdParty x-groupName: Reviewing x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -136,8 +146,8 @@ paths: content: application/json: examples: - declineThirdParty-200: - $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -145,8 +155,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -176,15 +186,20 @@ paths: description: Internal Server Error - the server could not process the request. /payout: post: + tags: + - Instant payouts summary: Pay out directly. description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards. - x-addedInVersion: 11 + x-addedInVersion: '11' operationId: post-payout x-groupName: Instant payouts x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -206,8 +221,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -237,6 +252,8 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetail: post: + tags: + - Initialization summary: Stores payout details. description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` @@ -244,6 +261,9 @@ paths: operationId: post-storeDetail x-groupName: Initialization x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +277,8 @@ paths: content: application/json: examples: - storeDetail-200: - $ref: '#/components/examples/post-storeDetail-storeDetail-200' + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -266,8 +286,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -297,16 +317,21 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetailAndSubmitThirdParty: post: + tags: + - Initialization summary: Stores details and submits a payout. description: 'Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-storeDetailAndSubmitThirdParty x-groupName: Initialization x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -334,8 +359,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -365,6 +390,8 @@ paths: description: Internal Server Error - the server could not process the request. /submitThirdParty: post: + tags: + - Initialization summary: Submits a payout. description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -372,10 +399,13 @@ paths: The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-submitThirdParty x-groupName: Initialization x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -395,8 +425,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,7 +508,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -1131,6 +1161,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1604,19 +1642,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -1842,68 +1867,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2121,7 +2084,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2160,7 +2123,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2171,41 +2134,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2669,7 +2632,7 @@ components: PayoutRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -2714,7 +2677,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -2725,7 +2688,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -2741,7 +2704,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -2752,7 +2715,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -2766,7 +2729,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -2777,13 +2740,13 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -2798,7 +2761,7 @@ components: description: The person or entity funding the money. $ref: '#/components/schemas/FundSource' installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -2806,7 +2769,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -2816,7 +2779,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -2831,14 +2794,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -2858,7 +2821,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -2873,7 +2836,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -2967,12 +2930,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -2988,11 +2951,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3000,36 +2963,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3087,7 +3052,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3177,18 +3142,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -3212,6 +3177,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -3524,6 +3492,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -3607,7 +3607,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -3622,11 +3622,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -3894,7 +3894,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -4008,7 +4008,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -4017,7 +4017,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -4029,7 +4029,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4045,7 +4045,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4064,7 +4064,7 @@ components: Although it is a good idea to make sure it is unique, this is not a requirement. type: string selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4074,7 +4074,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4085,13 +4085,13 @@ components: description: The shopper's reference for the payment transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4143,7 +4143,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -4152,7 +4152,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -4164,7 +4164,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4180,7 +4180,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4194,7 +4194,7 @@ components: The recurring.contract must be set to `PAYOUT`' $ref: '#/components/schemas/Recurring' selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4204,7 +4204,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4215,7 +4215,7 @@ components: description: The shopper's reference for the payment transaction. type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4261,7 +4261,7 @@ components: transaction. $ref: '#/components/schemas/Amount' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\ \nFor Paysafecard it must be the same as used when registering the Paysafecard\ \ account.\n\n> This field is mandatory for natural persons. \n> This\ @@ -4270,7 +4270,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The type of the entity the payout is processed for. @@ -4296,7 +4296,7 @@ components: request with. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4329,7 +4329,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4344,13 +4344,13 @@ components: description: The shopper's reference for the payout transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4388,13 +4388,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -4402,7 +4402,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -4444,14 +4444,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -4508,7 +4508,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -4530,7 +4530,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -4540,7 +4540,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -4586,7 +4586,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -4594,7 +4594,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -4611,7 +4611,7 @@ components: scheme: basic type: http examples: - generic-400: + generic: summary: Response code 400. Bad Request. value: status: 400 @@ -4624,22 +4624,12 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-confirmThirdParty-confirmThirdParty-200: - summary: Example response for request 'confirmThirdParty' - value: - pspReference: 991617894325358C - response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-declineThirdParty-declineThirdParty-200: - summary: Example response for request 'declineThirdParty' - value: - pspReference: 991617894325360J - response: '[payout-decline-received]' post-payout-payout-b2c: summary: Instant card payout (B2C) description: Pay out to your sellers, customers, freelancers, etc @@ -4702,37 +4692,6 @@ components: dateOfBirth: '1990-01-01' nationality: NL post-storeDetail-storeDetail: - summary: Store payout details - description: Store payment details under the PAYOUT recurring contract - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - bank: - bankName: AbnAmro - bic: ABNANL2A - countryCode: NL - iban: NL32ABNA0515071439 - ownerName: Adyen - bankCity: Amsterdam - taxId: bankTaxId - shopperEmail: shopper@email.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperName: - firstName: Adyen - gender: MALE - lastName: Test - dateOfBirth: '1990-01-01' - entityType: Company - nationality: NL - billingAddress: - houseNumberOrName: '17' - street: Teststreet 1 - city: Amsterdam - stateOrProvince: NY - country: US - postalCode: '12345' - post-storeDetail-storeDetail-200: summary: Example response for request 'storeDetail' value: pspReference: 991617894326362D diff --git a/yaml/PayoutService-v51.yaml b/yaml/PayoutService-v51.yaml index efcccff0..4d844eb4 100644 --- a/yaml/PayoutService-v51.yaml +++ b/yaml/PayoutService-v51.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payout/v51 info: @@ -52,15 +52,20 @@ x-groups: paths: /confirmThirdParty: post: + tags: + - Reviewing summary: Confirms a payout. description: 'Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-confirmThirdParty x-groupName: Reviewing x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -74,8 +79,8 @@ paths: content: application/json: examples: - confirmThirdParty-200: - $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -83,8 +88,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -114,15 +119,20 @@ paths: description: Internal Server Error - the server could not process the request. /declineThirdParty: post: + tags: + - Reviewing summary: Cancels a payout. description: 'Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-declineThirdParty x-groupName: Reviewing x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -136,8 +146,8 @@ paths: content: application/json: examples: - declineThirdParty-200: - $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -145,8 +155,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -176,15 +186,20 @@ paths: description: Internal Server Error - the server could not process the request. /payout: post: + tags: + - Instant payouts summary: Pay out directly. description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards. - x-addedInVersion: 11 + x-addedInVersion: '11' operationId: post-payout x-groupName: Instant payouts x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -206,8 +221,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -237,6 +252,8 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetail: post: + tags: + - Initialization summary: Stores payout details. description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` @@ -244,6 +261,9 @@ paths: operationId: post-storeDetail x-groupName: Initialization x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +277,8 @@ paths: content: application/json: examples: - storeDetail-200: - $ref: '#/components/examples/post-storeDetail-storeDetail-200' + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -266,8 +286,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -297,16 +317,21 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetailAndSubmitThirdParty: post: + tags: + - Initialization summary: Stores details and submits a payout. description: 'Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-storeDetailAndSubmitThirdParty x-groupName: Initialization x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -334,8 +359,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -365,6 +390,8 @@ paths: description: Internal Server Error - the server could not process the request. /submitThirdParty: post: + tags: + - Initialization summary: Submits a payout. description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -372,10 +399,13 @@ paths: The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-submitThirdParty x-groupName: Initialization x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -395,8 +425,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,7 +508,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -1131,6 +1161,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1604,19 +1642,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -1842,68 +1867,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2121,7 +2084,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2160,7 +2123,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2171,41 +2134,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2669,7 +2632,7 @@ components: PayoutRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -2714,7 +2677,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -2725,7 +2688,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -2741,7 +2704,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -2752,7 +2715,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -2766,7 +2729,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -2777,19 +2740,19 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -2804,7 +2767,7 @@ components: description: The person or entity funding the money. $ref: '#/components/schemas/FundSource' installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -2812,7 +2775,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -2822,7 +2785,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -2837,14 +2800,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -2864,7 +2827,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -2879,7 +2842,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -2973,12 +2936,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -2994,11 +2957,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3006,36 +2969,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3093,7 +3058,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3183,18 +3148,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -3218,6 +3183,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -3530,6 +3498,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -3613,7 +3613,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -3628,11 +3628,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -3900,7 +3900,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -4014,7 +4014,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -4023,7 +4023,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -4035,7 +4035,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4051,7 +4051,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4070,7 +4070,7 @@ components: Although it is a good idea to make sure it is unique, this is not a requirement. type: string selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4080,7 +4080,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4091,13 +4091,13 @@ components: description: The shopper's reference for the payment transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4149,7 +4149,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -4158,7 +4158,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -4170,7 +4170,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4186,7 +4186,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4200,7 +4200,7 @@ components: The recurring.contract must be set to `PAYOUT`' $ref: '#/components/schemas/Recurring' selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4210,7 +4210,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4221,7 +4221,7 @@ components: description: The shopper's reference for the payment transaction. type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4267,7 +4267,7 @@ components: transaction. $ref: '#/components/schemas/Amount' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\ \nFor Paysafecard it must be the same as used when registering the Paysafecard\ \ account.\n\n> This field is mandatory for natural persons. \n> This\ @@ -4276,7 +4276,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The type of the entity the payout is processed for. @@ -4302,7 +4302,7 @@ components: request with. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4335,7 +4335,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4350,13 +4350,13 @@ components: description: The shopper's reference for the payout transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4394,13 +4394,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -4408,7 +4408,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -4450,14 +4450,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -4514,7 +4514,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -4536,7 +4536,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -4546,7 +4546,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -4592,7 +4592,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -4600,7 +4600,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -4617,7 +4617,7 @@ components: scheme: basic type: http examples: - generic-400: + generic: summary: Response code 400. Bad Request. value: status: 400 @@ -4630,22 +4630,12 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-confirmThirdParty-confirmThirdParty-200: - summary: Example response for request 'confirmThirdParty' - value: - pspReference: 991617894325358C - response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-declineThirdParty-declineThirdParty-200: - summary: Example response for request 'declineThirdParty' - value: - pspReference: 991617894325360J - response: '[payout-decline-received]' post-payout-payout-b2c: summary: Instant card payout (B2C) description: Pay out to your sellers, customers, freelancers, etc @@ -4708,37 +4698,6 @@ components: dateOfBirth: '1990-01-01' nationality: NL post-storeDetail-storeDetail: - summary: Store payout details - description: Store payment details under the PAYOUT recurring contract - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - bank: - bankName: AbnAmro - bic: ABNANL2A - countryCode: NL - iban: NL32ABNA0515071439 - ownerName: Adyen - bankCity: Amsterdam - taxId: bankTaxId - shopperEmail: shopper@email.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperName: - firstName: Adyen - gender: MALE - lastName: Test - dateOfBirth: '1990-01-01' - entityType: Company - nationality: NL - billingAddress: - houseNumberOrName: '17' - street: Teststreet 1 - city: Amsterdam - stateOrProvince: NY - country: US - postalCode: '12345' - post-storeDetail-storeDetail-200: summary: Example response for request 'storeDetail' value: pspReference: 991617894326362D diff --git a/yaml/PayoutService-v52.yaml b/yaml/PayoutService-v52.yaml index b5ffc845..46f11416 100644 --- a/yaml/PayoutService-v52.yaml +++ b/yaml/PayoutService-v52.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payout/v52 info: @@ -52,15 +52,20 @@ x-groups: paths: /confirmThirdParty: post: + tags: + - Reviewing summary: Confirms a payout. description: 'Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-confirmThirdParty x-groupName: Reviewing x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -74,8 +79,8 @@ paths: content: application/json: examples: - confirmThirdParty-200: - $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -83,8 +88,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -114,15 +119,20 @@ paths: description: Internal Server Error - the server could not process the request. /declineThirdParty: post: + tags: + - Reviewing summary: Cancels a payout. description: 'Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-declineThirdParty x-groupName: Reviewing x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -136,8 +146,8 @@ paths: content: application/json: examples: - declineThirdParty-200: - $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -145,8 +155,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -176,15 +186,20 @@ paths: description: Internal Server Error - the server could not process the request. /payout: post: + tags: + - Instant payouts summary: Pay out directly. description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards. - x-addedInVersion: 11 + x-addedInVersion: '11' operationId: post-payout x-groupName: Instant payouts x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -206,8 +221,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -237,6 +252,8 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetail: post: + tags: + - Initialization summary: Stores payout details. description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` @@ -244,6 +261,9 @@ paths: operationId: post-storeDetail x-groupName: Initialization x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +277,8 @@ paths: content: application/json: examples: - storeDetail-200: - $ref: '#/components/examples/post-storeDetail-storeDetail-200' + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -266,8 +286,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -297,16 +317,21 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetailAndSubmitThirdParty: post: + tags: + - Initialization summary: Stores details and submits a payout. description: 'Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-storeDetailAndSubmitThirdParty x-groupName: Initialization x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -334,8 +359,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -365,6 +390,8 @@ paths: description: Internal Server Error - the server could not process the request. /submitThirdParty: post: + tags: + - Initialization summary: Submits a payout. description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -372,10 +399,13 @@ paths: The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-submitThirdParty x-groupName: Initialization x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -395,8 +425,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,7 +508,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -1131,6 +1161,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1604,19 +1642,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -1842,68 +1867,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2121,7 +2084,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2160,7 +2123,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2171,41 +2134,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2669,7 +2632,7 @@ components: PayoutRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -2714,7 +2677,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -2725,7 +2688,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -2741,7 +2704,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -2752,7 +2715,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -2766,7 +2729,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -2777,19 +2740,19 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -2804,7 +2767,7 @@ components: description: The person or entity funding the money. $ref: '#/components/schemas/FundSource' fundingSource: - x-addedInVersion: 52 + x-addedInVersion: '52' description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. @@ -2812,7 +2775,7 @@ components: - debit type: string installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -2820,7 +2783,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -2830,7 +2793,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -2845,14 +2808,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -2872,7 +2835,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -2887,7 +2850,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -2981,12 +2944,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3002,11 +2965,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3014,36 +2977,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3101,7 +3066,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3191,18 +3156,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -3226,6 +3191,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -3538,6 +3506,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -3621,7 +3621,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -3636,11 +3636,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -3908,7 +3908,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -4022,7 +4022,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -4031,7 +4031,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -4043,7 +4043,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4059,7 +4059,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4078,7 +4078,7 @@ components: Although it is a good idea to make sure it is unique, this is not a requirement. type: string selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4088,7 +4088,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4099,17 +4099,17 @@ components: description: The shopper's reference for the payment transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string telephoneNumber: - x-addedInVersion: 52 + x-addedInVersion: '52' description: The shopper's phone number. type: string required: @@ -4161,7 +4161,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -4170,7 +4170,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -4182,7 +4182,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4198,7 +4198,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4212,7 +4212,7 @@ components: The recurring.contract must be set to `PAYOUT`' $ref: '#/components/schemas/Recurring' selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4222,7 +4222,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4233,11 +4233,11 @@ components: description: The shopper's reference for the payment transaction. type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string telephoneNumber: - x-addedInVersion: 52 + x-addedInVersion: '52' description: The shopper's phone number. type: string required: @@ -4283,7 +4283,7 @@ components: transaction. $ref: '#/components/schemas/Amount' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\ \nFor Paysafecard it must be the same as used when registering the Paysafecard\ \ account.\n\n> This field is mandatory for natural persons. \n> This\ @@ -4292,7 +4292,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The type of the entity the payout is processed for. @@ -4318,7 +4318,7 @@ components: request with. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4351,7 +4351,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4366,13 +4366,13 @@ components: description: The shopper's reference for the payout transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4410,13 +4410,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -4424,7 +4424,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -4466,14 +4466,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -4530,7 +4530,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -4552,7 +4552,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -4562,7 +4562,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -4608,7 +4608,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -4616,7 +4616,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -4633,7 +4633,7 @@ components: scheme: basic type: http examples: - generic-400: + generic: summary: Response code 400. Bad Request. value: status: 400 @@ -4646,22 +4646,12 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-confirmThirdParty-confirmThirdParty-200: - summary: Example response for request 'confirmThirdParty' - value: - pspReference: 991617894325358C - response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-declineThirdParty-declineThirdParty-200: - summary: Example response for request 'declineThirdParty' - value: - pspReference: 991617894325360J - response: '[payout-decline-received]' post-payout-payout-b2c: summary: Instant card payout (B2C) description: Pay out to your sellers, customers, freelancers, etc @@ -4724,37 +4714,6 @@ components: dateOfBirth: '1990-01-01' nationality: NL post-storeDetail-storeDetail: - summary: Store payout details - description: Store payment details under the PAYOUT recurring contract - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - bank: - bankName: AbnAmro - bic: ABNANL2A - countryCode: NL - iban: NL32ABNA0515071439 - ownerName: Adyen - bankCity: Amsterdam - taxId: bankTaxId - shopperEmail: shopper@email.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperName: - firstName: Adyen - gender: MALE - lastName: Test - dateOfBirth: '1990-01-01' - entityType: Company - nationality: NL - billingAddress: - houseNumberOrName: '17' - street: Teststreet 1 - city: Amsterdam - stateOrProvince: NY - country: US - postalCode: '12345' - post-storeDetail-storeDetail-200: summary: Example response for request 'storeDetail' value: pspReference: 991617894326362D diff --git a/yaml/PayoutService-v64.yaml b/yaml/PayoutService-v64.yaml index 4b64f038..10f9cb76 100644 --- a/yaml/PayoutService-v64.yaml +++ b/yaml/PayoutService-v64.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Payout/v64 info: @@ -52,15 +52,20 @@ x-groups: paths: /confirmThirdParty: post: + tags: + - Reviewing summary: Confirms a payout. description: 'Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-confirmThirdParty x-groupName: Reviewing x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -74,8 +79,8 @@ paths: content: application/json: examples: - confirmThirdParty-200: - $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -83,8 +88,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -114,15 +119,20 @@ paths: description: Internal Server Error - the server could not process the request. /declineThirdParty: post: + tags: + - Reviewing summary: Cancels a payout. description: 'Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-declineThirdParty x-groupName: Reviewing x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -136,8 +146,8 @@ paths: content: application/json: examples: - declineThirdParty-200: - $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -145,8 +155,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -176,15 +186,20 @@ paths: description: Internal Server Error - the server could not process the request. /payout: post: + tags: + - Instant payouts summary: Pay out directly. description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards. - x-addedInVersion: 11 + x-addedInVersion: '11' operationId: post-payout x-groupName: Instant payouts x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -206,8 +221,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -237,6 +252,8 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetail: post: + tags: + - Initialization summary: Stores payout details. description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` @@ -244,6 +261,9 @@ paths: operationId: post-storeDetail x-groupName: Initialization x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -257,8 +277,8 @@ paths: content: application/json: examples: - storeDetail-200: - $ref: '#/components/examples/post-storeDetail-storeDetail-200' + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -266,8 +286,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -297,16 +317,21 @@ paths: description: Internal Server Error - the server could not process the request. /storeDetailAndSubmitThirdParty: post: + tags: + - Initialization summary: Stores details and submits a payout. description: 'Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-storeDetailAndSubmitThirdParty x-groupName: Initialization x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -334,8 +359,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -365,6 +390,8 @@ paths: description: Internal Server Error - the server could not process the request. /submitThirdParty: post: + tags: + - Initialization summary: Submits a payout. description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -372,10 +399,13 @@ paths: The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.' - x-addedInVersion: 10 + x-addedInVersion: '10' operationId: post-submitThirdParty x-groupName: Initialization x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -395,8 +425,8 @@ paths: content: application/json: examples: - generic-400: - $ref: '#/components/examples/generic-400' + generic: + $ref: '#/components/examples/generic' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -478,7 +508,7 @@ components: format: date-time type: string accountType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: 'Indicates the type of account. For example, for a multi-account card product. @@ -1131,6 +1161,14 @@ components: To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' type: string industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1604,19 +1642,6 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string - openinvoicedataLine[itemNr].vatCategory: - description: 'Required for AfterPay. The country-specific VAT category a - product falls under. - - - Allowed values: - - * High - - * Low - - * None.' - type: string AdditionalDataOpi: properties: opi.includeTransToken: @@ -1842,68 +1867,6 @@ components: \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ * Fixed length: 3 characters" type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].creditSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].creditSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccount: - description: 'The sub-merchant''s bank account number with the check digit - number and without punctuations or dashes. - - * Format: Numeric - - * Maximum length: 12 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAccountType: - description: "A two-letter indicator of the type of the sub-merchant's bank\ - \ account.\nPossible values:\n - **CC** - Checking account\n - **CD**\ - \ - Deposit account\n - **PG** - Payments account\n - **PP** - Savings\ - \ account\n" - type: string - subMerchant.subSeller[subSellerNr].debitSettlementAgency: - description: 'The four-digit branch code of the sub-merchant''s bank, without - the check digit, slashes, or dashes. - - * Format: Numeric - - * Fixed length: 4 digits' - type: string - subMerchant.subSeller[subSellerNr].debitSettlementBank: - description: 'The identifier of the sub-merchant''s bank. In Brazil, this - is the three-digit bank number format specified by the Central Bank of - Brazil (BACEN). - - * Format: Numeric - - * Fixed length: 3 digits' - type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment\ \ facilitators. A unique identifier that you create for the sub-merchant,\ @@ -2121,7 +2084,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -2160,7 +2123,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string BrowserInfo: @@ -2171,41 +2134,41 @@ components: minLength: 10 type: string colorDepth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' format: int32 type: integer javaEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Boolean value indicating if the shopper's browser is able to execute Java. type: boolean javaScriptEnabled: - x-addedInVersion: 40 + x-addedInVersion: '40' default: true description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. type: boolean language: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). type: string screenHeight: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total height of the shopper's device screen in pixels. format: int32 type: integer screenWidth: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The total width of the shopper's device screen in pixels. format: int32 type: integer timeZoneOffset: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Time difference between UTC time and the shopper's browser local time, in minutes. format: int32 @@ -2453,7 +2416,7 @@ components: Installments: properties: plan: - x-addedInVersion: 64 + x-addedInVersion: '64' description: 'Defines the type of installment plan. If not set, defaults to **regular**. @@ -2684,7 +2647,7 @@ components: PayoutRequest: properties: accountInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object @@ -2729,7 +2692,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -2740,7 +2703,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The address where to send the invoice. > For 3D Secure 2 transactions, schemes require `billingAddress` for all @@ -2756,7 +2719,7 @@ components: is routed to 3D Secure 1.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 @@ -2767,7 +2730,7 @@ components: > Either `bankAccount` or `card` field must be provided in a payment request.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 7 + x-addedInVersion: '7' description: 'The shopper''s date of birth. @@ -2781,7 +2744,7 @@ components: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: - x-addedInVersion: 8 + x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. @@ -2792,19 +2755,19 @@ components: format: date-time type: string deviceFingerprint: - x-addedInVersion: 2 + x-addedInVersion: '2' description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). maxLength: 5000 type: string enableRealTimeUpdate: - x-addedInVersion: 51 + x-addedInVersion: '51' deprecated: true description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson @@ -2819,7 +2782,7 @@ components: description: The person or entity funding the money. $ref: '#/components/schemas/FundSource' fundingSource: - x-addedInVersion: 52 + x-addedInVersion: '52' description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. @@ -2827,7 +2790,7 @@ components: - debit type: string installments: - x-addedInVersion: 4 + x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' @@ -2835,7 +2798,7 @@ components: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: - x-addedInVersion: 12 + x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. @@ -2845,7 +2808,7 @@ components: the transaction. type: string merchantOrderReference: - x-addedInVersion: 9 + x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. @@ -2860,14 +2823,14 @@ components: `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string merchantRiskIndicator: - x-addedInVersion: 40 + x-addedInVersion: '40' description: 'Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.' $ref: '#/components/schemas/MerchantRiskIndicator' metadata: - x-addedInVersion: 17 + x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key @@ -2887,7 +2850,7 @@ components: or Visa Secure). $ref: '#/components/schemas/ThreeDSecureData' nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The two-character country code of the shopper's nationality. maxLength: 2 type: string @@ -2902,7 +2865,7 @@ components: you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). $ref: '#/components/schemas/Recurring' recurringProcessingModel: - x-addedInVersion: 30 + x-addedInVersion: '30' description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ @@ -2996,12 +2959,12 @@ components: - POS type: string shopperLocale: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: @@ -3017,11 +2980,11 @@ components: \ truncate the string." type: string socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The shopper's social security number. type: string splits: - x-addedInVersion: 37 + x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). @@ -3029,36 +2992,38 @@ components: $ref: '#/components/schemas/Split' type: array store: - x-addedInVersion: 23 - description: The physical store, for which this payment is processed. + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. maxLength: 16 minLength: 1 type: string telephoneNumber: - x-addedInVersion: 7 + x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDS2RequestData: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation. $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: - x-addedInVersion: 50 + x-addedInVersion: '50' default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean totalsGroup: - x-addedInVersion: 23 + x-addedInVersion: '23' description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 type: string trustedShopper: - x-addedInVersion: 37 + x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: @@ -3116,7 +3081,7 @@ components: type: string md: description: The payment session. - maxLength: 10000 + maxLength: 20000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3206,18 +3171,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -3241,6 +3206,9 @@ components: \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string + threeds2.cardEnrolled: + description: Indicates whether a card is enrolled for 3D Secure 2. + type: boolean ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -3553,6 +3521,38 @@ components: > Contact Support Team to enable this field.' type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + type: string merchantReference: description: The reference provided for the transaction. type: string @@ -3636,7 +3636,7 @@ components: description: Message to be displayed on the terminal. type: string recurring.contractTypes: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The recurring contract types applicable to the transaction. type: string recurring.firstPspReference: @@ -3651,11 +3651,11 @@ components: description: The reference that uniquely identifies the recurring transaction. type: string recurring.shopperReference: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The provided reference of the shopper for a recurring transaction. type: string recurringProcessingModel: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The processing model used for the recurring transaction. enum: - CardOnFile @@ -3923,7 +3923,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data @@ -4037,7 +4037,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -4046,7 +4046,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -4058,7 +4058,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4074,7 +4074,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4093,7 +4093,7 @@ components: Although it is a good idea to make sure it is unique, this is not a requirement. type: string selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4103,7 +4103,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4114,17 +4114,17 @@ components: description: The shopper's reference for the payment transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string telephoneNumber: - x-addedInVersion: 52 + x-addedInVersion: '52' description: The shopper's phone number. type: string required: @@ -4176,7 +4176,7 @@ components: > This field is mandatory if `card` is not provided.' $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The billing address. $ref: '#/components/schemas/Address' card: @@ -4185,7 +4185,7 @@ components: > This field is mandatory if `bank` is not provided.' $ref: '#/components/schemas/Card' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD @@ -4197,7 +4197,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The type of the entity the payout is processed for. enum: - NaturalPerson @@ -4213,7 +4213,7 @@ components: the transaction. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4227,7 +4227,7 @@ components: The recurring.contract must be set to `PAYOUT`' $ref: '#/components/schemas/Recurring' selectedBrand: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The name of the brand to make a payout to. @@ -4237,7 +4237,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4248,11 +4248,11 @@ components: description: The shopper's reference for the payment transaction. type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string telephoneNumber: - x-addedInVersion: 52 + x-addedInVersion: '52' description: The shopper's phone number. type: string required: @@ -4298,7 +4298,7 @@ components: transaction. $ref: '#/components/schemas/Amount' dateOfBirth: - x-addedInVersion: 24 + x-addedInVersion: '24' description: "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\ \nFor Paysafecard it must be the same as used when registering the Paysafecard\ \ account.\n\n> This field is mandatory for natural persons. \n> This\ @@ -4307,7 +4307,7 @@ components: format: date-time type: string entityType: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The type of the entity the payout is processed for. @@ -4333,7 +4333,7 @@ components: request with. type: string nationality: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s nationality. @@ -4366,7 +4366,7 @@ components: description: The shopper's email address. type: string shopperName: - x-addedInVersion: 24 + x-addedInVersion: '24' description: 'The shopper''s name. @@ -4381,13 +4381,13 @@ components: description: The shopper's reference for the payout transaction. type: string shopperStatement: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). type: string socialSecurityNumber: - x-addedInVersion: 24 + x-addedInVersion: '24' description: The shopper's social security number. type: string required: @@ -4425,13 +4425,13 @@ components: ThreeDS2RequestData: properties: acquirerBIN: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. type: string acquirerMerchantID: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. @@ -4439,7 +4439,7 @@ components: type: string authenticationOnly: deprecated: true - x-deprecatedInVersion: 50 + x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), @@ -4481,14 +4481,14 @@ components: Optional and only for `deviceChannel` **app**.' $ref: '#/components/schemas/DeviceRenderOptions' mcc: - x-addedInVersion: 49 + x-addedInVersion: '49' description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. type: string merchantName: - x-addedInVersion: 49 + x-addedInVersion: '49' description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the @@ -4545,7 +4545,7 @@ components: Only for `deviceChannel` set to **app**.' type: string sdkVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." type: string @@ -4567,7 +4567,7 @@ components: the shopper in case of technical errors during the 3D Secure 2 process. type: string transactionType: - x-addedInVersion: 50 + x-addedInVersion: '50' description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase @@ -4577,7 +4577,7 @@ components: - prepaidActivationAndLoad type: string whiteListStatus: - x-addedInVersion: 49 + x-addedInVersion: '49' description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. type: string @@ -4623,7 +4623,7 @@ components: - Y type: string dsTransID: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. type: string @@ -4631,7 +4631,7 @@ components: description: The electronic commerce indicator. type: string threeDSVersion: - x-addedInVersion: 40 + x-addedInVersion: '40' description: The version of the 3D Secure protocol. type: string xid: @@ -4648,7 +4648,7 @@ components: scheme: basic type: http examples: - generic-400: + generic: summary: Response code 400. Bad Request. value: status: 400 @@ -4661,22 +4661,12 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-confirmThirdParty-confirmThirdParty-200: - summary: Example response for request 'confirmThirdParty' - value: - pspReference: 991617894325358C - response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-declineThirdParty-declineThirdParty-200: - summary: Example response for request 'declineThirdParty' - value: - pspReference: 991617894325360J - response: '[payout-decline-received]' post-payout-payout-b2c: summary: Instant card payout (B2C) description: Pay out to your sellers, customers, freelancers, etc @@ -4739,37 +4729,6 @@ components: dateOfBirth: '1990-01-01' nationality: NL post-storeDetail-storeDetail: - summary: Store payout details - description: Store payment details under the PAYOUT recurring contract - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - bank: - bankName: AbnAmro - bic: ABNANL2A - countryCode: NL - iban: NL32ABNA0515071439 - ownerName: Adyen - bankCity: Amsterdam - taxId: bankTaxId - shopperEmail: shopper@email.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperName: - firstName: Adyen - gender: MALE - lastName: Test - dateOfBirth: '1990-01-01' - entityType: Company - nationality: NL - billingAddress: - houseNumberOrName: '17' - street: Teststreet 1 - city: Amsterdam - stateOrProvince: NY - country: US - postalCode: '12345' - post-storeDetail-storeDetail-200: summary: Example response for request 'storeDetail' value: pspReference: 991617894326362D diff --git a/yaml/RecurringService-v25.yaml b/yaml/RecurringService-v25.yaml index af60dc67..cf1c05d1 100644 --- a/yaml/RecurringService-v25.yaml +++ b/yaml/RecurringService-v25.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Recurring/v25 info: @@ -59,6 +59,8 @@ x-groups: paths: /disable: post: + tags: + - General summary: Disables stored payment details. description: 'Disables stored payment details to stop charging a shopper with this particular recurring detail ID. @@ -68,6 +70,9 @@ paths: operationId: post-disable x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -115,6 +120,8 @@ paths: description: Internal Server Error - the server could not process the request. /listRecurringDetails: post: + tags: + - General summary: Retrieves stored payment details for a shopper. description: 'Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation @@ -126,6 +133,9 @@ paths: operationId: post-listRecurringDetails x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -173,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /scheduleAccountUpdater: post: + tags: + - General summary: Schedules running of the Account Updater. description: 'When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: @@ -181,10 +193,13 @@ paths: * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.' - x-addedInVersion: 4 + x-addedInVersion: '4' operationId: post-scheduleAccountUpdater x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -291,7 +306,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -330,7 +345,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string Card: @@ -404,7 +419,7 @@ components: DisableRequest: properties: contract: - x-addedInVersion: 3 + x-addedInVersion: '3' description: 'Specify the contract if you only want to disable a specific use. @@ -476,7 +491,7 @@ components: description: A descriptive name for this detail. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -485,7 +500,7 @@ components: RecurringDetail: properties: additionalData: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'This field contains additional data, which may be returned @@ -496,14 +511,14 @@ components: the key and value.' type: object alias: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The alias of the credit card number. Applies only to recurring contracts storing credit card details' type: string aliasType: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The alias type of the credit card number. @@ -513,14 +528,14 @@ components: description: A container for bank account data. $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The billing address. $ref: '#/components/schemas/Address' card: description: A container for card data. $ref: '#/components/schemas/Card' contractTypes: - x-addedInVersion: 12 + x-addedInVersion: '12' description: Types of recurring contracts. items: type: string @@ -530,7 +545,7 @@ components: format: date-time type: string firstPspReference: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The `pspReference` of the first recurring payment that created the recurring detail. type: string @@ -538,7 +553,7 @@ components: description: An optional descriptive name for this recurring detail. type: string paymentMethodVariant: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). type: string @@ -546,11 +561,11 @@ components: description: The reference that uniquely identifies the recurring detail. type: string shopperName: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The name of the shopper. $ref: '#/components/schemas/Name' socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A shopper's social security number (only in countries where it is legal to collect). type: string diff --git a/yaml/RecurringService-v30.yaml b/yaml/RecurringService-v30.yaml index 9f14eab4..a32c73eb 100644 --- a/yaml/RecurringService-v30.yaml +++ b/yaml/RecurringService-v30.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Recurring/v30 info: @@ -59,6 +59,8 @@ x-groups: paths: /disable: post: + tags: + - General summary: Disables stored payment details. description: 'Disables stored payment details to stop charging a shopper with this particular recurring detail ID. @@ -68,6 +70,9 @@ paths: operationId: post-disable x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -115,6 +120,8 @@ paths: description: Internal Server Error - the server could not process the request. /listRecurringDetails: post: + tags: + - General summary: Retrieves stored payment details for a shopper. description: 'Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation @@ -126,6 +133,9 @@ paths: operationId: post-listRecurringDetails x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -173,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /scheduleAccountUpdater: post: + tags: + - General summary: Schedules running of the Account Updater. description: 'When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: @@ -181,10 +193,13 @@ paths: * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.' - x-addedInVersion: 4 + x-addedInVersion: '4' operationId: post-scheduleAccountUpdater x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -291,7 +306,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -330,7 +345,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string Card: @@ -404,7 +419,7 @@ components: DisableRequest: properties: contract: - x-addedInVersion: 3 + x-addedInVersion: '3' description: 'Specify the contract if you only want to disable a specific use. @@ -476,7 +491,7 @@ components: description: A descriptive name for this detail. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -485,7 +500,7 @@ components: RecurringDetail: properties: additionalData: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'This field contains additional data, which may be returned @@ -496,14 +511,14 @@ components: the key and value.' type: object alias: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The alias of the credit card number. Applies only to recurring contracts storing credit card details' type: string aliasType: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The alias type of the credit card number. @@ -513,14 +528,14 @@ components: description: A container for bank account data. $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The billing address. $ref: '#/components/schemas/Address' card: description: A container for card data. $ref: '#/components/schemas/Card' contractTypes: - x-addedInVersion: 12 + x-addedInVersion: '12' description: Types of recurring contracts. items: type: string @@ -530,7 +545,7 @@ components: format: date-time type: string firstPspReference: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The `pspReference` of the first recurring payment that created the recurring detail. type: string @@ -538,7 +553,7 @@ components: description: An optional descriptive name for this recurring detail. type: string paymentMethodVariant: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). type: string @@ -546,11 +561,11 @@ components: description: The reference that uniquely identifies the recurring detail. type: string shopperName: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The name of the shopper. $ref: '#/components/schemas/Name' socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A shopper's social security number (only in countries where it is legal to collect). type: string diff --git a/yaml/RecurringService-v40.yaml b/yaml/RecurringService-v40.yaml index d6aef287..1482c307 100644 --- a/yaml/RecurringService-v40.yaml +++ b/yaml/RecurringService-v40.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Recurring/v40 info: @@ -59,6 +59,8 @@ x-groups: paths: /disable: post: + tags: + - General summary: Disables stored payment details. description: 'Disables stored payment details to stop charging a shopper with this particular recurring detail ID. @@ -68,6 +70,9 @@ paths: operationId: post-disable x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -115,6 +120,8 @@ paths: description: Internal Server Error - the server could not process the request. /listRecurringDetails: post: + tags: + - General summary: Retrieves stored payment details for a shopper. description: 'Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation @@ -126,6 +133,9 @@ paths: operationId: post-listRecurringDetails x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -173,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /scheduleAccountUpdater: post: + tags: + - General summary: Schedules running of the Account Updater. description: 'When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: @@ -181,10 +193,13 @@ paths: * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.' - x-addedInVersion: 4 + x-addedInVersion: '4' operationId: post-scheduleAccountUpdater x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -291,7 +306,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -330,7 +345,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string Card: @@ -404,7 +419,7 @@ components: DisableRequest: properties: contract: - x-addedInVersion: 3 + x-addedInVersion: '3' description: 'Specify the contract if you only want to disable a specific use. @@ -476,18 +491,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -496,7 +511,7 @@ components: RecurringDetail: properties: additionalData: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'This field contains additional data, which may be returned @@ -507,14 +522,14 @@ components: the key and value.' type: object alias: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The alias of the credit card number. Applies only to recurring contracts storing credit card details' type: string aliasType: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The alias type of the credit card number. @@ -524,14 +539,14 @@ components: description: A container for bank account data. $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The billing address. $ref: '#/components/schemas/Address' card: description: A container for card data. $ref: '#/components/schemas/Card' contractTypes: - x-addedInVersion: 12 + x-addedInVersion: '12' description: Types of recurring contracts. items: type: string @@ -541,7 +556,7 @@ components: format: date-time type: string firstPspReference: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The `pspReference` of the first recurring payment that created the recurring detail. type: string @@ -549,7 +564,7 @@ components: description: An optional descriptive name for this recurring detail. type: string paymentMethodVariant: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). type: string @@ -557,11 +572,11 @@ components: description: The reference that uniquely identifies the recurring detail. type: string shopperName: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The name of the shopper. $ref: '#/components/schemas/Name' socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A shopper's social security number (only in countries where it is legal to collect). type: string diff --git a/yaml/RecurringService-v49.yaml b/yaml/RecurringService-v49.yaml index 42aa4531..fec9d157 100644 --- a/yaml/RecurringService-v49.yaml +++ b/yaml/RecurringService-v49.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/servlet/Recurring/v49 info: @@ -59,6 +59,8 @@ x-groups: paths: /disable: post: + tags: + - General summary: Disables stored payment details. description: 'Disables stored payment details to stop charging a shopper with this particular recurring detail ID. @@ -68,6 +70,9 @@ paths: operationId: post-disable x-groupName: General x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -115,6 +120,8 @@ paths: description: Internal Server Error - the server could not process the request. /listRecurringDetails: post: + tags: + - General summary: Retrieves stored payment details for a shopper. description: 'Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation @@ -126,6 +133,9 @@ paths: operationId: post-listRecurringDetails x-groupName: General x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -173,6 +183,8 @@ paths: description: Internal Server Error - the server could not process the request. /scheduleAccountUpdater: post: + tags: + - General summary: Schedules running of the Account Updater. description: 'When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: @@ -181,10 +193,13 @@ paths: * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.' - x-addedInVersion: 4 + x-addedInVersion: '4' operationId: post-scheduleAccountUpdater x-groupName: General x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: @@ -291,7 +306,7 @@ components: description: The bank account number (without separators). type: string bankCity: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank city. type: string bankLocationId: @@ -330,7 +345,7 @@ components: \ the error message: 203 'Invalid bank account holder name'." type: string taxId: - x-addedInVersion: 18 + x-addedInVersion: '18' description: The bank account holder's tax ID. type: string Card: @@ -404,7 +419,7 @@ components: DisableRequest: properties: contract: - x-addedInVersion: 3 + x-addedInVersion: '3' description: 'Specify the contract if you only want to disable a specific use. @@ -476,18 +491,18 @@ components: description: A descriptive name for this detail. type: string recurringExpiry: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. format: date-time type: string recurringFrequency: - x-addedInVersion: 40 + x-addedInVersion: '40' description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string tokenService: - x-addedInVersion: 25 + x-addedInVersion: '25' description: The name of the token service. enum: - VISATOKENSERVICE @@ -496,7 +511,7 @@ components: RecurringDetail: properties: additionalData: - x-addedInVersion: 5 + x-addedInVersion: '5' additionalProperties: type: string description: 'This field contains additional data, which may be returned @@ -507,14 +522,14 @@ components: the key and value.' type: object alias: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The alias of the credit card number. Applies only to recurring contracts storing credit card details' type: string aliasType: - x-addedInVersion: 4 + x-addedInVersion: '4' description: 'The alias type of the credit card number. @@ -524,14 +539,14 @@ components: description: A container for bank account data. $ref: '#/components/schemas/BankAccount' billingAddress: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The billing address. $ref: '#/components/schemas/Address' card: description: A container for card data. $ref: '#/components/schemas/Card' contractTypes: - x-addedInVersion: 12 + x-addedInVersion: '12' description: Types of recurring contracts. items: type: string @@ -541,7 +556,7 @@ components: format: date-time type: string firstPspReference: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The `pspReference` of the first recurring payment that created the recurring detail. type: string @@ -549,7 +564,7 @@ components: description: An optional descriptive name for this recurring detail. type: string paymentMethodVariant: - x-addedInVersion: 2 + x-addedInVersion: '2' description: The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). type: string @@ -557,11 +572,11 @@ components: description: The reference that uniquely identifies the recurring detail. type: string shopperName: - x-addedInVersion: 4 + x-addedInVersion: '4' description: The name of the shopper. $ref: '#/components/schemas/Name' socialSecurityNumber: - x-addedInVersion: 4 + x-addedInVersion: '4' description: A shopper's social security number (only in countries where it is legal to collect). type: string @@ -669,7 +684,7 @@ components: ServiceError: properties: additionalData: - x-addedInVersion: 46 + x-addedInVersion: '46' additionalProperties: type: string description: 'Contains additional information about the payment. Some data diff --git a/yaml/TestCardService-v1.yaml b/yaml/TestCardService-v1.yaml index bd30d832..ff494d9a 100644 --- a/yaml/TestCardService-v1.yaml +++ b/yaml/TestCardService-v1.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 servers: - url: https://pal-test.adyen.com/pal/services/TestCard/v1 info: @@ -18,11 +18,16 @@ x-groups: paths: /createTestCardRanges: post: + tags: + - General summary: Creates one or more test card ranges. description: Creates one or more test card ranges. operationId: post-createTestCardRanges x-groupName: General x-sortIndex: 0 + security: + - BasicAuth: [] + - ApiKeyAuth: [] requestBody: content: application/json: diff --git a/yaml/Webhooks-v1.yaml b/yaml/Webhooks-v1.yaml new file mode 100644 index 00000000..36200000 --- /dev/null +++ b/yaml/Webhooks-v1.yaml @@ -0,0 +1,2229 @@ +openapi: 3.1.0 +info: + version: '1' + x-publicVersion: true + title: Notifications + description: Our notifications are webhooks informing you of payment status updates + and newly available reports. For more information, refer to our [documentation](https://docs.adyen.com/development-resources/webhooks). + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- standard +- additional configuration +- dispute +- payout +x-staticResponse: response.json +webhooks: + /AUTHORISATION: + post: + tags: + - standard + summary: Informs you of the outcome of payment request. + description: Informs you of the outcome of payment request. + operationId: post-AUTHORISATION + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + authorisation: + $ref: '#/components/examples/post-AUTHORISATION-authorisation' + schema: + $ref: '#/components/schemas/AuthorisationNotificationRequest' + responses: + '200': + content: + application/json: + examples: + authorisation: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /AUTHORISATION_ADJUSTMENT: + post: + tags: + - standard + summary: Informs you of the outcome of a request to adjust the authorised amount. + description: Informs you of the outcome of a request to [adjust the authorised + amount](https://docs.adyen.com/online-payments/adjust-authorisation) sent + through the [/adjustAuthorisation](https://docs.adyen.com/api-explorer/#/Payment/latest/post/adjustAuthorisation) + endpoint. + operationId: post-AUTHORISATION_ADJUSTMENT + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + authorisation_adjustment: + $ref: '#/components/examples/post-AUTHORISATION_ADJUSTMENT-authorisation_adjustment' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + authorisation_adjustment: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /AUTORESCUE: + post: + tags: + - additional configuration + summary: Informs you that an Auto Rescue process has ended. + description: Informs you that an [Auto Rescue process](https://docs.adyen.com/online-payments/auto-rescue#rescue-process-ended) + has ended. + operationId: post-AUTORESCUE + x-groupName: additional configuration + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + autorescue: + $ref: '#/components/examples/post-AUTORESCUE-autorescue' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + autorescue: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /CANCELLATION: + post: + tags: + - standard + summary: Informs you of the outcome of a request to cancel a payment. + description: Informs you of the outcome of a request to [cancel a payment](https://docs.adyen.com/online-payments/cancel). + operationId: post-CANCELLATION + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + cancellation: + $ref: '#/components/examples/post-CANCELLATION-cancellation' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + cancellation: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /CANCEL_AUTORESCUE: + post: + tags: + - additional configuration + summary: Informs you that an Auto Rescue cancel request has been processed. + description: Informs you that an [Auto Rescue cancel request](https://docs.adyen.com/online-payments/auto-rescue#cancel-auto-rescue-process) + has been processed. + operationId: post-CANCEL_AUTORESCUE + x-groupName: additional configuration + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + cancel_autorescue: + $ref: '#/components/examples/post-CANCEL_AUTORESCUE-cancel_autorescue' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + cancel_autorescue: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /CANCEL_OR_REFUND: + post: + tags: + - standard + summary: Informs you of the outcome of a request to cancel or refund a payment. + description: Informs you of the outcome of a request to [cancel or refund a + payment](https://docs.adyen.com/online-payments/cancel-or-refund). + operationId: post-CANCEL_OR_REFUND + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + cancel_or_refund: + $ref: '#/components/examples/post-CANCEL_OR_REFUND-cancel_or_refund' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + cancel_or_refund: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /CAPTURE: + post: + tags: + - standard + summary: Informs you of the outcome of a request to capture a payment. + description: Informs you of the outcome of a request to [capture a payment](https://docs.adyen.com/online-payments/capture). + operationId: post-CAPTURE + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + capture: + $ref: '#/components/examples/post-CAPTURE-capture' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + capture: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /CAPTURE_FAILED: + post: + tags: + - standard + summary: Informs you about a failed capture. + description: Informs you about a failed capture due to a [technical issue](https://docs.adyen.com/online-payments/capture#failed-capture). + operationId: post-CAPTURE_FAILED + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + capture_failed: + $ref: '#/components/examples/post-CAPTURE_FAILED-capture_failed' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + capture_failed: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /CHARGEBACK: + post: + tags: + - dispute + summary: Informs you that a payment was charged back, and the funds were deducted + from your account. + description: Informs you that a payment was [charged back](https://docs.adyen.com/risk-management/disputes-api/dispute-notifications#chargeback), + and the funds were deducted from your account. + operationId: post-CHARGEBACK + x-groupName: dispute + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + chargeback: + $ref: '#/components/examples/post-CHARGEBACK-chargeback' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + chargeback: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /CHARGEBACK_REVERSED: + post: + tags: + - dispute + summary: Informs you that a chargeback has been defended towards the issuing + bank. + description: Informs you that a chargeback has been defended towards the issuing + bank. This stage is not final. If the issuing bank decides to present a second + chargeback, you might still lose the chargeback case. + operationId: post-CHARGEBACK_REVERSED + x-groupName: dispute + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + chargeback_reversed: + $ref: '#/components/examples/post-CHARGEBACK_REVERSED-chargeback_reversed' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + chargeback_reversed: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /MANUAL_REVIEW_ACCEPT: + post: + tags: + - additional configuration + summary: Informs you that the manual review has been accepted. + description: Informs you that the manual review has been accepted. + operationId: post-MANUAL_REVIEW_ACCEPT + x-groupName: additional configuration + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + manual_review_accept: + $ref: '#/components/examples/post-MANUAL_REVIEW_ACCEPT-manual_review_accept' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + manual_review_accept: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /MANUAL_REVIEW_REJECT: + post: + tags: + - additional configuration + summary: Informs you that the manual review has been rejected. + description: Informs you that the manual review has been rejected. + operationId: post-MANUAL_REVIEW_REJECT + x-groupName: additional configuration + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + manual_review_reject: + $ref: '#/components/examples/post-MANUAL_REVIEW_REJECT-manual_review_reject' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + manual_review_reject: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /NOTIFICATION_OF_CHARGEBACK: + post: + tags: + - dispute + summary: Informs you that the dispute process has been opened. + description: Informs you that the dispute process has been opened. You should + investigate the dispute and [supply the defense documents](https://docs.adyen.com/risk-management/disputes-api#supply-dispute-defense-documents). + operationId: post-NOTIFICATION_OF_CHARGEBACK + x-groupName: dispute + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + notification_of_chargeback: + $ref: '#/components/examples/post-NOTIFICATION_OF_CHARGEBACK-notification_of_chargeback' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + notification_of_chargeback: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /NOTIFICATION_OF_FRAUD: + post: + tags: + - dispute + summary: The alert notification passed on by issuers to schemes and subsequently + to processors. + description: The alert notification passed on by issuers to schemes and subsequently + to processors. Visa calls them TC40 and Mastercard calls them System to Avoid + Fraud Effectively (SAFE). These are informational notifications offered by + Adyen, providing you the opportunity to take action, such as blocking a shopper + or issuing a refund before a chargeback is incurred. + operationId: post-NOTIFICATION_OF_FRAUD + x-groupName: dispute + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + notification_of_fraud: + $ref: '#/components/examples/post-NOTIFICATION_OF_FRAUD-notification_of_fraud' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + notification_of_fraud: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /OFFER_CLOSED: + post: + tags: + - additional configuration + summary: Informs you that the offer has expired. + description: Informs you that the offer has expired, for example because the + shopper abandoned the session. For cards, offers expire after 12 hours by + default. + operationId: post-OFFER_CLOSED + x-groupName: additional configuration + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + offer_closed: + $ref: '#/components/examples/post-OFFER_CLOSED-offer_closed' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + offer_closed: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /ORDER_CLOSED: + post: + tags: + - standard + summary: Informs you of the outcome of a shopper's last payment when paying + for an order in partial payments. + description: Informs you of the outcome of a shopper's last payment when paying + for an order in [partial payments](https://docs.adyen.com/online-payments/classic-integrations/hosted-payment-pages/payment-request/partial-payments#notifications). + operationId: post-ORDER_CLOSED + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + order_closed: + $ref: '#/components/examples/post-ORDER_CLOSED-order_closed' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + order_closed: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /ORDER_OPENED: + post: + tags: + - standard + summary: Informs you that the first payment for your payment request is a partial + payment, and an order has been created. + description: Informs you that the first payment for your payment request is + a [partial payment](https://docs.adyen.com/online-payments/classic-integrations/hosted-payment-pages/payment-request/partial-payments#notifications), + and an order has been created. + operationId: post-ORDER_OPENED + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + order_opened: + $ref: '#/components/examples/post-ORDER_OPENED-order_opened' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + order_opened: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /PAIDOUT_REVERSED: + post: + tags: + - payout + summary: Informs you that the financial institution has rejected the payout. + description: "Informs you that the financial institution has rejected the payout.\ + \ We will return the funds back to your account. \nThe reason field contains\ + \ the bank statement description if present." + operationId: post-PAIDOUT_REVERSED + x-groupName: payout + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + paidout_reversed: + $ref: '#/components/examples/post-PAIDOUT_REVERSED-paidout_reversed' + schema: + $ref: '#/components/schemas/PaidoutReversedNotificationRequest' + responses: + '200': + content: + application/json: + examples: + paidout_reversed: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /PAYOUT_DECLINE: + post: + tags: + - payout + summary: Informs you that the user reviewing the payout has declined it. + description: Informs you that the user reviewing the payout has [declined](https://docs.adyen.com/online-payments/online-payouts/confirm-or-decline-payout) + it. + operationId: post-PAYOUT_DECLINE + x-groupName: payout + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + payout_decline: + $ref: '#/components/examples/post-PAYOUT_DECLINE-payout_decline' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + payout_decline: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /PAYOUT_EXPIRE: + post: + tags: + - payout + summary: Informs you that the payout has expired. + description: Informs you that the [payout has expired](https://docs.adyen.com/online-payments/online-payouts/payout-notifications). + operationId: post-PAYOUT_EXPIRE + x-groupName: payout + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + payout_expire: + $ref: '#/components/examples/post-PAYOUT_EXPIRE-payout_expire' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + payout_expire: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /PAYOUT_THIRDPARTY: + post: + tags: + - payout + summary: Informs you of the outcome of a payout request. + description: Informs you of the outcome of a payout request. + operationId: post-PAYOUT_THIRDPARTY + x-groupName: payout + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + payout_thirdparty: + $ref: '#/components/examples/post-PAYOUT_THIRDPARTY-payout_thirdparty' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + payout_thirdparty: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /POSTPONED_REFUND: + post: + tags: + - additional configuration + summary: Informs you that the refund for the payment will be performed after + the payment is captured. + description: Informs you that the refund for the payment will be performed after + the payment is captured. + operationId: post-POSTPONED_REFUND + x-groupName: additional configuration + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + postponed_refund: + $ref: '#/components/examples/post-POSTPONED_REFUND-postponed_refund' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + postponed_refund: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /PREARBITRATION_LOST: + post: + tags: + - dispute + summary: Informs you that your pre-arbitration case has been declined by the + cardholder's bank. + description: Informs you that your pre-arbitration case has been declined by + the cardholder's bank. + operationId: post-PREARBITRATION_LOST + x-groupName: dispute + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + prearbitration_lost: + $ref: '#/components/examples/post-PREARBITRATION_LOST-prearbitration_lost' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + prearbitration_lost: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /PREARBITRATION_WON: + post: + tags: + - dispute + summary: Informs you that your pre-arbitration case has been accepted by the + cardholder's bank. + description: Informs you that your pre-arbitration case has been accepted by + the cardholder's bank. + operationId: post-PREARBITRATION_WON + x-groupName: dispute + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + prearbitration_won: + $ref: '#/components/examples/post-PREARBITRATION_WON-prearbitration_won' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + prearbitration_won: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /RECURRING_CONTRACT: + post: + tags: + - additional configuration + summary: Informs you that a recurring contract has been created. + description: Informs you that a recurring contract has been created. + operationId: post-RECURRING_CONTRACT + x-groupName: additional configuration + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + recurring_contract: + $ref: '#/components/examples/post-RECURRING_CONTRACT-recurring_contract' + schema: + $ref: '#/components/schemas/RecurringContractNotificationRequest' + responses: + '200': + content: + application/json: + examples: + recurring_contract: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /REFUND: + post: + tags: + - standard + summary: Informs you of the outcome of a request to refund a payment. + description: Informs you of the outcome of a request to [refund a payment](https://docs.adyen.com/online-payments/refund). + operationId: post-REFUND + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + refund: + $ref: '#/components/examples/post-REFUND-refund' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + refund: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /REFUND_FAILED: + post: + tags: + - standard + summary: Informs you that the refund failed due to a technical issue. + description: Informs you that the refund failed due to a [technical issue](https://docs.adyen.com/online-payments/refund#failed-refund). + operationId: post-REFUND_FAILED + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + refund_failed: + $ref: '#/components/examples/post-REFUND_FAILED-refund_failed' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + refund_failed: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /REFUND_REVERSED: + post: + tags: + - standard + summary: Informs you that the refunded amount has been returned to Adyen, and + is back in your account. + description: Informs you that the refunded amount has been returned to Adyen, + and is back in your account. + operationId: post-REFUND_REVERSED + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + refund_reversed: + $ref: '#/components/examples/post-REFUND_REVERSED-refund_reversed' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + refund_reversed: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /REFUND_WITH_DATA: + post: + tags: + - standard + summary: Informs you of the outcome of a request to refund with data. + description: Informs you of the outcome of a request to [refund with data](https://docs.adyen.com/online-payments/refund#unreferenced-refund). + operationId: post-REFUND_WITH_DATA + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + refund_with_data: + $ref: '#/components/examples/post-REFUND_WITH_DATA-refund_with_data' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + refund_with_data: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /REPORT_AVAILABLE: + post: + tags: + - standard + summary: Informs you that a new report is available. + description: Informs you that a [new report](https://docs.adyen.com/reporting/downloading-reports#automate-downloading-reports) + is available. + operationId: post-REPORT_AVAILABLE + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + report_available: + $ref: '#/components/examples/post-REPORT_AVAILABLE-report_available' + schema: + $ref: '#/components/schemas/ReportAvailableNotificationRequest' + responses: + '200': + content: + application/json: + examples: + report_available: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /REQUEST_FOR_INFORMATION: + post: + tags: + - dispute + summary: Informs you that a shopper has opened an RFI. + description: Informs you that a shopper has opened an RFI (Request for Information) + case with the bank. You should [supply defense documents](https://docs.adyen.com/risk-management/disputes-api#supply-dispute-defense-documents) + to help shopper understand the charge. + operationId: post-REQUEST_FOR_INFORMATION + x-groupName: dispute + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + request_for_information: + $ref: '#/components/examples/post-REQUEST_FOR_INFORMATION-request_for_information' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + request_for_information: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /SECOND_CHARGEBACK: + post: + tags: + - dispute + summary: Informs you that the issuing bank has declined the defense documents. + description: Informs you that the issuing bank has declined the material submitted + during defense of the original chargeback. The disputed amount is deducted + from your account. + operationId: post-SECOND_CHARGEBACK + x-groupName: dispute + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + second_chargeback: + $ref: '#/components/examples/post-SECOND_CHARGEBACK-second_chargeback' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + second_chargeback: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /TECHNICAL_CANCEL: + post: + tags: + - standard + summary: Informs you of the outcome of the technical cancel request. + description: Informs you of the outcome of the [technical cancel](https://docs.adyen.com/online-payments/cancel#technical-cancel) + request. + operationId: post-TECHNICAL_CANCEL + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + technical_cancel: + $ref: '#/components/examples/post-TECHNICAL_CANCEL-technical_cancel' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + technical_cancel: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. + /VOID_PENDING_REFUND: + post: + tags: + - standard + summary: Informs you of the outcome of a request to cancel a POS refund. + description: Informs you of the outcome of a request to [cancel a POS refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request). + operationId: post-VOID_PENDING_REFUND + x-groupName: standard + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + void_pending_refund: + $ref: '#/components/examples/post-VOID_PENDING_REFUND-void_pending_refund' + schema: + $ref: '#/components/schemas/NotificationRequest' + responses: + '200': + content: + application/json: + examples: + void_pending_refund: + $ref: '#/components/examples/WebhookAck' + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. +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 amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - value + - currency + AuthorisationNotificationAdditionalData: + properties: + authCode: + description: When the payment is authorised successfully, this fields holds + the authorisation code for the payment, otherwise it's empty. + type: string + authorisedAmountCurrency: + description: Currency of the authorised amount. + type: string + authorisedAmountValue: + description: 'Value of the amount authorised. : a bunch more information' + type: string + cardSummary: + description: Returns the last 4 digits of the credit card. + type: string + expiryDate: + description: Returns the card expiry date. + type: string + iDealConsumerAccountNumber: + description: Only included for iDeal payments. + type: string + iDealConsumerBIC: + description: Only included for iDeal payments. + type: string + iDealConsumerCity: + description: Only included for iDeal payments. + type: string + iDealConsumerIBAN: + description: Only included for iDeal payments. + type: string + iDealConsumerIban: + description: Only included for iDeal payments. + type: string + iDealConsumerName: + description: Only included for iDeal payments. + type: string + iDealTransactionId: + description: Only included for iDeal payments. + type: string + AuthorisationNotificationRequest: + properties: + live: + description: Informs about the origin of the notification. The value is + `true` when originating from the live environment, `false` for the test + environment. + type: boolean + notificationItems: + description: A container object for the details included in the notification. + items: + $ref: '#/components/schemas/AuthorisationNotificationRequestItem' + type: array + AuthorisationNotificationRequestItem: + properties: + additionalData: + description: This object is a generic container that can hold extra fields. + $ref: '#/components/schemas/AuthorisationNotificationAdditionalData' + amount: + description: A container object vor the payable amount information for the + transaction. For HTTP POST notifications, currency and value are returned + as URL parameters. + $ref: '#/components/schemas/Amount' + eventCode: + description: 'The type of event the notification item refers to. + : This equals the name of the ''endpoint''.' + type: string + eventDate: + description: 'The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD' + example: '2021-07-17T13:42:40+01:00' + format: date-time + type: string + merchantAccountCode: + description: The merchant account identifier used in the transaction the + notification item refers to. + type: string + merchantReference: + description: A reference to uniquely identify the payment. + type: string + operations: + description: 'The operations indicate the supported follow-up actions concerning + the payment. + + > This is an **experimental field**. Do not base your code on this field. + Not all specific cases are covered yet. It''s possible that the field + is empty or contains generic information.' + enum: + - CAPTURE + - CANCEL + - REFUND + items: + type: string + type: string + paymentMethod: + description: The payment method used in the transaction. + example: visa, mc, iDeal + type: string + pspReference: + description: Adyen's 16-character unique reference associated with the transaction/the + request. This value is globally unique; quote it when communicating with + us about this request. + type: string + reason: + description: "If `success` = `true` and `paymentMethod` = `visa`, `mc`,\ + \ or `amex` then this field contains the following details: \nAuhtorisation\ + \ code, last 4 digits of the card, card expiry date. \n In case of failure,\ + \ this contains information about the authorisation failure" + example: 874574:1935:11/2012 + type: string + success: + description: "If `true`: The payment request was successful. \n If `false`:\ + \ The payment request failed. \n Check the `reason` field for failure\ + \ information." + type: string + required: + - pspReference + - merchantReference + - merchantAccountCode + - eventDate + - eventCode + - amount + - paymentMethod + - success + - operations + NotificationAdditionalData: + properties: + authCode: + description: When the payment is authorised successfully, this fields holds + the authorisation code for the payment, otherwise it's empty. + type: string + authorisedAmountCurrency: + description: Currency of the authorised amount. + type: string + authorisedAmountValue: + description: 'Value of the amount authorised. : a bunch more information' + type: string + cardSummary: + description: Returns the last 4 digits of the credit card. + type: string + expiryDate: + description: Returns the card expiry date. + type: string + NotificationRequest: + properties: + live: + description: Informs about the origin of the notification. The value is + `true` when originating from the live environment, `false` for the test + environment. + type: boolean + notificationItems: + description: A container object for the details included in the notification. + items: + $ref: '#/components/schemas/NotificationRequestItem' + type: array + NotificationRequestItem: + properties: + additionalData: + description: This object is a generic container that can hold extra fields. + $ref: '#/components/schemas/NotificationAdditionalData' + amount: + description: A container object vor the payable amount information for the + transaction. For HTTP POST notifications, currency and value are returned + as URL parameters. + $ref: '#/components/schemas/Amount' + eventCode: + description: 'The type of event the notification item refers to. + : This equals the name of the ''endpoint''.' + type: string + eventDate: + description: 'The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD' + example: '2021-07-17T13:42:40+01:00' + format: date-time + type: string + merchantAccountCode: + description: The merchant account identifier used in the transaction the + notification item refers to. + type: string + merchantReference: + description: A reference to uniquely identify the payment. + type: string + paymentMethod: + description: The payment method used in the transaction. + example: visa, mc, iDeal + type: string + pspReference: + description: Adyen's 16-character unique reference associated with the transaction/the + request. This value is globally unique; quote it when communicating with + us about this request. + type: string + reason: + description: If `success` = `false`, then this includes a short message + with an explanation for the refusal. + type: string + success: + description: "Informs about the outcome of the event (`eventCode`) the notification\ + \ refers to. \nIf `true`: the event the notification refers to was executed\ + \ successfully. \nIf `false`: the event was not executed successfully." + type: boolean + required: + - pspReference + - merchantReference + - merchantAccountCode + - eventDate + - eventCode + - amount + - success + - paymentMethod + NotificationResponse: + properties: + notificationResponse: + description: Set this parameter to **[accepted]** to acknowledge that you + received a notification from Adyen. + type: string + PaidoutReversedNotificationRequest: + properties: + live: + description: Informs about the origin of the notification. The value is + `true` when originating from the live environment, `false` for the test + environment. + type: boolean + notificationItems: + description: A container object for the details included in the notification. + items: + $ref: '#/components/schemas/PaidoutReversedNotificationRequestItem' + type: array + PaidoutReversedNotificationRequestItem: + properties: + additionalData: + description: This object is a generic container that can hold extra fields. + $ref: '#/components/schemas/NotificationAdditionalData' + amount: + description: A container object vor the payable amount information for the + transaction. For HTTP POST notifications, currency and value are returned + as URL parameters. + $ref: '#/components/schemas/Amount' + eventCode: + description: 'The type of event the notification item refers to. + : This equals the name of the ''endpoint''.' + type: string + eventDate: + description: 'The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD' + example: '2021-07-17T13:42:40+01:00' + format: date-time + type: string + merchantAccountCode: + description: The merchant account identifier used in the transaction the + notification item refers to. + type: string + merchantReference: + description: A reference to uniquely identify the payment. + type: string + paymentMethod: + description: The payment method used in the transaction. + example: visa, mc, iDeal + type: string + pspReference: + description: The PSP reference for the Capture's PSP reference. + type: string + reason: + description: Contains the bank statement description if present, else it + contains `PaidOutReversed`. + type: string + success: + description: "Informs about the outcome of the event (`eventCode`) the notification\ + \ refers to. \nIf `true`: the event the notification refers to was executed\ + \ successfully. \nIf `false`: the event was not executed successfully." + type: boolean + required: + - merchantReference + - merchantAccountCode + - eventDate + - eventCode + - amount + - success + - paymentMethod + - pspReference + RecurringContractNoficationRequestItem: + properties: + additionalData: + description: This object is a generic container that can hold extra fields. + $ref: '#/components/schemas/RecurringContractNotificationAdditionalData' + amount: + description: A container object vor the payable amount information for the + transaction. For HTTP POST notifications, currency and value are returned + as URL parameters. + $ref: '#/components/schemas/Amount' + eventCode: + description: 'The type of event the notification item refers to. + : This equals the name of the ''endpoint''.' + type: string + eventDate: + description: 'The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD' + example: '2021-07-17T13:42:40+01:00' + format: date-time + type: string + merchantAccountCode: + description: The merchant account identifier used in the transaction the + notification item refers to. + type: string + merchantReference: + description: A reference to uniquely identify the payment. + type: string + paymentMethod: + description: The payment method used in the transaction. + example: visa, mc, iDeal + type: string + pspReference: + description: Adyen's 16-character unique reference associated with the transaction/the + request. This value is globally unique; quote it when communicating with + us about this request. + type: string + reason: + description: If `success` = `false`, then this includes a short message + with an explanation for the refusal. + type: string + success: + description: "Informs about the outcome of the event (`eventCode`) the notification\ + \ refers to. \nIf `true`: the event the notification refers to was executed\ + \ successfully. \nIf `false`: the event was not executed successfully." + type: boolean + required: + - pspReference + - merchantReference + - merchantAccountCode + - eventDate + - eventCode + - amount + - success + - paymentMethod + RecurringContractNotificationAdditionalData: + properties: + authCode: + description: When the payment is authorised successfully, this fields holds + the authorisation code for the payment, otherwise it's empty. + type: string + authorisedAmountCurrency: + description: Currency of the authorised amount. + type: string + authorisedAmountValue: + description: 'Value of the amount authorised. : a bunch more information' + type: string + cardSummary: + description: Returns the last 4 digits of the credit card. + type: string + expiryDate: + description: Returns the card expiry date. + type: string + shopperEmail: + description: The shopper's email address. + type: string + shopperReference: + description: The ID that uniquely identifies the shopper. The `shopperReference` + is the same as the `shopperReference` used in the initial payment. + type: string + RecurringContractNotificationRequest: + properties: + live: + description: Informs about the origin of the notification. The value is + `true` when originating from the live environment, `false` for the test + environment. + type: boolean + notificationItems: + description: A container object for the details included in the notification. + items: + $ref: '#/components/schemas/RecurringContractNoficationRequestItem' + type: array + ReportAvailableNotificationRequest: + properties: + live: + description: Informs about the origin of the notification. The value is + `true` when originating from the live environment, `false` for the test + environment. + type: boolean + notificationItems: + description: A container object for the details included in the notification. + items: + $ref: '#/components/schemas/ReportAvailableNotificationRequestItem' + type: array + ReportAvailableNotificationRequestItem: + properties: + additionalData: + description: This object is a generic container that can hold extra fields. + $ref: '#/components/schemas/NotificationAdditionalData' + amount: + description: A container object vor the payable amount information for the + transaction. For HTTP POST notifications, currency and value are returned + as URL parameters. + $ref: '#/components/schemas/Amount' + eventCode: + description: 'The type of event the notification item refers to. + : This equals the name of the ''endpoint''.' + type: string + eventDate: + description: 'The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD' + example: '2021-07-17T13:42:40+01:00' + format: date-time + type: string + merchantAccountCode: + description: The merchant account identifier used in the transaction the + notification item refers to. + type: string + merchantReference: + description: A reference to uniquely identify the payment. + type: string + paymentMethod: + description: The payment method used in the transaction. + example: visa, mc, iDeal + type: string + pspReference: + description: Contains the file name of the report. + type: string + reason: + description: Contains the download URL where you can obtain a copy of the + report. + type: string + success: + description: Always `true`. + type: string + required: + - merchantReference + - merchantAccountCode + - eventDate + - eventCode + - amount + - paymentMethod + - reason + - success + - pspReference + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: + WebhookAck: + summary: Acknowledge Webhook + value: + notificationResponse: '[accepted]' + post-AUTHORISATION-authorisation: + summary: AUTHORISATION example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + recurring.recurringDetailReference: '9915692881181044' + recurring.shopperReference: YOUR_SHOPPER_REFERENCE + amount: + currency: EUR + value: 1000 + eventCode: AUTHORISATION + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + paymentMethod: ach + pspReference: YOUR_PSP_REFERENCE + reason: 'null' + success: 'true' + post-AUTHORISATION_ADJUSTMENT-authorisation_adjustment: + summary: AUTHORISATION_ADJUSTMENT example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: AUTHORISATION_ADJUSTMENT + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: visa + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-AUTORESCUE-autorescue: + summary: AUTORESCUE example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + retry.rescueReference: '8826173525728789' + merchantOrderReference: '8826173525728789' + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + amount: + currency: EUR + value: 1000 + eventCode: AUTORESCUE + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-CANCELLATION-cancellation: + summary: CANCELLATION example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: CANCELLATION + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: visa + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-CANCEL_AUTORESCUE-cancel_autorescue: + summary: CANCEL_AUTORESCUE example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + amount: + currency: EUR + value: 1000 + eventCode: CANCEL_AUTORESCUE + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + pspReference: YOUR_PSP_REFERENCE + reason: No AutoRescue process for retry.rescueReference 8826173525728789 + success: 'false' + post-CANCEL_OR_REFUND-cancel_or_refund: + summary: CANCEL_OR_REFUND example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + modification.action: cancel + amount: + currency: EUR + value: 1000 + eventCode: CANCEL_OR_REFUND + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: visa + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-CAPTURE-capture: + summary: CAPTURE example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: CAPTURE + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: visa + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-CAPTURE_FAILED-capture_failed: + summary: CAPTURE_FAILED example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + paymentMethodVariant: facilypay_3x + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + shopperCountry: NL + amount: + currency: EUR + value: 1000 + eventCode: CAPTURE_FAILED + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: facilypay_3x + pspReference: YOUR_PSP_REFERENCE + reason: Capture Failed + success: 'true' + post-CHARGEBACK-chargeback: + summary: CHARGEBACK example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + captureMerchantReference: shopperReferenceTest + chargebackReasonCode: ' 4853' + InvoiceCreditorAccount: Creditor.AdyenInvoiceService + grossCurrency: EUR + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + defensePeriodEndsAt: '2021-07-31T03:03:07+02:00' + defendable: 'true' + grossValue: '2000' + modificationMerchantReferences: shopperReferenceTest + chargebackSchemeCode: mc + capturePspReference: '8636172945333378' + paymentMethodVariant: mc + shopperReference: '123456' + amount: + currency: EUR + value: 1000 + eventCode: CHARGEBACK + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: mc + pspReference: YOUR_PSP_REFERENCE + reason: Payment.TxId=300000000524534724 dispute + success: 'true' + post-CHARGEBACK_REVERSED-chargeback_reversed: + summary: CHARGEBACK_REVERSED example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + amount: + currency: EUR + value: 1000 + eventCode: CHARGEBACK_REVERSED + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + paymentMethod: mc + pspReference: YOUR_PSP_REFERENCE + reason: Fraudulent Processing of Transactions + success: 'true' + post-MANUAL_REVIEW_ACCEPT-manual_review_accept: + summary: MANUAL_REVIEW_ACCEPT example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + paymentMethodVariant: scheme + amount: + currency: EUR + value: 1000 + eventCode: MANUAL_REVIEW_ACCEPT + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + pspReference: YOUR_PSP_REFERENCE + reason: expire + success: 'true' + post-MANUAL_REVIEW_REJECT-manual_review_reject: + summary: MANUAL_REVIEW_REJECT example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + paymentMethodVariant: visa + amount: + currency: EUR + value: 1000 + eventCode: MANUAL_REVIEW_REJECT + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: visa + pspReference: YOUR_PSP_REFERENCE + reason: expire + success: 'true' + post-NOTIFICATION_OF_CHARGEBACK-notification_of_chargeback: + summary: NOTIFICATION_OF_CHARGEBACK example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + captureMerchantReference: shopperReferenceTest + chargebackReasonCode: ' 4853' + grossCurrency: EUR + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + defensePeriodEndsAt: '2021-07-31T03:03:08+02:00' + defendable: 'false' + grossValue: '2000' + modificationMerchantReferences: YourModificationReference,shopperReferenceTest + chargebackSchemeCode: mc + capturePspReference: '8536173024791891' + autoDefended: 'true' + paymentMethodVariant: mc + amount: + currency: EUR + value: 1000 + eventCode: NOTIFICATION_OF_CHARGEBACK + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: mc + pspReference: YOUR_PSP_REFERENCE + reason: Payment.TxId=300000000524659113 dispute (automatically defended) + success: 'true' + post-NOTIFICATION_OF_FRAUD-notification_of_fraud: + summary: NOTIFICATION_OF_FRAUD example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + nofReasonCode: '6' + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + modificationMerchantReferences: shopperReferenceTest + nofSchemeCode: visa + amount: + currency: EUR + value: 1000 + eventCode: NOTIFICATION_OF_FRAUD + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: visa + pspReference: YOUR_PSP_REFERENCE + reason: Fraudulent Use of Account Number + success: 'true' + post-OFFER_CLOSED-offer_closed: + summary: OFFER_CLOSED example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + paymentMethodVariant: ideal + amount: + currency: EUR + value: 1000 + eventCode: OFFER_CLOSED + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + paymentMethod: ideal + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-ORDER_CLOSED-order_closed: + summary: ORDER_CLOSED example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + order-1-pspReference: 861617275047284E + order-1-paymentAmount: EUR 10.00 + order-1-success: 'true' + order-1-paymentMethod: ideal + amount: + currency: EUR + value: 1000 + eventCode: ORDER_CLOSED + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'false' + post-ORDER_OPENED-order_opened: + summary: ORDER_OPENED example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: ORDER_OPENED + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-PAIDOUT_REVERSED-paidout_reversed: + summary: PAIDOUT_REVERSED example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: PAIDOUT_REVERSED + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-PAYOUT_DECLINE-payout_decline: + summary: PAYOUT_DECLINE example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + paymentMethodVariant: bankTransfer_IBAN + amount: + currency: EUR + value: 1000 + eventCode: PAYOUT_DECLINE + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: bankTransfer_IBAN + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-PAYOUT_EXPIRE-payout_expire: + summary: PAYOUT_EXPIRE example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: PAYOUT_EXPIRE + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: bankTransfer_IBAN + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-PAYOUT_THIRDPARTY-payout_thirdparty: + summary: PAYOUT_THIRDPARTY example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + expiryDate: 03/2030 + paymentMethodVariant: visa + cardSummary: '1111' + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + amount: + currency: EUR + value: 1000 + eventCode: PAYOUT_THIRDPARTY + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + paymentMethod: visa + pspReference: YOUR_PSP_REFERENCE + reason: Approved + success: 'true' + post-POSTPONED_REFUND-postponed_refund: + summary: POSTPONED_REFUND example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + amount: + currency: EUR + value: 1000 + eventCode: POSTPONED_REFUND + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: directdebit_NL + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-PREARBITRATION_LOST-prearbitration_lost: + summary: PREARBITRATION_LOST example + value: + live: 'true' + notificationItems: + - NotificationRequestItem: + additionalData: + metadata.type: web_pay + metadata.link_id: '111111' + arn: ACQUIRER_REFERENCE_NUMBER + metadata.company: abc + amount: + currency: EUR + value: 1000 + eventCode: PREARBITRATION_LOST + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + paymentMethod: visa + pspReference: YOUR_PSP_REFERENCE + reason: Other Fraud-Card Absent Environment + success: 'true' + post-PREARBITRATION_WON-prearbitration_won: + summary: PREARBITRATION_WON example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: PREARBITRATION_WON + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + paymentMethod: bankTransfer_IBAN + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-RECURRING_CONTRACT-recurring_contract: + summary: RECURRING_CONTRACT example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + shopperEmail: s.hopper@adyen.com + paymentMethodVariant: ideal + paymentLinkId: PL50C5F751CED39G71 + shopperReference: YOU_SHOPPER_REFERENCE + amount: + currency: EUR + value: 1000 + eventCode: RECURRING_CONTRACT + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: ideal + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-REFUND-refund: + summary: REFUND example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: REFUND + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: visa + pspReference: YOUR_PSP_REFERENCE + reason: Transaction hasn't been captured, refund not possible + success: 'false' + post-REFUND_FAILED-refund_failed: + summary: REFUND_FAILED example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + paymentMethodVariant: blik + amount: + currency: EUR + value: 1000 + eventCode: REFUND_FAILED + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: blik + pspReference: YOUR_PSP_REFERENCE + reason: Refund Failed + success: 'true' + post-REFUND_REVERSED-refund_reversed: + summary: REFUNDED_REVERSED example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: REFUNDED_REVERSED + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: mc + pspReference: YOUR_PSP_REFERENCE + reason: test_AUTHORISATION_1 + success: 'true' + post-REFUND_WITH_DATA-refund_with_data: + summary: REFUND_WITH_DATA example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + amount: + currency: EUR + value: 1000 + eventCode: REFUND_WITH_DATA + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MODIFICATION_REFERENCE + originalReference: '9913140798220028' + paymentMethod: mc + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-REPORT_AVAILABLE-report_available: + summary: REPORT_AVAILABLE example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + amount: + currency: EUR + value: 1000 + eventCode: REPORT_AVAILABLE + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: '' + pspReference: YOUR_PSP_REFERENCE + reason: URL_TO_DOWNLOAD_REPORT + success: 'true' + post-REQUEST_FOR_INFORMATION-request_for_information: + summary: REQUEST_FOR_INFORMATION example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + hmacSignature: b0ea55c2fe60d4d1d605e9c385e0e7... + modificationMerchantReferences: '9123140123220028' + amount: + currency: EUR + value: 1000 + eventCode: REQUEST_FOR_INFORMATION + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: mc + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true' + post-SECOND_CHARGEBACK-second_chargeback: + summary: SECOND_CHARGEBACK example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + chargebackReasonCode: '502' + modificationMerchantReferences: shopperReferenceTest + chargebackSchemeCode: jcb + amount: + currency: EUR + value: 1000 + eventCode: SECOND_CHARGEBACK + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + paymentMethod: jcb + pspReference: YOUR_PSP_REFERENCE + reason: 502:Cardmember Dispute + success: 'true' + post-TECHNICAL_CANCEL-technical_cancel: + summary: TECHNICAL_CANCEL example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + paymentMethodVariant: visa + amount: + currency: EUR + value: 1000 + eventCode: TECHNICAL_CANCEL + eventDate: '2018-07-18T22:35:14+02:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_ORIGINAL_REFERENCE + originalReference: '8313547924770610' + paymentMethod: visa + pspReference: '8515208516304269' + reason: '' + success: 'true' + post-VOID_PENDING_REFUND-void_pending_refund: + summary: VOID_PENDING_REFUND example + value: + live: 'false' + notificationItems: + - NotificationRequestItem: + additionalData: + paymentMethodVariant: mc + amount: + currency: EUR + value: 1000 + eventCode: VOID_PENDING_REFUND + eventDate: '2021-01-01T01:00:00+01:00' + merchantAccountCode: YOUR_MERCHANT_ACCOUNT + merchantReference: YOUR_MERCHANT_REFERENCE + originalReference: '9913140798220028' + paymentMethod: mc + pspReference: YOUR_PSP_REFERENCE + reason: '' + success: 'true'