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

Updated definitions for Adyen for Platform's notifications

Browse Source
This commit is contained in:
aleksei
2020-08-05 15:47:02 +02:00
parent 5be7ab2920
commit db300f57b7
20 changed files with 7935 additions and 735 deletions
Download Patch File Download Diff File Expand all files Collapse all files

149
yaml/MarketPayNotificationService-v4.yaml
View File

@@ -1,11 +1,11 @@
openapi: 3.0.0
openapi: 3.0.3
info:
version: '4'
title: Adyen MarketPay Notifications
title: 'Adyen for Platforms: Notifications'
description: |-
The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.
For further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).
For more information, refer to our [documentation](https://docs.adyen.com/marketpay/marketpay-notifications).
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
contact:
name: Adyen Support
@@ -23,6 +23,7 @@ paths:
post:
summary: Triggered upon the closure of an account.
description: This notification is sent when an account has been closed.
operationId: post-ACCOUNT_CLOSED
x-groupName: Accounts
x-sortIndex: 3
requestBody:
@@ -41,6 +42,7 @@ paths:
post:
summary: Triggered upon the creation of an account.
description: This notification is sent when an account has been created.
operationId: post-ACCOUNT_CREATED
x-groupName: Accounts
x-sortIndex: 1
requestBody:
@@ -59,6 +61,7 @@ paths:
post:
summary: Triggered upon the creation of an account holder.
description: This notification is sent when an account holder has been created.
operationId: post-ACCOUNT_HOLDER_CREATED
x-groupName: Account holders
x-sortIndex: 1
requestBody:
@@ -77,6 +80,7 @@ paths:
post:
summary: Triggered upon a payout to an account holder.
description: This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled.
operationId: post-ACCOUNT_HOLDER_PAYOUT
x-groupName: Fund management
x-sortIndex: 1
requestBody:
@@ -95,6 +99,7 @@ paths:
post:
summary: Triggered upon the status change of an account holder.
description: This notification is sent when the status of an account holder has been changed.
operationId: post-ACCOUNT_HOLDER_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
requestBody:
@@ -113,6 +118,7 @@ paths:
post:
summary: Triggered upon the status change of a store tied to an account holder.
description: This notification is sent when the status of a store tied to an account holder has been changed.
operationId: post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
requestBody:
@@ -131,6 +137,7 @@ paths:
post:
summary: Triggered upon an upcoming deadline.
description: 'This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.'
operationId: post-ACCOUNT_HOLDER_UPCOMING_DEADLINE
x-groupName: Account holders
x-sortIndex: 1
requestBody:
@@ -149,6 +156,7 @@ paths:
post:
summary: Triggered upon the update of an account holder.
description: This notification is sent when an account holder has been updated.
operationId: post-ACCOUNT_HOLDER_UPDATED
x-groupName: Account holders
x-sortIndex: 2
requestBody:
@@ -167,6 +175,7 @@ paths:
post:
summary: Triggered upon the receipt of KYC Verification results.
description: This notification is sent when KYC Verification results are made available.
operationId: post-ACCOUNT_HOLDER_VERIFICATION
x-groupName: Account holders
x-sortIndex: 3
requestBody:
@@ -185,6 +194,7 @@ paths:
post:
summary: Triggered upon the update of an account.
description: This notification is sent when an account has been updated.
operationId: post-ACCOUNT_UPDATED
x-groupName: Accounts
x-sortIndex: 2
requestBody:
@@ -203,6 +213,7 @@ paths:
post:
summary: Triggered upon the setup of a beneficiary.
description: This notification is sent when a benefactor/beneficiary relationship between accounts has been set up.
operationId: post-BENEFICIARY_SETUP
x-groupName: Fund management
x-sortIndex: 3
requestBody:
@@ -221,6 +232,7 @@ paths:
post:
summary: Triggered upon the compensation of negative account balances.
description: This notification is sent when funds have been transferred from the Marketplace's liable account to an overdrawn account in order to compensate for the overdraft.
operationId: post-COMPENSATE_NEGATIVE_BALANCE
x-groupName: Fund management
x-sortIndex: 5
requestBody:
@@ -239,6 +251,7 @@ paths:
post:
summary: Triggered when an automated direct debit is initiated.
description: This notification is sent when an automated direct debit is initiated from the Adyen platform.
operationId: post-DIRECT_DEBIT_INITIATED
x-groupName: Fund management
x-sortIndex: 7
requestBody:
@@ -257,6 +270,7 @@ paths:
post:
summary: Triggered upon an account payment failure.
description: 'This notification is sent when a payment to an account has failed. In these cases, the funds which were meant for the account are redirected to the Marketplace''s liable account.'
operationId: post-PAYMENT_FAILURE
x-groupName: Other
x-sortIndex: 1
requestBody:
@@ -271,10 +285,30 @@ paths:
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
/PAYOUT_CONFIRMED:
post:
summary: Triggered when a payout has been confirmed.
description: This notification is sent when a payout is confirmed from the Adyen platform.
operationId: post-PAYOUT_CONFIRMED
x-groupName: Fund management
x-sortIndex: 8
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderPayoutNotification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
/REFUND_FUNDS_TRANSFER:
post:
summary: Triggered upon the transfer refund of funds between accounts.
description: This notification is sent when the refund of funds from an account have been transferred to another account.
operationId: post-REFUND_FUNDS_TRANSFER
x-groupName: Fund management
x-sortIndex: 6
requestBody:
@@ -293,6 +327,7 @@ paths:
post:
summary: Triggered when a report is made available.
description: This notification is sent when a report has been made available.
operationId: post-REPORT_AVAILABLE
x-groupName: Other
x-sortIndex: 2
requestBody:
@@ -311,6 +346,7 @@ paths:
post:
summary: Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call.
description: This notification is sent when a 'Refund Transfers Not Paid Out' call has been processed and the associated refunds have been scheduled.
operationId: post-SCHEDULED_REFUNDS
x-groupName: Fund management
x-sortIndex: 4
requestBody:
@@ -329,6 +365,7 @@ paths:
post:
summary: Triggered upon the transfer of funds between accounts.
description: This notification is sent when the funds from an account have been transferred to another account.
operationId: post-TRANSFER_FUNDS
x-groupName: Fund management
x-sortIndex: 2
requestBody:
@@ -490,6 +527,8 @@ components:
> If not specified in the request, this will be derived from the platform account (which is configured by Adyen).
type: string
metadata:
additionalProperties:
type: string
description: |-
A set of key and value pairs for general use by the account holder or merchant.
The keys do not have specific names and may be used for storing miscellaneous data as desired.
@@ -590,10 +629,6 @@ components:
type: string
required:
- status
- statusReason
- processingState
- payoutState
- events
AccountHolderStatusChangeNotification:
properties:
content:
@@ -639,7 +674,6 @@ components:
- accountHolderCode
- oldStatus
- newStatus
- reason
AccountHolderStoreStatusChangeNotification:
properties:
content:
@@ -814,10 +848,12 @@ components:
description: The type of validation performed.
enum:
- BANK_ACCOUNT_VERIFICATION
- CARD_VERIFICATION
- COMPANY_VERIFICATION
- IDENTITY_VERIFICATION
- NONPROFIT_VERIFICATION
- PASSPORT_VERIFICATION
- PAYOUT_METHOD_VERIFICATION
type: string
required:
- accountHolderCode
@@ -839,12 +875,6 @@ components:
description: The payout tier that the account holder occupies.
format: int32
type: integer
required:
- allowPayout
- disabled
- tierNumber
- disableReason
- payoutLimit
AccountProcessingState:
properties:
disableReason:
@@ -863,12 +893,6 @@ components:
description: The processing tier that the account holder occupies.
format: int32
type: integer
required:
- disabled
- disableReason
- processedFrom
- processedTo
- tierNumber
AccountUpdateNotification:
properties:
content:
@@ -1149,7 +1173,7 @@ components:
CloseAccountResponse:
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
@@ -1166,10 +1190,9 @@ components:
type: string
submittedAsync:
description: |-
Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.
Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
type: boolean
required:
- pspReference
@@ -1259,17 +1282,16 @@ components:
- PublicCompany
type: string
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
type: string
submittedAsync:
description: |-
Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.
Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
type: boolean
verification:
description: The details of KYC Verification of the account holder.
@@ -1297,7 +1319,7 @@ components:
description: The payout schedule of the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
@@ -1314,10 +1336,9 @@ components:
type: string
submittedAsync:
description: |-
Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.
Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
type: boolean
required:
- pspReference
@@ -1483,6 +1504,9 @@ components:
- sourceAccountCode
- stateOrProvince
- status
- stockExchange
- stockNumber
- stockTicker
- store
- storeDetail
- storeName
@@ -1521,9 +1545,6 @@ components:
items:
$ref: '#/components/schemas/KYCCheckStatusData'
type: array
required:
- checks
- bankAccountUUID
KYCCheckResult:
properties:
checks:
@@ -1531,8 +1552,6 @@ components:
items:
$ref: '#/components/schemas/KYCCheckStatusData'
type: array
required:
- checks
KYCCheckStatusData:
properties:
requiredFields:
@@ -1561,19 +1580,19 @@ components:
type:
description: |-
The type of check.
>Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`.
>Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`, `CARD_VERIFICATION`.
enum:
- BANK_ACCOUNT_VERIFICATION
- CARD_VERIFICATION
- COMPANY_VERIFICATION
- IDENTITY_VERIFICATION
- NONPROFIT_VERIFICATION
- PASSPORT_VERIFICATION
- PAYOUT_METHOD_VERIFICATION
type: string
required:
- type
- status
- summary
- requiredFields
KYCCheckSummary:
properties:
code:
@@ -1595,9 +1614,6 @@ components:
shareholderCode:
description: The code of the shareholder to which the check applies.
type: string
required:
- checks
- shareholderCode
KYCVerificationResult:
properties:
accountHolder:
@@ -1613,10 +1629,6 @@ components:
items:
$ref: '#/components/schemas/KYCShareholderCheckResult'
type: array
required:
- accountHolder
- shareholders
- bankAccounts
LocalDate:
properties:
month:
@@ -1636,10 +1648,8 @@ components:
NotificationResponse:
properties:
notificationResponse:
description: 'Set this property to **[accepted]** to acknowledge that you received a notification from Adyen.'
description: 'Set this parameter to **[accepted]** to acknowledge that you received a notification from Adyen.'
type: string
required:
- notificationResponse
OperationStatus:
properties:
message:
@@ -1751,7 +1761,6 @@ components:
type: string
required:
- type
- number
RefundFundsTransferNotification:
properties:
content:
@@ -1990,15 +1999,18 @@ components:
transactionStatus:
description: |-
The status of the transaction.
>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.
>Permitted values: `PendingCredit`, `CreditFailed`, `CreditClosed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.
enum:
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived
- ChargebackReceived
- ChargebackReversed
- ChargebackReversedCorrection
- ChargebackReversedCorrectionReceived
- ChargebackReversedReceived
- Converted
- CreditClosed
- CreditFailed
- CreditReversed
- CreditReversedReceived
@@ -2104,17 +2116,16 @@ components:
- PublicCompany
type: string
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
type: string
submittedAsync:
description: |-
Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.
Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
type: boolean
updatedFields:
description: A list of the fields updated through the request.
@@ -2142,23 +2153,21 @@ components:
description: The payout schedule of the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
type: string
submittedAsync:
description: |-
Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.
Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
type: boolean
required:
- pspReference
- submittedAsync
- accountCode
- payoutSchedule
ViasAddress:
properties:
city:
@@ -2270,3 +2279,11 @@ components:
required:
- phoneCountryCode
- phoneNumber
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http