jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2024-03-21 14:04:29 +01:00
parent 38e0ca1bed
commit 40f58bf7db
40 changed files with 1061 additions and 977 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
yaml/MarketPayNotificationService-v4.yaml
View File

@@ -4,11 +4,11 @@ info:
x-publicVersion: true
title: Classic Platforms - Notifications
description: "This API is used for the classic integration. If you are just starting\
\ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\
\ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\
\ instead.\n\nThe Notification API sends notifications to the endpoints specified\
\ in a given subscription. \nSubscriptions are managed through the Notification\
\ Configuration API. The API specifications listed here detail the format of each\
\ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications)."
\ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications)."
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -398,7 +398,7 @@ webhooks:
tags:
- Other
summary: Booking for a capture or refund failed
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information)
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)
booking for a capture or refund fails. When a booking fails due to an invalid
account status or an unknown `accountCode`, the funds are credited or debited
to or fromyour platform's liable account instead of the account specified
@@ -607,7 +607,7 @@ components:
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
For more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).'
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -723,7 +723,7 @@ components:
bankAccountDetails:
description: Array of bank accounts associated with the account holder.
For details about the required `bankAccountDetail` fields, see [Required
information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
information](https://docs.adyen.com/classic-platforms/verification-process/required-information).
items:
$ref: '#/components/schemas/BankAccountDetailWrapper'
type: array
@@ -1278,7 +1278,7 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
@@ -1289,7 +1289,7 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
@@ -1322,14 +1322,14 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
@@ -1337,7 +1337,7 @@ components:
account is registered.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
@@ -1345,7 +1345,7 @@ components:
is held.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
@@ -1359,14 +1359,14 @@ components:
* Germany - Bankleitzahl
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
@@ -1375,7 +1375,7 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
@@ -1391,13 +1391,13 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
@@ -1407,7 +1407,7 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
@@ -1420,13 +1420,13 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
@@ -1436,25 +1436,25 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
@@ -1464,7 +1464,7 @@ components:
description: 'The tax ID number.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
@@ -1473,7 +1473,7 @@ components:
This may be generated on bank account creation.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information)
for details on field requirements.'
type: string
type: object
@@ -1567,7 +1567,7 @@ components:
shareholders:
description: Array containing information about individuals associated with
the account holder either through ownership or control. For details about
how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos).
items:
$ref: '#/components/schemas/ShareholderContactWrapper'
type: array
@@ -2693,11 +2693,11 @@ components:
is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
* [Classic Platforms integration](https://docs.adyen.com/classic-platforms):
The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
of the account to which the split amount is booked.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):
The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
of the account to which the split amount is booked.'
type: string
@@ -2705,21 +2705,22 @@ components:
description: 'The amount of the split item.
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).
* Required if `type` is **BalanceAccount**, **Commission**, **Default**,
or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)
or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)
integration.'
$ref: '#/components/schemas/SplitAmount'
description:
description: Your description for the split item.
type: string
reference:
description: 'Your unique reference for the split item.
description: 'Your unique reference for the part of the payment booked to
the specified `account`.
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic))
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms))
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).
For the other types, we also recommend providing a **unique** reference
@@ -2727,18 +2728,29 @@ components:
overview and in the reports.'
type: string
type:
description: 'The type of the split item.
Possible values:
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
**Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
**BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**,
**Surcharge**, **Tip**, **VAT**.'
description: "The part of the payment you want to book to the specified\
\ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\
* **BalanceAccount**: books part of the payment (specified in `amount`)\
\ to the specified `account`.\n* Transaction fees types that you can book\
\ to the specified `account`:\n * **AcquiringFees**: the aggregated\
\ amount of the interchange and scheme fees.\n * **PaymentFee**: the\
\ aggregated amount of all transaction fees.\n * **AdyenFees**: the\
\ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\
\ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\
\ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\
\ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\
\ * **Interchange**: the fees paid to the issuer for each payment made\
\ with the card network.\n * **SchemeFee**: the fees paid to the card\
\ scheme for using their network. \n* **Remainder**: the amount left over\
\ after a currency conversion, booked to the specified `account`.\n* **VAT**:\
\ the value-added tax charged on the payment, booked to your platforms\
\ liable balance account.\n* **Commission**: your platform's commission\
\ (specified in `amount`) on the payment, booked to your liable balance\
\ account.\n* **Default**: in very specific use cases, allows you to book\
\ the specified `amount` to the specified `account`. For more information,\
\ contact Adyen support.\n\nPossible values for the [Classic Platforms\
\ integration](https://docs.adyen.com/classic-platforms): **Commission**,\
\ **Default**, **Marketplace**, **PaymentFee**, **VAT**."
enum:
- AcquiringFees
- AdyenCommission