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 MarketPay API definitions

Browse Source
This commit is contained in:
aleksei
2020-03-04 10:54:59 +01:00
parent d78024e1f2
commit 1682b1efdf
20 changed files with 2827 additions and 168 deletions
Download Patch File Download Diff File Expand all files Collapse all files

372
yaml/MarketPayNotificationService-v5.yaml
View File

@@ -1,9 +1,9 @@
openapi: 3.0.0
info:
version: '5'
title: Adyen Notification API
title: Adyen MarketPay Notifications
description: |-
The Notification Service 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.
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).
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
@@ -109,6 +109,42 @@ paths:
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
/ACCOUNT_HOLDER_STORE_STATUS_CHANGE:
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.
x-groupName: Account holders
x-sortIndex: 4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderStoreStatusChangeNotification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
/ACCOUNT_HOLDER_UPCOMING_DEADLINE:
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.'
x-groupName: Account holders
x-sortIndex: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
/ACCOUNT_HOLDER_UPDATED:
post:
summary: Triggered upon the update of an account holder.
@@ -199,6 +235,24 @@ paths:
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
/DIRECT_DEBIT_INITIATED:
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.
x-groupName: Fund management
x-sortIndex: 7
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DirectDebitInitiatedNotification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
/PAYMENT_FAILURE:
post:
summary: Triggered upon an account payment failure.
@@ -217,6 +271,24 @@ paths:
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.
x-groupName: Fund management
x-sortIndex: 6
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RefundFundsTransferNotification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
/REPORT_AVAILABLE:
post:
summary: Triggered when a report is made available.
@@ -447,6 +519,7 @@ components:
required:
- fullPhoneNumber
- email
- webAddress
AccountHolderPayoutNotification:
properties:
content:
@@ -487,10 +560,10 @@ components:
description: The code of the Account Holder to which the payout was made.
type: string
amount:
description: payout amount
description: The payout amount.
$ref: '#/components/schemas/Amount'
amounts:
description: payout amounts (per currency)
description: The payout amounts (per currency).
items:
$ref: '#/components/schemas/Amount'
type: array
@@ -500,21 +573,26 @@ components:
description:
description: A description of the payout.
type: string
estimatedArrivalDate:
description: The estimated date of arrival.
$ref: '#/components/schemas/LocalDate'
invalidFields:
description: Invalid fields list.
items:
$ref: '#/components/schemas/ErrorFieldType'
type: array
merchantReference:
description: merchant reference
description: The merchant reference.
type: string
originalPspReference:
description: The PSP reference of the original payout.
type: string
status:
description: payout status
description: The payout status.
$ref: '#/components/schemas/OperationStatus'
required:
- accountHolderCode
- accountCode
- bankAccountDetail
AccountHolderStatus:
properties:
events:
@@ -601,6 +679,142 @@ components:
- oldStatus
- newStatus
- reason
AccountHolderStoreStatusChangeNotification:
properties:
content:
description: The details of the Account Holder Store status change.
$ref: '#/components/schemas/AccountHolderStoreStatusChangeNotificationContent'
error:
description: Error information of failed request. No value provided here if no error occurred on processing.
$ref: '#/components/schemas/NotificationErrorContainer'
eventDate:
description: The date and time when an event has been completed.
format: date-time
type: string
eventType:
description: The event type of the notification.
type: string
executingUserKey:
description: The user or process that has triggered the notification.
type: string
live:
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
type: boolean
pspReference:
description: The PSP reference of the request from which the notification originates.
type: string
required:
- executingUserKey
- pspReference
- eventType
- live
- eventDate
AccountHolderStoreStatusChangeNotificationContent:
properties:
accountHolderCode:
description: The code of the account holder.
type: string
invalidFields:
description: 'In case the store status has not been updated, contains fields that did not pass the validation.'
items:
$ref: '#/components/schemas/ErrorFieldType'
type: array
newStatus:
description: The new status of the account holder.
enum:
- Active
- Closed
- Inactive
- InactiveWithModifications
- Pending
type: string
oldStatus:
description: The former status of the account holder.
enum:
- Active
- Closed
- Inactive
- InactiveWithModifications
- Pending
type: string
reason:
description: The reason for the status change.
type: string
store:
description: Alphanumeric identifier of the store.
type: string
storeReference:
description: Store store reference.
type: string
required:
- accountHolderCode
- store
- storeReference
- oldStatus
- newStatus
- reason
AccountHolderUpcomingDeadlineNotification:
properties:
content:
description: The details of the upcoming event.
$ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent'
error:
description: Error information of failed request. No value provided here if no error occurred on processing.
$ref: '#/components/schemas/NotificationErrorContainer'
eventDate:
description: The date and time when an event has been completed.
format: date-time
type: string
eventType:
description: The event type of the notification.
type: string
executingUserKey:
description: The user or process that has triggered the notification.
type: string
live:
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
type: boolean
pspReference:
description: The PSP reference of the request from which the notification originates.
type: string
required:
- executingUserKey
- pspReference
- eventType
- live
- eventDate
AccountHolderUpcomingDeadlineNotificationContent:
properties:
accountHolderCode:
description: The code of the account holder whom the event refers to.
type: string
event:
description: The event name that will be trigger if no action is taken.
enum:
- AccessPii
- CloseAccount
- CloseStores
- DeleteBankAccounts
- DeletePayoutInstrumentTokens
- DeletePayoutMethods
- DeleteShareholders
- InactivateAccount
- RecalculateAccountStatusAndProcessingTier
- RefundNotPaidOutTransfers
- ResolveEvents
- SaveAccountHolder
- SaveKYCCheckStatus
- SuspendAccount
- UnSuspendAccount
- UpdateAccountHolderState
- Verification
type: string
executionDate:
description: The execution date scheduled for the event.
$ref: '#/components/schemas/LocalDate'
reason:
description: The reason that leads to scheduling of the event.
type: string
AccountHolderUpdateNotification:
properties:
content:
@@ -1019,6 +1233,9 @@ components:
type: string
CloseAccountResponse:
properties:
accountCode:
description: The account code of the account that is closed.
type: string
invalidFields:
description: Contains field validation errors that would prevent requests from being processed.
items:
@@ -1126,6 +1343,7 @@ components:
- Business
- Individual
- NonProfit
- Partnership
- PublicCompany
type: string
primaryCurrency:
@@ -1191,6 +1409,57 @@ components:
- accountHolderCode
- accountCode
- status
DirectDebitInitiatedNotification:
properties:
content:
description: Details of the direct debit.
$ref: '#/components/schemas/DirectDebitInitiatedNotificationContent'
error:
description: Error information of failed request. No value provided here if no error occurred on processing.
$ref: '#/components/schemas/NotificationErrorContainer'
eventDate:
description: The date and time when an event has been completed.
format: date-time
type: string
eventType:
description: The event type of the notification.
type: string
executingUserKey:
description: The user or process that has triggered the notification.
type: string
live:
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
type: boolean
pspReference:
description: The PSP reference of the request from which the notification originates.
type: string
required:
- executingUserKey
- pspReference
- eventType
- live
- eventDate
DirectDebitInitiatedNotificationContent:
properties:
accountCode:
description: The code of the account.
type: string
amount:
description: The amount to be debited from the funding account.
$ref: '#/components/schemas/Amount'
debitInitiationDate:
description: The date of the debit initiation.
$ref: '#/components/schemas/LocalDate'
merchantAccountCode:
description: The code of the merchant account.
type: string
status:
description: Direct debit status.
$ref: '#/components/schemas/OperationStatus'
required:
- amount
- accountCode
- merchantAccountCode
ErrorFieldType:
properties:
errorCode:
@@ -1222,6 +1491,7 @@ components:
- bankAccount
- bankAccountCode
- bankAccountName
- bankAccountUUID
- bankBicSwift
- bankCity
- bankCode
@@ -1232,6 +1502,7 @@ components:
- cardToken
- checkCode
- city
- companyRegistration
- country
- countryCode
- currency
@@ -1254,6 +1525,7 @@ components:
- firstName
- fullPhoneNumber
- gender
- hopWebserviceUser
- houseNumberOrName
- iban
- idCard
@@ -1266,12 +1538,13 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- merchantAccountCode
- merchantAccount
- merchantCategoryCode
- merchantReference
- microDeposit
- name
- nationality
- originalReference
- ownerCity
- ownerCountryCode
- ownerHouseNumberOrName
@@ -1281,6 +1554,7 @@ components:
- ownerStreet
- passport
- passportNumber
- payoutMethodCode
- personalData
- phoneCountryCode
- phoneNumber
@@ -1288,6 +1562,7 @@ components:
- primaryCurrency
- reason
- registrationNumber
- returnUrl
- schedule
- shareholder
- shareholderCode
@@ -1295,8 +1570,9 @@ components:
- sourceAccountCode
- stateOrProvince
- status
- storeCode
- store
- storeDetail
- storeName
- storeReference
- street
- taxId
@@ -1354,7 +1630,7 @@ components:
status:
description: |-
The status of the check.
>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
enum:
- AWAITING_DATA
- DATA_PROVIDED
@@ -1426,6 +1702,14 @@ components:
- accountHolder
- shareholders
- bankAccounts
LocalDate:
properties:
month:
format: int32
type: integer
year:
format: int32
type: integer
Message:
properties:
code:
@@ -1534,6 +1818,9 @@ components:
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
- DAILY
- DAILY_6PM
- DAILY_AU
- DAILY_EU
- DAILY_US
- DEFAULT
- EVERY_6_HOURS_FROM_MIDNIGHT
- HOLD
@@ -1579,6 +1866,59 @@ components:
required:
- type
- number
RefundFundsTransferNotification:
properties:
content:
description: Details of the fund transfer refund.
$ref: '#/components/schemas/RefundFundsTransferNotificationContent'
error:
description: Error information of failed request. No value provided here if no error occurred on processing.
$ref: '#/components/schemas/NotificationErrorContainer'
eventDate:
description: The date and time when an event has been completed.
format: date-time
type: string
eventType:
description: The event type of the notification.
type: string
executingUserKey:
description: The user or process that has triggered the notification.
type: string
live:
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
type: boolean
pspReference:
description: The PSP reference of the request from which the notification originates.
type: string
required:
- executingUserKey
- pspReference
- eventType
- live
- eventDate
- content
RefundFundsTransferNotificationContent:
properties:
amount:
description: The amount to be refunded.
$ref: '#/components/schemas/Amount'
invalidFields:
description: Invalid fields list.
items:
$ref: '#/components/schemas/ErrorFieldType'
type: array
merchantReference:
description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
type: string
originalReference:
description: A PSP reference of the original fund transfer.
type: string
status:
description: The status of the fund transfer refund.
$ref: '#/components/schemas/OperationStatus'
required:
- originalReference
- amount
RefundResult:
properties:
originalTransaction:
@@ -1730,9 +2070,10 @@ components:
>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Bank Account will be updated.**
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**
type: string
shareholderReference:
description: Merchant reference to the Shareholder.
type: string
webAddress:
description: The URL of the website of the contact.
@@ -1788,17 +2129,23 @@ components:
>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.
enum:
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived
- ChargebackReceived
- ChargebackReversed
- ChargebackReversedReceived
- Converted
- CreditFailed
- CreditReversed
- CreditReversedReceived
- Credited
- DebitFailed
- DebitReversedReceived
- Debited
- DebitedReversed
- Fee
- FundTransfer
- FundTransferReversed
- ManualCorrected
- Payout
- PayoutReversed
@@ -1897,6 +2244,7 @@ components:
- Business
- Individual
- NonProfit
- Partnership
- PublicCompany
type: string
primaryCurrency:
@@ -1956,7 +2304,7 @@ components:
country:
description: |-
The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
> If you don't know the country or are not collecting the country from the shopper, provide `countryCode` as `ZZ`.
> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
type: string
houseNumberOrName:
description: The number or name of the house.