diff --git a/yaml/AccountService-v3.yaml b/yaml/AccountService-v3.yaml index 4b4bfea..e050021 100644 --- a/yaml/AccountService-v3.yaml +++ b/yaml/AccountService-v3.yaml @@ -948,14 +948,14 @@ paths: content: application/json: examples: - general: - $ref: '#/components/examples/post-updateAccountHolder-general' - bankAccountDetails: - $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' addShareholders: $ref: '#/components/examples/post-updateAccountHolder-addShareholders' + bankAccountDetails: + $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' businessDetails: $ref: '#/components/examples/post-updateAccountHolder-businessDetails' + general: + $ref: '#/components/examples/post-updateAccountHolder-general' schema: $ref: '#/components/schemas/UpdateAccountHolderRequest' responses: @@ -1941,6 +1941,9 @@ components: \ section for details on when a document should be submitted in order\ \ to verify a shareholder." type: string + signatoryCode: + description: The code of the signatory, to which the document applies + type: string required: - accountHolderCode - documentType @@ -2361,23 +2364,19 @@ components: description: "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**:\ \ Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in\ \ v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n * **CARD_VERIFICATION**\n\ - \n* **IDENTITY_VERIFICATION**\n\n* **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ - \ Used in v6 and later.\n\n* **NONPROFIT_VERIFICATION**\n\n " + \n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\ + \n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ + \ Used in v6 and later.\n\n* **PCI_VERIFICATION**" enum: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - type @@ -2403,6 +2402,16 @@ components: shareholderCode: description: The code of the shareholder to which the check applies. type: string + KYCSignatoryCheckResult: + properties: + checks: + description: A list of the checks and their statuses. + items: + $ref: '#/components/schemas/KYCCheckStatusData' + type: array + signatoryCode: + description: The code of the signatory to which the check applies. + type: string KYCVerificationResult2: properties: accountHolder: @@ -2418,6 +2427,11 @@ components: items: $ref: '#/components/schemas/KYCShareholderCheckResult' type: array + signatories: + description: The results of the checks on the signatories. + items: + $ref: '#/components/schemas/KYCSignatoryCheckResult' + type: array PayoutScheduleResponse: properties: nextScheduledPayout: diff --git a/yaml/AccountService-v4.yaml b/yaml/AccountService-v4.yaml index 6466225..39f8c2f 100644 --- a/yaml/AccountService-v4.yaml +++ b/yaml/AccountService-v4.yaml @@ -932,14 +932,14 @@ paths: content: application/json: examples: - general: - $ref: '#/components/examples/post-updateAccountHolder-general' - bankAccountDetails: - $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' addShareholders: $ref: '#/components/examples/post-updateAccountHolder-addShareholders' + bankAccountDetails: + $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' businessDetails: $ref: '#/components/examples/post-updateAccountHolder-businessDetails' + general: + $ref: '#/components/examples/post-updateAccountHolder-general' schema: $ref: '#/components/schemas/UpdateAccountHolderRequest' responses: @@ -1974,6 +1974,9 @@ components: \ section for details on when a document should be submitted in order\ \ to verify a shareholder." type: string + signatoryCode: + description: The code of the signatory, to which the document applies + type: string required: - accountHolderCode - documentType @@ -2407,23 +2410,19 @@ components: description: "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**:\ \ Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in\ \ v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n * **CARD_VERIFICATION**\n\ - \n* **IDENTITY_VERIFICATION**\n\n* **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ - \ Used in v6 and later.\n\n* **NONPROFIT_VERIFICATION**\n\n " + \n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\ + \n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ + \ Used in v6 and later.\n\n* **PCI_VERIFICATION**" enum: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - type @@ -2449,6 +2448,16 @@ components: shareholderCode: description: The code of the shareholder to which the check applies. type: string + KYCSignatoryCheckResult: + properties: + checks: + description: A list of the checks and their statuses. + items: + $ref: '#/components/schemas/KYCCheckStatusData' + type: array + signatoryCode: + description: The code of the signatory to which the check applies. + type: string KYCVerificationResult2: properties: accountHolder: @@ -2464,6 +2473,11 @@ components: items: $ref: '#/components/schemas/KYCShareholderCheckResult' type: array + signatories: + description: The results of the checks on the signatories. + items: + $ref: '#/components/schemas/KYCSignatoryCheckResult' + type: array PayoutScheduleResponse: properties: nextScheduledPayout: diff --git a/yaml/AccountService-v5.yaml b/yaml/AccountService-v5.yaml index 56b4cab..03b4336 100644 --- a/yaml/AccountService-v5.yaml +++ b/yaml/AccountService-v5.yaml @@ -1065,14 +1065,14 @@ paths: content: application/json: examples: - general: - $ref: '#/components/examples/post-updateAccountHolder-general' - bankAccountDetails: - $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' addShareholders: $ref: '#/components/examples/post-updateAccountHolder-addShareholders' + bankAccountDetails: + $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' businessDetails: $ref: '#/components/examples/post-updateAccountHolder-businessDetails' + general: + $ref: '#/components/examples/post-updateAccountHolder-general' schema: $ref: '#/components/schemas/UpdateAccountHolderRequest' responses: @@ -2238,6 +2238,9 @@ components: \ section for details on when a document should be submitted in order\ \ to verify a shareholder." type: string + signatoryCode: + description: The code of the signatory, to which the document applies + type: string required: - accountHolderCode - documentType @@ -2667,23 +2670,19 @@ components: description: "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**:\ \ Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in\ \ v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n * **CARD_VERIFICATION**\n\ - \n* **IDENTITY_VERIFICATION**\n\n* **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ - \ Used in v6 and later.\n\n* **NONPROFIT_VERIFICATION**\n\n " + \n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\ + \n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ + \ Used in v6 and later.\n\n* **PCI_VERIFICATION**" enum: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - type @@ -2710,6 +2709,16 @@ components: shareholderCode: description: The code of the shareholder to which the check applies. type: string + KYCSignatoryCheckResult: + properties: + checks: + description: A list of the checks and their statuses. + items: + $ref: '#/components/schemas/KYCCheckStatusData' + type: array + signatoryCode: + description: The code of the signatory to which the check applies. + type: string KYCVerificationResult2: properties: accountHolder: @@ -2731,6 +2740,11 @@ components: items: $ref: '#/components/schemas/KYCShareholderCheckResult' type: array + signatories: + description: The results of the checks on the signatories. + items: + $ref: '#/components/schemas/KYCSignatoryCheckResult' + type: array PayoutMethod: properties: merchantAccount: diff --git a/yaml/AccountService-v6.yaml b/yaml/AccountService-v6.yaml index 0f1798d..50db3b2 100644 --- a/yaml/AccountService-v6.yaml +++ b/yaml/AccountService-v6.yaml @@ -1065,14 +1065,14 @@ paths: content: application/json: examples: - general: - $ref: '#/components/examples/post-updateAccountHolder-general' - bankAccountDetails: - $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' addShareholders: $ref: '#/components/examples/post-updateAccountHolder-addShareholders' + bankAccountDetails: + $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' businessDetails: $ref: '#/components/examples/post-updateAccountHolder-businessDetails' + general: + $ref: '#/components/examples/post-updateAccountHolder-general' schema: $ref: '#/components/schemas/UpdateAccountHolderRequest' responses: @@ -2271,7 +2271,6 @@ components: \ to verify a shareholder." type: string signatoryCode: - x-addedInVersion: 6 description: The code of the signatory, to which the document applies type: string required: @@ -2687,23 +2686,19 @@ components: description: "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**:\ \ Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in\ \ v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n * **CARD_VERIFICATION**\n\ - \n* **IDENTITY_VERIFICATION**\n\n* **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ - \ Used in v6 and later.\n\n* **NONPROFIT_VERIFICATION**\n\n " + \n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\ + \n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ + \ Used in v6 and later.\n\n* **PCI_VERIFICATION**" enum: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - type @@ -2775,6 +2770,16 @@ components: shareholderCode: description: The code of the shareholder to which the check applies. type: string + KYCSignatoryCheckResult: + properties: + checks: + description: A list of the checks and their statuses. + items: + $ref: '#/components/schemas/KYCCheckStatusData' + type: array + signatoryCode: + description: The code of the signatory to which the check applies. + type: string KYCVerificationResult2: properties: accountHolder: @@ -2803,6 +2808,11 @@ components: items: $ref: '#/components/schemas/KYCShareholderCheckResult' type: array + signatories: + description: The results of the checks on the signatories. + items: + $ref: '#/components/schemas/KYCSignatoryCheckResult' + type: array LegalArrangementDetail: properties: address: diff --git a/yaml/BalancePlatformService-v1.yaml b/yaml/BalancePlatformService-v1.yaml index 0f8d6c0..49a395f 100644 --- a/yaml/BalancePlatformService-v1.yaml +++ b/yaml/BalancePlatformService-v1.yaml @@ -1462,10 +1462,10 @@ paths: content: application/json: examples: - createVirtualCard: - $ref: '#/components/examples/post-paymentInstruments-createVirtualCard' createPhysicalCard: $ref: '#/components/examples/post-paymentInstruments-createPhysicalCard' + createVirtualCard: + $ref: '#/components/examples/post-paymentInstruments-createVirtualCard' schema: $ref: '#/components/schemas/PaymentInstrumentInfo' responses: @@ -1607,10 +1607,10 @@ paths: content: application/json: examples: - updatePaymentInstrumentStatus: - $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus' updatePaymentInstrumentBalanceAccount: $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount' + updatePaymentInstrumentStatus: + $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus' schema: $ref: '#/components/schemas/PaymentInstrumentUpdateRequest' parameters: @@ -1661,10 +1661,10 @@ paths: content: application/json: examples: - invalidData-422: - $ref: '#/components/examples/patch-paymentInstruments-id-invalidData-422' generic-422: $ref: '#/components/examples/generic-422' + invalidData-422: + $ref: '#/components/examples/patch-paymentInstruments-id-invalidData-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -2538,12 +2538,11 @@ components: Balance: properties: available: - description: The remaining amount that is available for spending. + description: The remaining amount available for spending. format: int64 type: integer balance: - description: The total funds in the balance. This is the sum of the `reserved` - and the `available` amounts. + description: The total amount in the balance. format: int64 type: integer currency: @@ -2551,8 +2550,8 @@ components: of the balance. type: string reserved: - description: The amount that is already reserved for payments that have - been authorised, but have not been captured yet. + description: The amount reserved for payments that have been authorised, + but have not been captured yet. format: int64 type: integer required: @@ -2790,6 +2789,7 @@ components: >By default the primary account number will be masked. Only for single use virtual cards the full primary account number is returned.' + readOnly: true type: string required: - formFactor diff --git a/yaml/BinLookupService-v40.yaml b/yaml/BinLookupService-v40.yaml index 4ee524f..0e63750 100644 --- a/yaml/BinLookupService-v40.yaml +++ b/yaml/BinLookupService-v40.yaml @@ -104,16 +104,16 @@ paths: content: application/json: examples: - getCostEstimateMinimal: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal' getCostEstimate: $ref: '#/components/examples/post-getCostEstimate-getCostEstimate' - getCostEstimateRecurringContract: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateRecurringContract' - getCostEstimateMinimal3DS: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS' getCostEstimateEncryptedCard: $ref: '#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard' + getCostEstimateMinimal: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal' + getCostEstimateMinimal3DS: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS' + getCostEstimateRecurringContract: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateRecurringContract' schema: $ref: '#/components/schemas/CostEstimateRequest' responses: @@ -121,14 +121,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-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimate-200' schema: $ref: '#/components/schemas/CostEstimateResponse' description: OK - the request has succeeded. diff --git a/yaml/BinLookupService-v50.yaml b/yaml/BinLookupService-v50.yaml index 752e325..2418874 100644 --- a/yaml/BinLookupService-v50.yaml +++ b/yaml/BinLookupService-v50.yaml @@ -104,16 +104,16 @@ paths: content: application/json: examples: - getCostEstimateMinimal: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal' getCostEstimate: $ref: '#/components/examples/post-getCostEstimate-getCostEstimate' - getCostEstimateRecurringContract: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateRecurringContract' - getCostEstimateMinimal3DS: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS' getCostEstimateEncryptedCard: $ref: '#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard' + getCostEstimateMinimal: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal' + getCostEstimateMinimal3DS: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS' + getCostEstimateRecurringContract: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateRecurringContract' schema: $ref: '#/components/schemas/CostEstimateRequest' responses: @@ -121,14 +121,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-200: - $ref: '#/components/examples/post-getCostEstimate-getCostEstimate-200' schema: $ref: '#/components/schemas/CostEstimateResponse' description: OK - the request has succeeded. diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index c721526..af1f60b 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,14 +852,14 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: $ref: '#/components/examples/post-paymentSession-ios' + split: + $ref: '#/components/examples/post-paymentSession-split' + web: + $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -845,22 +943,22 @@ paths: content: application/json: examples: + applepay: + $ref: '#/components/examples/post-payments-applepay' 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' - applepay: - $ref: '#/components/examples/post-payments-applepay' - split: - $ref: '#/components/examples/post-payments-split' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' card-direct: $ref: '#/components/examples/post-payments-card-direct' card-securedfields: $ref: '#/components/examples/post-payments-card-securedfields' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + oneclick-securedfields: + $ref: '#/components/examples/post-payments-oneclick-securedfields' + split: + $ref: '#/components/examples/post-payments-split' schema: $ref: '#/components/schemas/PaymentRequest' parameters: @@ -872,10 +970,10 @@ paths: examples: card-3d-secure-direct-200: $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' - card-direct-200: - $ref: '#/components/examples/post-payments-card-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' schema: @@ -1094,6 +1192,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AchDetails: @@ -2982,6 +3586,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string threeDS2SdkVersion: description: Version of the 3D Secure 2 mobile SDK. maxLength: 12 @@ -3616,6 +4225,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -3779,6 +4447,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -4468,6 +5180,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5030,6 +5846,36 @@ components: items: $ref: '#/components/schemas/PaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: additionalData: @@ -5586,6 +6432,33 @@ components: - Refused - Success type: string + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -7124,6 +7997,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -7248,6 +8147,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -7257,8 +8161,8 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -7267,6 +8171,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 3070a07..86d934f 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,34 +947,34 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' schema: @@ -890,20 +988,20 @@ paths: 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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -1120,6 +1218,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3210,6 +3814,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string threeDS2SdkVersion: description: Version of the 3D Secure 2 mobile SDK. maxLength: 12 @@ -3869,6 +4478,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4032,6 +4700,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -4847,6 +5559,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5413,6 +6229,36 @@ components: items: $ref: '#/components/schemas/PaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6010,6 +6856,33 @@ components: - Refused - Success type: string + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -7575,6 +8448,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -7820,6 +8719,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -7829,8 +8733,8 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -7839,6 +8743,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index b72d650..6cf40b6 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,38 +947,38 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' schema: @@ -892,24 +990,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -981,14 +1079,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1130,6 +1228,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3220,6 +3824,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string threeDS2SdkVersion: description: Version of the 3D Secure 2 mobile SDK. maxLength: 12 @@ -3879,6 +4488,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4042,6 +4710,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -4857,6 +5569,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5427,6 +6243,36 @@ components: items: $ref: '#/components/schemas/PaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6028,6 +6874,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -7593,6 +8466,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -7864,6 +8763,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -7873,8 +8777,8 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -7883,6 +8787,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index c82b4e5..f650833 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,38 +947,38 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' schema: @@ -892,24 +990,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -981,14 +1079,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1130,6 +1228,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3220,6 +3824,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string threeDS2SdkVersion: description: Version of the 3D Secure 2 mobile SDK. maxLength: 12 @@ -3879,6 +4488,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4042,6 +4710,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -4857,6 +5569,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5427,6 +6243,36 @@ components: items: $ref: '#/components/schemas/PaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6028,6 +6874,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -7601,6 +8474,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -7872,6 +8771,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: description: This is the `recurringDetailReference` returned in the response when you created the token. @@ -7881,8 +8785,8 @@ components: when you requested to notify the shopper. Used for recurring payment only. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -7891,6 +8795,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index 9e2bb3a..648f36f 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,38 +947,38 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' schema: @@ -892,24 +990,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -981,14 +1079,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1130,6 +1228,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3263,6 +3867,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string storedPaymentMethodId: x-addedInVersion: 49 description: This is the `recurringDetailReference` returned in the response @@ -4234,6 +4843,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4397,6 +5065,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -5276,6 +5988,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5864,6 +6680,36 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6500,6 +7346,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -8113,6 +8986,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -8471,6 +9370,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: deprecated: true x-deprecatedInVersion: 49 @@ -8488,8 +9392,8 @@ components: when you created the token. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -8498,6 +9402,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index d2bfdd5..4b0f613 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,42 +947,42 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentRequest' parameters: @@ -894,26 +992,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' subscription-first-transaction-200: $ref: '#/components/examples/post-payments-subscription-first-transaction-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -985,14 +1083,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1134,6 +1232,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3284,6 +3888,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string storedPaymentMethodId: x-addedInVersion: 49 description: This is the `recurringDetailReference` returned in the response @@ -4261,6 +4870,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4429,6 +5097,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -5308,6 +6020,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5901,6 +6717,36 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6543,6 +7389,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -8162,6 +9035,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -8538,6 +9437,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: deprecated: true x-deprecatedInVersion: 49 @@ -8555,8 +9459,8 @@ components: when you created the token. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -8565,6 +9469,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index c7ecf2a..82cf1ef 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,42 +947,42 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentRequest' parameters: @@ -894,28 +992,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' subscription-first-transaction-200: $ref: '#/components/examples/post-payments-subscription-first-transaction-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -987,14 +1085,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1136,6 +1234,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3286,6 +3890,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string storedPaymentMethodId: x-addedInVersion: 49 description: This is the `recurringDetailReference` returned in the response @@ -4269,6 +4878,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4437,6 +5105,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -5316,6 +6028,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5921,6 +6737,36 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6569,6 +7415,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -8194,6 +9067,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -8570,6 +9469,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: deprecated: true x-deprecatedInVersion: 49 @@ -8587,8 +9491,8 @@ components: when you created the token. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -8597,6 +9501,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 91882b8..f5e29b6 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,42 +947,42 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentRequest' parameters: @@ -894,28 +992,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' subscription-first-transaction-200: $ref: '#/components/examples/post-payments-subscription-first-transaction-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -987,14 +1085,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1136,6 +1234,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3286,6 +3890,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string storedPaymentMethodId: x-addedInVersion: 49 description: This is the `recurringDetailReference` returned in the response @@ -4269,6 +4878,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4437,6 +5105,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -5316,6 +6028,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5925,6 +6741,36 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6577,6 +7423,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -8202,6 +9075,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -8578,6 +9477,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: deprecated: true x-deprecatedInVersion: 49 @@ -8595,8 +9499,8 @@ components: when you created the token. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -8605,6 +9509,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index 47e94df..fe4ff7c 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,42 +947,42 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentRequest' parameters: @@ -894,28 +992,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' subscription-first-transaction-200: $ref: '#/components/examples/post-payments-subscription-first-transaction-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -987,14 +1085,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1136,6 +1234,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3286,6 +3890,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string storedPaymentMethodId: x-addedInVersion: 49 description: This is the `recurringDetailReference` returned in the response @@ -4269,6 +4878,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4437,6 +5105,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -5316,6 +6028,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5937,6 +6753,36 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6589,6 +7435,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -8220,6 +9093,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -8596,6 +9495,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: deprecated: true x-deprecatedInVersion: 49 @@ -8613,8 +9517,8 @@ components: when you created the token. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -8623,6 +9527,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index 2dee0eb..6f0bfe1 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,42 +947,42 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentRequest' parameters: @@ -894,28 +992,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' subscription-first-transaction-200: $ref: '#/components/examples/post-payments-subscription-first-transaction-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -987,14 +1085,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1136,6 +1234,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3286,6 +3890,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string storedPaymentMethodId: x-addedInVersion: 49 description: This is the `recurringDetailReference` returned in the response @@ -4269,6 +4878,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4437,6 +5105,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -5363,6 +6075,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -6003,6 +6819,36 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6669,6 +7515,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -8300,6 +9173,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -8676,6 +9575,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: deprecated: true x-deprecatedInVersion: 49 @@ -8693,8 +9597,8 @@ components: when you created the token. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -8703,6 +9607,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index aec3ed5..8dffd99 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,42 +947,42 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentRequest' parameters: @@ -894,28 +992,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' subscription-first-transaction-200: $ref: '#/components/examples/post-payments-subscription-first-transaction-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -987,14 +1085,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1136,6 +1234,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3298,6 +3902,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string storedPaymentMethodId: x-addedInVersion: 49 description: This is the `recurringDetailReference` returned in the response @@ -4280,6 +4889,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4452,6 +5120,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -5378,6 +6090,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5993,6 +6809,36 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6653,6 +7499,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -8289,6 +9162,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -8665,6 +9564,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: deprecated: true x-deprecatedInVersion: 49 @@ -8682,8 +9586,8 @@ components: when you created the token. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -8692,6 +9596,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index 6341456..9d97567 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -580,12 +678,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -597,10 +695,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -668,10 +766,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -754,16 +852,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -773,10 +871,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -849,42 +947,42 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentRequest' parameters: @@ -894,28 +992,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' subscription-first-transaction-200: $ref: '#/components/examples/post-payments-subscription-first-transaction-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -987,14 +1085,14 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' + 3d-secure: + $ref: '#/components/examples/post-payments-details-3d-secure' 3d-secure-2-challenge: $ref: '#/components/examples/post-payments-details-3d-secure-2-challenge' 3d-secure-2-fingerprint: $ref: '#/components/examples/post-payments-details-3d-secure-2-fingerprint' - 3d-secure: - $ref: '#/components/examples/post-payments-details-3d-secure' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1136,6 +1234,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3298,6 +3902,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string storedPaymentMethodId: x-addedInVersion: 49 description: This is the `recurringDetailReference` returned in the response @@ -4280,6 +4889,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4452,6 +5120,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -5378,6 +6090,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5997,6 +6813,36 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6661,6 +7507,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -8297,6 +9170,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -8673,6 +9572,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: deprecated: true x-deprecatedInVersion: 49 @@ -8690,8 +9594,8 @@ components: when you created the token. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -8700,6 +9604,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index f82d00a..53908a2 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -60,10 +60,108 @@ info: x-groups: - Payments - Payment links +- Modifications - Orders - Classic Checkout SDK - Utility paths: + /cancels: + post: + 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 + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /orders: post: summary: Creates an order for the given amount. @@ -582,12 +680,12 @@ paths: content: application/json: examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-oneclick: $ref: '#/components/examples/post-paymentMethods-include-oneclick' - basic: - $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' parameters: @@ -599,10 +697,10 @@ paths: examples: basic-200: $ref: '#/components/examples/post-paymentMethods-basic-200' - include-oneclick-200: - $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' filtered-200: $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. @@ -670,10 +768,10 @@ paths: content: application/json: examples: - plastix: - $ref: '#/components/examples/post-paymentMethods-balance-plastix' basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' parameters: @@ -756,16 +854,16 @@ paths: content: application/json: examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' - android: - $ref: '#/components/examples/post-paymentSession-android' - ios: - $ref: '#/components/examples/post-paymentSession-ios' - enableOneClick: - $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: @@ -775,10 +873,10 @@ paths: content: application/json: examples: - web-200: - $ref: '#/components/examples/post-paymentSession-web-200' enableOneClick-200: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. @@ -851,42 +949,42 @@ paths: content: application/json: examples: - giropay: - $ref: '#/components/examples/post-payments-giropay' - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' applepay: $ref: '#/components/examples/post-payments-applepay' + 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' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' ideal: $ref: '#/components/examples/post-payments-ideal' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' recurring: $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' sofort: $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' - card-3d-secure-direct: - $ref: '#/components/examples/post-payments-card-3d-secure-direct' - klarna: - $ref: '#/components/examples/post-payments-klarna' split: $ref: '#/components/examples/post-payments-split' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' schema: $ref: '#/components/schemas/PaymentRequest' parameters: @@ -896,28 +994,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' - enableOneClick-raw-200: - $ref: '#/components/examples/post-payments-enableOneClick-raw-200' - card-3d-secure-securedfields-200: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' sofort-200: $ref: '#/components/examples/post-payments-sofort-200' subscription-first-transaction-200: $ref: '#/components/examples/post-payments-subscription-first-transaction-200' - enableOneClick-SF-200: - $ref: '#/components/examples/post-payments-enableOneClick-SF-200' - card-securedfields-200: - $ref: '#/components/examples/post-payments-card-securedfields-200' - card-3d-secure-2-web-200: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. @@ -989,10 +1087,10 @@ paths: content: application/json: examples: - redirect: - $ref: '#/components/examples/post-payments-details-redirect' 3d-secure-2-native: $ref: '#/components/examples/post-payments-details-3d-secure-2-native' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' schema: $ref: '#/components/schemas/DetailsRequest' parameters: @@ -1134,6 +1232,512 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + 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 asynchronosly, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + 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 + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + 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 asynchronosly, in a\ + \ [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + 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\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + 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) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' + 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-500: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. components: schemas: AccountInfo: @@ -3296,6 +3900,11 @@ components: description: This is the `recurringDetailReference` returned in the response when you created the token. type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string storedPaymentMethodId: x-addedInVersion: 49 description: This is the `recurringDetailReference` returned in the response @@ -4257,6 +4866,65 @@ components: x-addedInVersion: 37 description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + required: + - merchantAccount + - amount + - reason + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4448,6 +5116,50 @@ components: - amount - reference - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference DetailsRequest: properties: details: @@ -5374,6 +6086,110 @@ components: required: - type title: PayU + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + - reason + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + 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). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentCompletionDetails: properties: MD: @@ -5947,6 +6763,36 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference PaymentRequest: properties: accountInfo: @@ -6570,6 +7416,33 @@ components: x-addedInVersion: 41 description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference PaymentSetupRequest: properties: additionalData: @@ -8206,6 +9079,32 @@ components: type: integer required: - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference StoredDetails: properties: bank: @@ -8613,6 +9512,11 @@ components: UpiDetails: additionalProperties: false properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string recurringDetailReference: deprecated: true x-deprecatedInVersion: 49 @@ -8630,8 +9534,8 @@ components: when you created the token. type: string type: - default: upi - description: '**upi**' + default: upi_collect + description: '**upi_collect**' enum: - upi_collect type: string @@ -8640,6 +9544,7 @@ components: type: string required: - type + - billingSequenceNumber title: UPI VippsDetails: additionalProperties: false diff --git a/yaml/HopService-v1.yaml b/yaml/HopService-v1.yaml index 6a4573f..3130ed9 100644 --- a/yaml/HopService-v1.yaml +++ b/yaml/HopService-v1.yaml @@ -5,20 +5,50 @@ info: version: '1' x-publicVersion: true title: 'Adyen for Platforms: Hosted Onboarding' - description: "Hosted Onboarding provides endpoints for using the Hosted Onboarding\ - \ Page. The related entities include account holders only. \nFor more information,\ - \ refer to our [documentation](https://docs.adyen.com/platforms/hosted-onboarding-page).\n\ - ## Authentication\nTo connect to the HOP API, you must use basic authentication\ - \ credentials of your web service user. If you don't have one, please contact\ - \ the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then\ - \ use its credentials to authenticate your request, for example:\n\n```\ncurl\n\ - -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\\n-H \"Content-Type:\ - \ application/json\" \\\n...\n```\nNote that when going live, you need to generate\ - \ new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ - \n## Versioning\nThe HOP API supports versioning of its endpoints through a version\ - \ suffix in the endpoint URL. This suffix has the following format: \"vXX\", where\ - \ XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl\n\ - ```" + description: 'The Hosted onboarding API provides endpoints that you can use to generate + links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/platforms/hosted-onboarding-page) + or a [PCI compliance questionnaire](https://docs.adyen.com/platforms/platforms-for-partners). + Then you can provide the link to your account holder so they can complete their + onboarding. + + + ## Authentication + + To connect to the Hosted onboarding API, you must use basic authentication credentials + of your web service user. If you don''t have one, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + Then use your credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@MarketPlace.YourMarketPlace":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + When going live, you need to generate new web service user credentials to access + the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + The Hosted onboarding API supports versioning of its endpoints through a version + suffix in the endpoint URL. This suffix has the following format: "vXX", where + XX is the version number. + + + For example: + + ``` + + https://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl + + ```' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -30,12 +60,10 @@ x-groups: paths: /getOnboardingUrl: post: - summary: Get a link to a Hosted Onboarding Page. - description: 'Returns a link to a Hosted Onboarding Page (HOP) to be used by - a specific account holder. Each account holder represents a single sub-merchant. - - - For more information on how to use HOP, refer to [Hosted Onboarding Page](https://docs.adyen.com/platforms/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 + to [Hosted onboarding](https://docs.adyen.com/platforms/hosted-onboarding-page). ' operationId: post-getOnboardingUrl x-groupName: Hosted Onboarding Page x-sortIndex: 1 @@ -83,10 +111,10 @@ paths: description: Internal Server Error - the server could not process the request. /getPciQuestionnaireUrl: post: - summary: Get a new PCI compliance questionnaire URL for an account holder. - description: 'This endpoint is used to get a new PCI compliance questionnaire - URL for a specific account holder. Each account holder represents a single - sub-merchant, and each sub-merchant must be represented by an account holder. ' + 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\ + \ have a [partner platform setup](https://docs.adyen.com/platforms/platforms-for-partners)." operationId: post-getPciQuestionnaireUrl x-groupName: PCI Compliance Questionnaire Page x-sortIndex: 1 @@ -334,10 +362,10 @@ components: description: The platform name which will show up in the welcome page. type: string returnUrl: - description: The URL where the sub-merchant will be redirected back to after - they complete the onboarding, or if their session times out. Maximum length - of 500 characters. If you don't provide this, the sub-merchant will be - redirected back to the default return URL configured in your platform + description: The URL where the account holder will be redirected back to + after they complete the onboarding, or if their session times out. Maximum + length of 500 characters. If you don't provide this, the account holder + will be redirected back to the default return URL configured in your platform account. type: string shopperLocale: @@ -350,7 +378,7 @@ components: type: string showPages: description: Contains indicators whether specific pages must be shown to - the account holder. By default, all pages are shown. + the account holder. $ref: '#/components/schemas/ShowPages' required: - accountHolderCode @@ -392,9 +420,9 @@ components: holder. type: string returnUrl: - description: The URL where the sub-merchant will be redirected back to after - they complete the onboarding, or if their session times out. Maximum length - of 500 characters. + description: The URL where the account holder will be redirected back to + after they fill out the questionnaire, or if their session times out. + Maximum length of 500 characters. type: string required: - accountHolderCode @@ -411,8 +439,8 @@ components: the request. type: string redirectUrl: - description: The URL to the PCI Compliance Questionnaire Page where you - should redirect your sub-merchant. This URL must be used within 30 seconds + description: The URL to the PCI compliance questionnaire where you should + redirect your account holder. This URL must be used within 30 seconds and can only be used once. type: string resultCode: @@ -467,7 +495,7 @@ components: type: boolean welcomePage: description: Indicates whether the welcome page must be shown. Defaults - to **true**. + to **false**. type: boolean securitySchemes: ApiKeyAuth: diff --git a/yaml/HopService-v5.yaml b/yaml/HopService-v5.yaml index 9ed546f..0ee57e1 100644 --- a/yaml/HopService-v5.yaml +++ b/yaml/HopService-v5.yaml @@ -5,20 +5,50 @@ info: version: '5' x-publicVersion: true title: 'Adyen for Platforms: Hosted Onboarding' - description: "Hosted Onboarding provides endpoints for using the Hosted Onboarding\ - \ Page. The related entities include account holders only. \nFor more information,\ - \ refer to our [documentation](https://docs.adyen.com/platforms/hosted-onboarding-page).\n\ - ## Authentication\nTo connect to the HOP API, you must use basic authentication\ - \ credentials of your web service user. If you don't have one, please contact\ - \ the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then\ - \ use its credentials to authenticate your request, for example:\n\n```\ncurl\n\ - -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\\n-H \"Content-Type:\ - \ application/json\" \\\n...\n```\nNote that when going live, you need to generate\ - \ new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ - \n## Versioning\nThe HOP API supports versioning of its endpoints through a version\ - \ suffix in the endpoint URL. This suffix has the following format: \"vXX\", where\ - \ XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v5/getOnboardingUrl\n\ - ```" + description: 'The Hosted onboarding API provides endpoints that you can use to generate + links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/platforms/hosted-onboarding-page) + or a [PCI compliance questionnaire](https://docs.adyen.com/platforms/platforms-for-partners). + Then you can provide the link to your account holder so they can complete their + onboarding. + + + ## Authentication + + To connect to the Hosted onboarding API, you must use basic authentication credentials + of your web service user. If you don''t have one, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + Then use your credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@MarketPlace.YourMarketPlace":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + When going live, you need to generate new web service user credentials to access + the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + The Hosted onboarding API supports versioning of its endpoints through a version + suffix in the endpoint URL. This suffix has the following format: "vXX", where + XX is the version number. + + + For example: + + ``` + + https://cal-test.adyen.com/cal/services/Hop/v5/getOnboardingUrl + + ```' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -30,12 +60,10 @@ x-groups: paths: /getOnboardingUrl: post: - summary: Get a link to a Hosted Onboarding Page. - description: 'Returns a link to a Hosted Onboarding Page (HOP) to be used by - a specific account holder. Each account holder represents a single sub-merchant. - - - For more information on how to use HOP, refer to [Hosted Onboarding Page](https://docs.adyen.com/platforms/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 + to [Hosted onboarding](https://docs.adyen.com/platforms/hosted-onboarding-page). ' operationId: post-getOnboardingUrl x-groupName: Hosted Onboarding Page x-sortIndex: 1 @@ -83,10 +111,10 @@ paths: description: Internal Server Error - the server could not process the request. /getPciQuestionnaireUrl: post: - summary: Get a new PCI compliance questionnaire URL for an account holder. - description: 'This endpoint is used to get a new PCI compliance questionnaire - URL for a specific account holder. Each account holder represents a single - sub-merchant, and each sub-merchant must be represented by an account holder. ' + 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\ + \ have a [partner platform setup](https://docs.adyen.com/platforms/platforms-for-partners)." operationId: post-getPciQuestionnaireUrl x-groupName: PCI Compliance Questionnaire Page x-sortIndex: 1 @@ -334,10 +362,10 @@ components: description: The platform name which will show up in the welcome page. type: string returnUrl: - description: The URL where the sub-merchant will be redirected back to after - they complete the onboarding, or if their session times out. Maximum length - of 500 characters. If you don't provide this, the sub-merchant will be - redirected back to the default return URL configured in your platform + description: The URL where the account holder will be redirected back to + after they complete the onboarding, or if their session times out. Maximum + length of 500 characters. If you don't provide this, the account holder + will be redirected back to the default return URL configured in your platform account. type: string shopperLocale: @@ -350,7 +378,7 @@ components: type: string showPages: description: Contains indicators whether specific pages must be shown to - the account holder. By default, all pages are shown. + the account holder. $ref: '#/components/schemas/ShowPages' required: - accountHolderCode @@ -381,9 +409,9 @@ components: holder. type: string returnUrl: - description: The URL where the sub-merchant will be redirected back to after - they complete the onboarding, or if their session times out. Maximum length - of 500 characters. + description: The URL where the account holder will be redirected back to + after they fill out the questionnaire, or if their session times out. + Maximum length of 500 characters. type: string required: - accountHolderCode @@ -400,8 +428,8 @@ components: the request. type: string redirectUrl: - description: The URL to the PCI Compliance Questionnaire Page where you - should redirect your sub-merchant. This URL must be used within 30 seconds + description: The URL to the PCI compliance questionnaire where you should + redirect your account holder. This URL must be used within 30 seconds and can only be used once. type: string resultCode: @@ -445,7 +473,7 @@ components: type: boolean welcomePage: description: Indicates whether the welcome page must be shown. Defaults - to **true**. + to **false**. type: boolean securitySchemes: ApiKeyAuth: diff --git a/yaml/HopService-v6.yaml b/yaml/HopService-v6.yaml index c68f531..cbb96c5 100644 --- a/yaml/HopService-v6.yaml +++ b/yaml/HopService-v6.yaml @@ -5,20 +5,50 @@ info: version: '6' x-publicVersion: true title: 'Adyen for Platforms: Hosted Onboarding' - description: "Hosted Onboarding provides endpoints for using the Hosted Onboarding\ - \ Page. The related entities include account holders only. \nFor more information,\ - \ refer to our [documentation](https://docs.adyen.com/platforms/hosted-onboarding-page).\n\ - ## Authentication\nTo connect to the HOP API, you must use basic authentication\ - \ credentials of your web service user. If you don't have one, please contact\ - \ the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then\ - \ use its credentials to authenticate your request, for example:\n\n```\ncurl\n\ - -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\\n-H \"Content-Type:\ - \ application/json\" \\\n...\n```\nNote that when going live, you need to generate\ - \ new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ - \n## Versioning\nThe HOP API supports versioning of its endpoints through a version\ - \ suffix in the endpoint URL. This suffix has the following format: \"vXX\", where\ - \ XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl\n\ - ```" + description: 'The Hosted onboarding API provides endpoints that you can use to generate + links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/platforms/hosted-onboarding-page) + or a [PCI compliance questionnaire](https://docs.adyen.com/platforms/platforms-for-partners). + Then you can provide the link to your account holder so they can complete their + onboarding. + + + ## Authentication + + To connect to the Hosted onboarding API, you must use basic authentication credentials + of your web service user. If you don''t have one, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + Then use your credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@MarketPlace.YourMarketPlace":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + When going live, you need to generate new web service user credentials to access + the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + The Hosted onboarding API supports versioning of its endpoints through a version + suffix in the endpoint URL. This suffix has the following format: "vXX", where + XX is the version number. + + + For example: + + ``` + + https://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl + + ```' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -30,12 +60,10 @@ x-groups: paths: /getOnboardingUrl: post: - summary: Get a link to a Hosted Onboarding Page. - description: 'Returns a link to a Hosted Onboarding Page (HOP) to be used by - a specific account holder. Each account holder represents a single sub-merchant. - - - For more information on how to use HOP, refer to [Hosted Onboarding Page](https://docs.adyen.com/platforms/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 + to [Hosted onboarding](https://docs.adyen.com/platforms/hosted-onboarding-page). ' operationId: post-getOnboardingUrl x-groupName: Hosted Onboarding Page x-sortIndex: 1 @@ -83,10 +111,10 @@ paths: description: Internal Server Error - the server could not process the request. /getPciQuestionnaireUrl: post: - summary: Get a new PCI compliance questionnaire URL for an account holder. - description: 'This endpoint is used to get a new PCI compliance questionnaire - URL for a specific account holder. Each account holder represents a single - sub-merchant, and each sub-merchant must be represented by an account holder. ' + 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\ + \ have a [partner platform setup](https://docs.adyen.com/platforms/platforms-for-partners)." operationId: post-getPciQuestionnaireUrl x-groupName: PCI Compliance Questionnaire Page x-sortIndex: 1 @@ -334,10 +362,10 @@ components: description: The platform name which will show up in the welcome page. type: string returnUrl: - description: The URL where the sub-merchant will be redirected back to after - they complete the onboarding, or if their session times out. Maximum length - of 500 characters. If you don't provide this, the sub-merchant will be - redirected back to the default return URL configured in your platform + description: The URL where the account holder will be redirected back to + after they complete the onboarding, or if their session times out. Maximum + length of 500 characters. If you don't provide this, the account holder + will be redirected back to the default return URL configured in your platform account. type: string shopperLocale: @@ -350,7 +378,7 @@ components: type: string showPages: description: Contains indicators whether specific pages must be shown to - the account holder. By default, all pages are shown. + the account holder. $ref: '#/components/schemas/ShowPages' required: - accountHolderCode @@ -381,9 +409,9 @@ components: holder. type: string returnUrl: - description: The URL where the sub-merchant will be redirected back to after - they complete the onboarding, or if their session times out. Maximum length - of 500 characters. + description: The URL where the account holder will be redirected back to + after they fill out the questionnaire, or if their session times out. + Maximum length of 500 characters. type: string required: - accountHolderCode @@ -400,8 +428,8 @@ components: the request. type: string redirectUrl: - description: The URL to the PCI Compliance Questionnaire Page where you - should redirect your sub-merchant. This URL must be used within 30 seconds + description: The URL to the PCI compliance questionnaire where you should + redirect your account holder. This URL must be used within 30 seconds and can only be used once. type: string resultCode: @@ -445,7 +473,7 @@ components: type: boolean welcomePage: description: Indicates whether the welcome page must be shown. Defaults - to **true**. + to **false**. type: boolean securitySchemes: ApiKeyAuth: diff --git a/yaml/MarketPayNotificationService-v3.yaml b/yaml/MarketPayNotificationService-v3.yaml index 28f5ae9..6f6e30f 100644 --- a/yaml/MarketPayNotificationService-v3.yaml +++ b/yaml/MarketPayNotificationService-v3.yaml @@ -19,9 +19,8 @@ x-groups: - Accounts - Fund management - Other -x-isWebhook: 'true' x-staticResponse: response.json -paths: +webhooks: /ACCOUNT_CLOSED: post: summary: Triggered upon the closure of an account. @@ -910,6 +909,9 @@ components: shareholderCode: description: The code of the shareholder that has been verified. type: string + signatoryCode: + description: The code of the signatory that has been verified. + type: string statusSummaryItems: deprecated: true description: A summary of the verification status. @@ -935,17 +937,12 @@ components: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - accountHolderCode @@ -1795,23 +1792,19 @@ components: description: "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**:\ \ Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in\ \ v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n * **CARD_VERIFICATION**\n\ - \n* **IDENTITY_VERIFICATION**\n\n* **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ - \ Used in v6 and later.\n\n* **NONPROFIT_VERIFICATION**\n\n " + \n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\ + \n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ + \ Used in v6 and later.\n\n* **PCI_VERIFICATION**" enum: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - type @@ -1837,6 +1830,16 @@ components: shareholderCode: description: The code of the shareholder to which the check applies. type: string + KYCSignatoryCheckResult: + properties: + checks: + description: A list of the checks and their statuses. + items: + $ref: '#/components/schemas/KYCCheckStatusData' + type: array + signatoryCode: + description: The code of the signatory to which the check applies. + type: string KYCVerificationResult2: properties: accountHolder: @@ -1852,6 +1855,11 @@ components: items: $ref: '#/components/schemas/KYCShareholderCheckResult' type: array + signatories: + description: The results of the checks on the signatories. + items: + $ref: '#/components/schemas/KYCSignatoryCheckResult' + type: array LocalDate: properties: month: diff --git a/yaml/MarketPayNotificationService-v4.yaml b/yaml/MarketPayNotificationService-v4.yaml index 9529147..f95e67e 100644 --- a/yaml/MarketPayNotificationService-v4.yaml +++ b/yaml/MarketPayNotificationService-v4.yaml @@ -19,9 +19,8 @@ x-groups: - Accounts - Fund management - Other -x-isWebhook: 'true' x-staticResponse: response.json -paths: +webhooks: /ACCOUNT_CLOSED: post: summary: Triggered upon the closure of an account. @@ -970,6 +969,9 @@ components: shareholderCode: description: The code of the shareholder that has been verified. type: string + signatoryCode: + description: The code of the signatory that has been verified. + type: string statusSummary: x-addedInVersion: 4 description: A summary of the verification status. @@ -993,17 +995,12 @@ components: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - accountHolderCode @@ -1891,23 +1888,19 @@ components: description: "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**:\ \ Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in\ \ v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n * **CARD_VERIFICATION**\n\ - \n* **IDENTITY_VERIFICATION**\n\n* **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ - \ Used in v6 and later.\n\n* **NONPROFIT_VERIFICATION**\n\n " + \n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\ + \n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ + \ Used in v6 and later.\n\n* **PCI_VERIFICATION**" enum: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - type @@ -1933,6 +1926,16 @@ components: shareholderCode: description: The code of the shareholder to which the check applies. type: string + KYCSignatoryCheckResult: + properties: + checks: + description: A list of the checks and their statuses. + items: + $ref: '#/components/schemas/KYCCheckStatusData' + type: array + signatoryCode: + description: The code of the signatory to which the check applies. + type: string KYCVerificationResult2: properties: accountHolder: @@ -1948,6 +1951,11 @@ components: items: $ref: '#/components/schemas/KYCShareholderCheckResult' type: array + signatories: + description: The results of the checks on the signatories. + items: + $ref: '#/components/schemas/KYCSignatoryCheckResult' + type: array LocalDate: properties: month: diff --git a/yaml/MarketPayNotificationService-v5.yaml b/yaml/MarketPayNotificationService-v5.yaml index f377f4a..7887244 100644 --- a/yaml/MarketPayNotificationService-v5.yaml +++ b/yaml/MarketPayNotificationService-v5.yaml @@ -19,9 +19,8 @@ x-groups: - Accounts - Fund management - Other -x-isWebhook: 'true' x-staticResponse: response.json -paths: +webhooks: /ACCOUNT_CLOSED: post: summary: Triggered upon the closure of an account. @@ -1124,6 +1123,9 @@ components: shareholderCode: description: The code of the shareholder that has been verified. type: string + signatoryCode: + description: The code of the signatory that has been verified. + type: string required: - accountHolderCode AccountPayoutState: @@ -2072,23 +2074,19 @@ components: description: "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**:\ \ Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in\ \ v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n * **CARD_VERIFICATION**\n\ - \n* **IDENTITY_VERIFICATION**\n\n* **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ - \ Used in v6 and later.\n\n* **NONPROFIT_VERIFICATION**\n\n " + \n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\ + \n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ + \ Used in v6 and later.\n\n* **PCI_VERIFICATION**" enum: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - type @@ -2115,6 +2113,16 @@ components: shareholderCode: description: The code of the shareholder to which the check applies. type: string + KYCSignatoryCheckResult: + properties: + checks: + description: A list of the checks and their statuses. + items: + $ref: '#/components/schemas/KYCCheckStatusData' + type: array + signatoryCode: + description: The code of the signatory to which the check applies. + type: string KYCVerificationResult2: properties: accountHolder: @@ -2136,6 +2144,11 @@ components: items: $ref: '#/components/schemas/KYCShareholderCheckResult' type: array + signatories: + description: The results of the checks on the signatories. + items: + $ref: '#/components/schemas/KYCSignatoryCheckResult' + type: array LocalDate: properties: month: diff --git a/yaml/MarketPayNotificationService-v6.yaml b/yaml/MarketPayNotificationService-v6.yaml index 6662383..46df0e7 100644 --- a/yaml/MarketPayNotificationService-v6.yaml +++ b/yaml/MarketPayNotificationService-v6.yaml @@ -19,9 +19,8 @@ x-groups: - Accounts - Fund management - Other -x-isWebhook: 'true' x-staticResponse: response.json -paths: +webhooks: /ACCOUNT_CLOSED: post: summary: Triggered upon the closure of an account. @@ -1164,6 +1163,9 @@ components: shareholderCode: description: The code of the shareholder that has been verified. type: string + signatoryCode: + description: The code of the signatory that has been verified. + type: string required: - accountHolderCode AccountPayoutState: @@ -2108,23 +2110,19 @@ components: description: "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**:\ \ Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in\ \ v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n * **CARD_VERIFICATION**\n\ - \n* **IDENTITY_VERIFICATION**\n\n* **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ - \ Used in v6 and later.\n\n* **NONPROFIT_VERIFICATION**\n\n " + \n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\ + \n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**:\ + \ Used in v6 and later.\n\n* **PCI_VERIFICATION**" enum: - BANK_ACCOUNT_VERIFICATION - CARD_VERIFICATION - COMPANY_VERIFICATION - - CRIMINAL_BACKGROUND_EXTENSIVE_VERIFICATION - - CRIMINAL_BACKGROUND_MEDIUM_VERIFICATION - IDENTITY_VERIFICATION - LEGAL_ARRANGEMENT_VERIFICATION - NONPROFIT_VERIFICATION - PASSPORT_VERIFICATION - PAYOUT_METHOD_VERIFICATION - - PCI_SELF_ASSESSMENT_PRESENCE_VERIFICATION - PCI_VERIFICATION - - POLITICALLY_EXPOSED_IDENTIFICATION_VERIFICATION - - POLITICALLY_EXPOSED_VERIFICATION type: string required: - type @@ -2196,6 +2194,16 @@ components: shareholderCode: description: The code of the shareholder to which the check applies. type: string + KYCSignatoryCheckResult: + properties: + checks: + description: A list of the checks and their statuses. + items: + $ref: '#/components/schemas/KYCCheckStatusData' + type: array + signatoryCode: + description: The code of the signatory to which the check applies. + type: string KYCVerificationResult2: properties: accountHolder: @@ -2224,6 +2232,11 @@ components: items: $ref: '#/components/schemas/KYCShareholderCheckResult' type: array + signatories: + description: The results of the checks on the signatories. + items: + $ref: '#/components/schemas/KYCSignatoryCheckResult' + type: array LegalArrangementDetail: properties: address: diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index 897f512..5196b26 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -80,16 +80,16 @@ paths: content: application/json: examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' authorise-3dsecure: $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' authorise-recurringoneclick: $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -535,10 +535,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' voidpendingrefund-pspreference: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/VoidPendingRefundRequest' responses: @@ -546,10 +546,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' voidpendingrefund-pspreference-200: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 55eed41..b1135b4 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -151,18 +151,18 @@ paths: content: application/json: examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' authorise-3dsecure: $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' authorise-recurringoneclick: $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -678,10 +678,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' voidpendingrefund-pspreference: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/VoidPendingRefundRequest' responses: @@ -689,10 +689,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' voidpendingrefund-pspreference-200: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index 3f5cbc3..63c1f3f 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -151,20 +151,20 @@ paths: content: application/json: examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' authorise-3d-secure-2: $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-3dsecure: + $ref: '#/components/examples/post-authorise-authorise-3dsecure' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' authorise-recurringoneclick: $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -881,10 +881,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' voidpendingrefund-pspreference: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/VoidPendingRefundRequest' responses: @@ -892,10 +892,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' voidpendingrefund-pspreference-200: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index 4604a21..177ee0e 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -151,20 +151,20 @@ paths: content: application/json: examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' authorise-3d-secure-2: $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-3dsecure: + $ref: '#/components/examples/post-authorise-authorise-3dsecure' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' authorise-recurringoneclick: $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -881,10 +881,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' voidpendingrefund-pspreference: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/VoidPendingRefundRequest' responses: @@ -892,10 +892,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' voidpendingrefund-pspreference-200: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index 2ec6f78..9624189 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -151,20 +151,20 @@ paths: content: application/json: examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' authorise-3d-secure-2: $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-3dsecure: + $ref: '#/components/examples/post-authorise-authorise-3dsecure' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' authorise-recurringoneclick: $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -881,10 +881,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' voidpendingrefund-pspreference: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/VoidPendingRefundRequest' responses: @@ -892,10 +892,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' voidpendingrefund-pspreference-200: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index afc3303..332112b 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -151,20 +151,20 @@ paths: content: application/json: examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' authorise-3d-secure-2: $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-3dsecure: + $ref: '#/components/examples/post-authorise-authorise-3dsecure' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' authorise-recurringoneclick: $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -881,10 +881,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' voidpendingrefund-pspreference: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/VoidPendingRefundRequest' responses: @@ -892,10 +892,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' voidpendingrefund-pspreference-200: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index 4f72d04..e5d97fb 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -151,20 +151,20 @@ paths: content: application/json: examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' authorise-3d-secure-2: $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-3dsecure: + $ref: '#/components/examples/post-authorise-authorise-3dsecure' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' authorise-recurringoneclick: $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -945,10 +945,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' voidpendingrefund-pspreference: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/VoidPendingRefundRequest' responses: @@ -956,10 +956,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' voidpendingrefund-pspreference-200: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index a24e41c..82e098a 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -151,20 +151,20 @@ paths: content: application/json: examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' authorise-3d-secure-2: $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-3dsecure: + $ref: '#/components/examples/post-authorise-authorise-3dsecure' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' authorise-recurringoneclick: $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -945,10 +945,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' voidpendingrefund-pspreference: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/VoidPendingRefundRequest' responses: @@ -956,10 +956,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' voidpendingrefund-pspreference-200: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index d3113b0..dd8ccae 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -151,20 +151,20 @@ paths: content: application/json: examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' authorise-3d-secure-2: $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-3dsecure: + $ref: '#/components/examples/post-authorise-authorise-3dsecure' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' authorise-recurringoneclick: $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -945,10 +945,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' voidpendingrefund-pspreference: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' schema: $ref: '#/components/schemas/VoidPendingRefundRequest' responses: @@ -956,10 +956,10 @@ paths: content: application/json: examples: - voidpendingrefund-tenderreference-200: - $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' voidpendingrefund-pspreference-200: $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. diff --git a/yaml/PayoutService-v30.yaml b/yaml/PayoutService-v30.yaml index 41a76dd..3664e8b 100644 --- a/yaml/PayoutService-v30.yaml +++ b/yaml/PayoutService-v30.yaml @@ -189,10 +189,10 @@ paths: content: application/json: examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' payout-b2c: $ref: '#/components/examples/post-payout-payout-b2c' + payout-p2p: + $ref: '#/components/examples/post-payout-payout-p2p' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -311,16 +311,16 @@ paths: content: application/json: examples: - storeDetailAndSubmitThirdParty-Neteller: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' + storeDetailAndSubmitThirdParty-Neteller: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' + storeDetailAndSubmitThirdParty-PayPal: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty-Paysafecard: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' + storeDetailAndSubmitThirdParty-Skrill: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: diff --git a/yaml/PayoutService-v40.yaml b/yaml/PayoutService-v40.yaml index b95f7f2..743e480 100644 --- a/yaml/PayoutService-v40.yaml +++ b/yaml/PayoutService-v40.yaml @@ -189,10 +189,10 @@ paths: content: application/json: examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' payout-b2c: $ref: '#/components/examples/post-payout-payout-b2c' + payout-p2p: + $ref: '#/components/examples/post-payout-payout-p2p' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -311,16 +311,16 @@ paths: content: application/json: examples: - storeDetailAndSubmitThirdParty-Neteller: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' + storeDetailAndSubmitThirdParty-Neteller: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' + storeDetailAndSubmitThirdParty-PayPal: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty-Paysafecard: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' + storeDetailAndSubmitThirdParty-Skrill: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: diff --git a/yaml/PayoutService-v50.yaml b/yaml/PayoutService-v50.yaml index 79918ac..43b5870 100644 --- a/yaml/PayoutService-v50.yaml +++ b/yaml/PayoutService-v50.yaml @@ -189,10 +189,10 @@ paths: content: application/json: examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' payout-b2c: $ref: '#/components/examples/post-payout-payout-b2c' + payout-p2p: + $ref: '#/components/examples/post-payout-payout-p2p' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -311,16 +311,16 @@ paths: content: application/json: examples: - storeDetailAndSubmitThirdParty-Neteller: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' + storeDetailAndSubmitThirdParty-Neteller: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' + storeDetailAndSubmitThirdParty-PayPal: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty-Paysafecard: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' + storeDetailAndSubmitThirdParty-Skrill: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: diff --git a/yaml/PayoutService-v51.yaml b/yaml/PayoutService-v51.yaml index 3efd849..b61d4b9 100644 --- a/yaml/PayoutService-v51.yaml +++ b/yaml/PayoutService-v51.yaml @@ -189,10 +189,10 @@ paths: content: application/json: examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' payout-b2c: $ref: '#/components/examples/post-payout-payout-b2c' + payout-p2p: + $ref: '#/components/examples/post-payout-payout-p2p' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -311,16 +311,16 @@ paths: content: application/json: examples: - storeDetailAndSubmitThirdParty-Neteller: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' + storeDetailAndSubmitThirdParty-Neteller: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' + storeDetailAndSubmitThirdParty-PayPal: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty-Paysafecard: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' + storeDetailAndSubmitThirdParty-Skrill: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: diff --git a/yaml/PayoutService-v52.yaml b/yaml/PayoutService-v52.yaml index 6ef4b3f..7cd806c 100644 --- a/yaml/PayoutService-v52.yaml +++ b/yaml/PayoutService-v52.yaml @@ -189,10 +189,10 @@ paths: content: application/json: examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' payout-b2c: $ref: '#/components/examples/post-payout-payout-b2c' + payout-p2p: + $ref: '#/components/examples/post-payout-payout-p2p' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -311,16 +311,16 @@ paths: content: application/json: examples: - storeDetailAndSubmitThirdParty-Neteller: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' + storeDetailAndSubmitThirdParty-Neteller: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' + storeDetailAndSubmitThirdParty-PayPal: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty-Paysafecard: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' + storeDetailAndSubmitThirdParty-Skrill: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: diff --git a/yaml/PayoutService-v64.yaml b/yaml/PayoutService-v64.yaml index 4168eeb..846e06c 100644 --- a/yaml/PayoutService-v64.yaml +++ b/yaml/PayoutService-v64.yaml @@ -189,10 +189,10 @@ paths: content: application/json: examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' payout-b2c: $ref: '#/components/examples/post-payout-payout-b2c' + payout-p2p: + $ref: '#/components/examples/post-payout-payout-p2p' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -311,16 +311,16 @@ paths: content: application/json: examples: - storeDetailAndSubmitThirdParty-Neteller: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' + storeDetailAndSubmitThirdParty-Neteller: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' + storeDetailAndSubmitThirdParty-PayPal: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty-Paysafecard: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' + storeDetailAndSubmitThirdParty-Skrill: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: