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

174
json/MarketPayNotificationService-v3.json
View File

@@ -1,9 +1,9 @@
{
"openapi" : "3.0.0",
"openapi" : "3.0.3",
"info" : {
"version" : "3",
"title" : "Adyen MarketPay 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.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).",
"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.\n\nFor 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",
@@ -24,6 +24,7 @@
"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" : {
@@ -53,6 +54,7 @@
"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" : {
@@ -82,6 +84,7 @@
"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" : {
@@ -111,6 +114,7 @@
"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" : {
@@ -140,6 +144,7 @@
"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" : {
@@ -169,6 +174,7 @@
"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" : {
@@ -198,6 +204,7 @@
"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" : {
@@ -227,6 +234,7 @@
"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" : {
@@ -256,6 +264,7 @@
"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" : {
@@ -285,6 +294,7 @@
"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" : {
@@ -314,6 +324,7 @@
"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" : {
@@ -343,6 +354,7 @@
"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" : {
@@ -372,6 +384,7 @@
"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" : {
@@ -401,6 +414,7 @@
"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" : {
@@ -426,10 +440,41 @@
}
}
},
"/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" : {
@@ -459,6 +504,7 @@
"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" : {
@@ -488,6 +534,7 @@
"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" : {
@@ -517,6 +564,7 @@
"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" : {
@@ -698,6 +746,9 @@
"type" : "string"
},
"metadata" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.",
"type" : "object"
},
@@ -819,11 +870,7 @@
}
},
"required" : [
"status",
"statusReason",
"processingState",
"payoutState",
"events"
"status"
]
},
"AccountHolderStatusChangeNotification" : {
@@ -878,8 +925,7 @@
"required" : [
"accountHolderCode",
"oldStatus",
"newStatus",
"reason"
"newStatus"
]
},
"AccountHolderStoreStatusChangeNotification" : {
@@ -1087,10 +1133,12 @@
"description" : "The type of validation performed.",
"enum" : [
"BANK_ACCOUNT_VERIFICATION",
"CARD_VERIFICATION",
"COMPANY_VERIFICATION",
"IDENTITY_VERIFICATION",
"NONPROFIT_VERIFICATION",
"PASSPORT_VERIFICATION"
"PASSPORT_VERIFICATION",
"PAYOUT_METHOD_VERIFICATION"
],
"type" : "string"
}
@@ -1122,14 +1170,7 @@
"format" : "int32",
"type" : "integer"
}
},
"required" : [
"allowPayout",
"disabled",
"tierNumber",
"disableReason",
"payoutLimit"
]
}
},
"AccountProcessingState" : {
"properties" : {
@@ -1154,14 +1195,7 @@
"format" : "int32",
"type" : "integer"
}
},
"required" : [
"disabled",
"disableReason",
"processedFrom",
"processedTo",
"tierNumber"
]
}
},
"AccountUpdateNotification" : {
"properties" : {
@@ -1416,7 +1450,7 @@
"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" : {
@@ -1434,7 +1468,7 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
}
},
@@ -1536,7 +1570,7 @@
"type" : "array"
},
"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" : {
@@ -1544,7 +1578,7 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
},
"verification" : {
@@ -1576,7 +1610,7 @@
"$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" : {
@@ -1594,7 +1628,7 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
}
},
@@ -1781,6 +1815,9 @@
"sourceAccountCode",
"stateOrProvince",
"status",
"stockExchange",
"stockNumber",
"stockTicker",
"store",
"storeDetail",
"storeName",
@@ -1829,11 +1866,7 @@
},
"type" : "array"
}
},
"required" : [
"checks",
"bankAccountUUID"
]
}
},
"KYCCheckDataSummaryItem" : {
"properties" : {
@@ -1857,10 +1890,7 @@
},
"type" : "array"
}
},
"required" : [
"checks"
]
}
},
"KYCCheckStatusData" : {
"properties" : {
@@ -1891,22 +1921,22 @@
"$ref" : "#/components/schemas/KYCCheckSummary"
},
"type" : {
"description" : "The type of check.\n>Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`.",
"description" : "The type of check.\n>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"
"PASSPORT_VERIFICATION",
"PAYOUT_METHOD_VERIFICATION"
],
"type" : "string"
}
},
"required" : [
"type",
"status",
"summary",
"requiredFields"
"status"
]
},
"KYCCheckSummary" : {
@@ -1938,11 +1968,7 @@
"description" : "The code of the shareholder to which the check applies.",
"type" : "string"
}
},
"required" : [
"checks",
"shareholderCode"
]
}
},
"KYCVerificationResult" : {
"properties" : {
@@ -1964,12 +1990,7 @@
},
"type" : "array"
}
},
"required" : [
"accountHolder",
"shareholders",
"bankAccounts"
]
}
},
"LocalDate" : {
"properties" : {
@@ -1998,13 +2019,10 @@
"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" : {
@@ -2134,8 +2152,7 @@
}
},
"required" : [
"type",
"number"
"type"
]
},
"RefundFundsTransferNotification" : {
@@ -2425,15 +2442,18 @@
"type" : "string"
},
"transactionStatus" : {
"description" : "The status of the transaction.\n>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.",
"description" : "The status of the transaction.\n>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",
@@ -2549,7 +2569,7 @@
"type" : "array"
},
"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" : {
@@ -2557,7 +2577,7 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
},
"updatedFields" : {
@@ -2590,7 +2610,7 @@
"$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" : {
@@ -2598,15 +2618,14 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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"
"accountCode"
]
},
"ViasAddress" : {
@@ -2724,6 +2743,17 @@
"phoneNumber"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
}
}
}

174
json/MarketPayNotificationService-v4.json
View File

@@ -1,9 +1,9 @@
{
"openapi" : "3.0.0",
"openapi" : "3.0.3",
"info" : {
"version" : "4",
"title" : "Adyen MarketPay 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.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).",
"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.\n\nFor 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",
@@ -24,6 +24,7 @@
"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" : {
@@ -53,6 +54,7 @@
"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" : {
@@ -82,6 +84,7 @@
"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" : {
@@ -111,6 +114,7 @@
"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" : {
@@ -140,6 +144,7 @@
"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" : {
@@ -169,6 +174,7 @@
"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" : {
@@ -198,6 +204,7 @@
"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" : {
@@ -227,6 +234,7 @@
"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" : {
@@ -256,6 +264,7 @@
"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" : {
@@ -285,6 +294,7 @@
"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" : {
@@ -314,6 +324,7 @@
"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" : {
@@ -343,6 +354,7 @@
"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" : {
@@ -372,6 +384,7 @@
"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" : {
@@ -401,6 +414,7 @@
"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" : {
@@ -426,10 +440,41 @@
}
}
},
"/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" : {
@@ -459,6 +504,7 @@
"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" : {
@@ -488,6 +534,7 @@
"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" : {
@@ -517,6 +564,7 @@
"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" : {
@@ -716,6 +764,9 @@
"type" : "string"
},
"metadata" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.",
"type" : "object"
},
@@ -843,11 +894,7 @@
}
},
"required" : [
"status",
"statusReason",
"processingState",
"payoutState",
"events"
"status"
]
},
"AccountHolderStatusChangeNotification" : {
@@ -908,8 +955,7 @@
"required" : [
"accountHolderCode",
"oldStatus",
"newStatus",
"reason"
"newStatus"
]
},
"AccountHolderStoreStatusChangeNotification" : {
@@ -1137,10 +1183,12 @@
"description" : "The type of validation performed.",
"enum" : [
"BANK_ACCOUNT_VERIFICATION",
"CARD_VERIFICATION",
"COMPANY_VERIFICATION",
"IDENTITY_VERIFICATION",
"NONPROFIT_VERIFICATION",
"PASSPORT_VERIFICATION"
"PASSPORT_VERIFICATION",
"PAYOUT_METHOD_VERIFICATION"
],
"type" : "string"
}
@@ -1172,14 +1220,7 @@
"format" : "int32",
"type" : "integer"
}
},
"required" : [
"allowPayout",
"disabled",
"tierNumber",
"disableReason",
"payoutLimit"
]
}
},
"AccountProcessingState" : {
"properties" : {
@@ -1204,14 +1245,7 @@
"format" : "int32",
"type" : "integer"
}
},
"required" : [
"disabled",
"disableReason",
"processedFrom",
"processedTo",
"tierNumber"
]
}
},
"AccountUpdateNotification" : {
"properties" : {
@@ -1482,7 +1516,7 @@
"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" : {
@@ -1500,7 +1534,7 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
}
},
@@ -1623,7 +1657,7 @@
"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" : {
@@ -1631,7 +1665,7 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
},
"verification" : {
@@ -1668,7 +1702,7 @@
"$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" : {
@@ -1686,7 +1720,7 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
}
},
@@ -1879,6 +1913,9 @@
"sourceAccountCode",
"stateOrProvince",
"status",
"stockExchange",
"stockNumber",
"stockTicker",
"store",
"storeDetail",
"storeName",
@@ -1927,11 +1964,7 @@
},
"type" : "array"
}
},
"required" : [
"checks",
"bankAccountUUID"
]
}
},
"KYCCheckResult" : {
"properties" : {
@@ -1942,10 +1975,7 @@
},
"type" : "array"
}
},
"required" : [
"checks"
]
}
},
"KYCCheckStatusData" : {
"properties" : {
@@ -1976,22 +2006,22 @@
"$ref" : "#/components/schemas/KYCCheckSummary"
},
"type" : {
"description" : "The type of check.\n>Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`.",
"description" : "The type of check.\n>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"
"PASSPORT_VERIFICATION",
"PAYOUT_METHOD_VERIFICATION"
],
"type" : "string"
}
},
"required" : [
"type",
"status",
"summary",
"requiredFields"
"status"
]
},
"KYCCheckSummary" : {
@@ -2023,11 +2053,7 @@
"description" : "The code of the shareholder to which the check applies.",
"type" : "string"
}
},
"required" : [
"checks",
"shareholderCode"
]
}
},
"KYCVerificationResult" : {
"properties" : {
@@ -2049,12 +2075,7 @@
},
"type" : "array"
}
},
"required" : [
"accountHolder",
"shareholders",
"bankAccounts"
]
}
},
"LocalDate" : {
"properties" : {
@@ -2083,13 +2104,10 @@
"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" : {
@@ -2225,8 +2243,7 @@
}
},
"required" : [
"type",
"number"
"type"
]
},
"RefundFundsTransferNotification" : {
@@ -2534,15 +2551,18 @@
"type" : "string"
},
"transactionStatus" : {
"description" : "The status of the transaction.\n>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.",
"description" : "The status of the transaction.\n>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",
@@ -2679,7 +2699,7 @@
"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" : {
@@ -2687,7 +2707,7 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.",
"type" : "boolean"
},
"updatedFields" : {
@@ -2725,7 +2745,7 @@
"$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" : {
@@ -2733,15 +2753,14 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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"
"accountCode"
]
},
"ViasAddress" : {
@@ -2859,6 +2878,17 @@
"phoneNumber"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
}
}
}

214
json/MarketPayNotificationService-v5.json
View File

@@ -1,9 +1,9 @@
{
"openapi" : "3.0.0",
"openapi" : "3.0.3",
"info" : {
"version" : "5",
"title" : "Adyen MarketPay 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.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).",
"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.\n\nFor 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",
@@ -24,6 +24,7 @@
"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" : {
@@ -53,6 +54,7 @@
"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" : {
@@ -82,6 +84,7 @@
"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" : {
@@ -111,6 +114,7 @@
"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" : {
@@ -140,6 +144,7 @@
"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" : {
@@ -169,6 +174,7 @@
"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" : {
@@ -198,6 +204,7 @@
"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" : {
@@ -227,6 +234,7 @@
"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" : {
@@ -256,6 +264,7 @@
"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" : {
@@ -285,6 +294,7 @@
"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" : {
@@ -314,6 +324,7 @@
"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" : {
@@ -343,6 +354,7 @@
"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" : {
@@ -372,6 +384,7 @@
"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" : {
@@ -401,6 +414,7 @@
"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" : {
@@ -426,10 +440,41 @@
}
}
},
"/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" : {
@@ -459,6 +504,7 @@
"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" : {
@@ -488,6 +534,7 @@
"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" : {
@@ -517,6 +564,7 @@
"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" : {
@@ -707,6 +755,10 @@
},
"type" : "array"
},
"bankAggregatorDataReference" : {
"description" : "The opaque reference value returned by the Adyen API during bank account login.",
"type" : "string"
},
"businessDetails" : {
"description" : "Details applicable to `Business` legal entities.\nPopulated only if the account holder's legal entity is of type `Business`.\n> Required when being used in a `/createAccountHolder` request in which the legal entity is `Business`.",
"$ref" : "#/components/schemas/BusinessDetails"
@@ -728,6 +780,9 @@
"type" : "string"
},
"metadata" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.",
"type" : "object"
},
@@ -838,6 +893,14 @@
"description" : "The PSP reference of the original payout.",
"type" : "string"
},
"payoutSpeed" : {
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"SAME_DAY",
"STANDARD"
],
"type" : "string"
},
"status" : {
"description" : "The payout status.",
"$ref" : "#/components/schemas/OperationStatus"
@@ -881,11 +944,7 @@
}
},
"required" : [
"status",
"statusReason",
"processingState",
"payoutState",
"events"
"status"
]
},
"AccountHolderStatusChangeNotification" : {
@@ -957,8 +1016,7 @@
"required" : [
"accountHolderCode",
"oldStatus",
"newStatus",
"reason"
"newStatus"
]
},
"AccountHolderStoreStatusChangeNotification" : {
@@ -1054,8 +1112,7 @@
"store",
"storeReference",
"oldStatus",
"newStatus",
"reason"
"newStatus"
]
},
"AccountHolderUpcomingDeadlineNotification" : {
@@ -1269,15 +1326,7 @@
"format" : "int32",
"type" : "integer"
}
},
"required" : [
"allowPayout",
"disabled",
"tierNumber",
"disableReason",
"payoutLimit",
"notAllowedReason"
]
}
},
"AccountProcessingState" : {
"properties" : {
@@ -1302,14 +1351,7 @@
"format" : "int32",
"type" : "integer"
}
},
"required" : [
"disabled",
"disableReason",
"processedFrom",
"processedTo",
"tierNumber"
]
}
},
"AccountUpdateNotification" : {
"properties" : {
@@ -1604,7 +1646,7 @@
"type" : "array"
},
"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" : {
@@ -1748,7 +1790,7 @@
"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" : {
@@ -1800,8 +1842,16 @@
"description" : "The payout schedule of the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"SAME_DAY",
"STANDARD"
],
"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" : {
@@ -2011,6 +2061,9 @@
"sourceAccountCode",
"stateOrProvince",
"status",
"stockExchange",
"stockNumber",
"stockTicker",
"store",
"storeDetail",
"storeName",
@@ -2059,11 +2112,22 @@
},
"type" : "array"
}
},
"required" : [
"checks",
"bankAccountUUID"
]
}
},
"KYCCardCheckResult" : {
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
},
"type" : "array"
},
"payoutMethodCode" : {
"description" : "The unique ID of the card to which the check applies.",
"type" : "string"
}
}
},
"KYCCheckResult" : {
"properties" : {
@@ -2074,10 +2138,7 @@
},
"type" : "array"
}
},
"required" : [
"checks"
]
}
},
"KYCCheckStatusData" : {
"properties" : {
@@ -2108,22 +2169,22 @@
"$ref" : "#/components/schemas/KYCCheckSummary"
},
"type" : {
"description" : "The type of check.\n>Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`.",
"description" : "The type of check.\n>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"
"PASSPORT_VERIFICATION",
"PAYOUT_METHOD_VERIFICATION"
],
"type" : "string"
}
},
"required" : [
"type",
"status",
"summary",
"requiredFields"
"status"
]
},
"KYCCheckSummary" : {
@@ -2152,11 +2213,7 @@
"description" : "The code of the shareholder to which the check applies.",
"type" : "string"
}
},
"required" : [
"checks",
"shareholderCode"
]
}
},
"KYCVerificationResult" : {
"properties" : {
@@ -2171,6 +2228,13 @@
},
"type" : "array"
},
"cards" : {
"description" : "The result(s) of the checks on the card(s).",
"items" : {
"$ref" : "#/components/schemas/KYCCardCheckResult"
},
"type" : "array"
},
"shareholders" : {
"description" : "The result(s) of the checks on the shareholder(s).",
"items" : {
@@ -2178,12 +2242,7 @@
},
"type" : "array"
}
},
"required" : [
"accountHolder",
"shareholders",
"bankAccounts"
]
}
},
"LocalDate" : {
"properties" : {
@@ -2224,13 +2283,10 @@
"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" : {
@@ -2397,8 +2453,7 @@
}
},
"required" : [
"type",
"number"
"type"
]
},
"RefundFundsTransferNotification" : {
@@ -2736,15 +2791,18 @@
"type" : "string"
},
"transactionStatus" : {
"description" : "The status of the transaction.\n>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.",
"description" : "The status of the transaction.\n>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",
@@ -2896,7 +2954,7 @@
"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" : {
@@ -2942,8 +3000,16 @@
"description" : "The payout schedule of the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"SAME_DAY",
"STANDARD"
],
"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" : {
@@ -2953,8 +3019,7 @@
},
"required" : [
"pspReference",
"accountCode",
"payoutSchedule"
"accountCode"
]
},
"ViasAddress" : {
@@ -3067,6 +3132,17 @@
"phoneNumber"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
}
}
}

3163
json/MarketPayNotificationService-v6.json Normal file
View File

File diff suppressed because it is too large Load Diff

69
json/NotificationConfigurationService-v1.json
View File

@@ -1,5 +1,5 @@
{
"openapi" : "3.0.0",
"openapi" : "3.0.3",
"servers" : [
{
"url" : "https://cal-test.adyen.com/cal/services/Notification/v1"
@@ -7,8 +7,8 @@
],
"info" : {
"version" : "1",
"title" : "Adyen MarketPay Notification Configuration API",
"description" : "The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).\n## Authentication\nTo connect to the MarketPay 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\nMarketPay 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/Notification/v1/createNotificationConfiguration\n```",
"title" : "Adyen for Platforms: Notification Configuration API",
"description" : "The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketpay/marketpay-notifications).\n## Authentication\nTo connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [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 Notification Configuration 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/Notification/v1/createNotificationConfiguration\n```",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Support",
@@ -22,8 +22,9 @@
"paths" : {
"/createNotificationConfiguration" : {
"post" : {
"summary" : "Configure a new subscription to notifications.",
"description" : "This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"summary" : "Subscribe to notifications.",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"requestBody" : {
@@ -53,6 +54,7 @@
"post" : {
"summary" : "Delete an existing notification subscription configuration.",
"description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"requestBody" : {
@@ -82,6 +84,7 @@
"post" : {
"summary" : "Retrieve an existing notification subscription configuration.",
"description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"requestBody" : {
@@ -111,6 +114,7 @@
"post" : {
"summary" : "Retrieve a list of existing notification subscription configurations.",
"description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"requestBody" : {
@@ -140,6 +144,7 @@
"post" : {
"summary" : "Test an existing notification configuration.",
"description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"requestBody" : {
@@ -169,6 +174,7 @@
"post" : {
"summary" : "Update an existing notification subscription configuration.",
"description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"requestBody" : {
@@ -239,7 +245,7 @@
"GenericResponse" : {
"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" : {
@@ -247,14 +253,10 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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"
]
}
},
"GetNotificationConfigurationListResponse" : {
"properties" : {
@@ -266,7 +268,7 @@
"type" : "array"
},
"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" : {
@@ -274,13 +276,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"configurations"
]
},
@@ -303,7 +303,7 @@
"$ref" : "#/components/schemas/NotificationConfigurationDetails"
},
"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" : {
@@ -311,13 +311,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"configurationDetails"
]
},
@@ -333,7 +331,7 @@
"type" : "integer"
},
"description" : {
"description" : "A description of the notification subscription configuration.\n>Required when creating a configuration, forbidden when updating a configuration.",
"description" : "A description of the notification subscription configuration.",
"type" : "string"
},
"eventConfigs" : {
@@ -413,10 +411,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -455,10 +453,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -502,10 +500,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -531,7 +529,7 @@
"type" : "array"
},
"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" : {
@@ -539,13 +537,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"notificationId",
"eventTypes",
"okMessages",
@@ -563,6 +559,17 @@
"configurationDetails"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
}
}
}

69
json/NotificationConfigurationService-v2.json
View File

@@ -1,5 +1,5 @@
{
"openapi" : "3.0.0",
"openapi" : "3.0.3",
"servers" : [
{
"url" : "https://cal-test.adyen.com/cal/services/Notification/v2"
@@ -7,8 +7,8 @@
],
"info" : {
"version" : "2",
"title" : "Adyen MarketPay Notification Configuration API",
"description" : "The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).\n## Authentication\nTo connect to the MarketPay 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\nMarketPay 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/Notification/v2/createNotificationConfiguration\n```",
"title" : "Adyen for Platforms: Notification Configuration API",
"description" : "The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketpay/marketpay-notifications).\n## Authentication\nTo connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [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 Notification Configuration 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/Notification/v2/createNotificationConfiguration\n```",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Support",
@@ -22,8 +22,9 @@
"paths" : {
"/createNotificationConfiguration" : {
"post" : {
"summary" : "Configure a new subscription to notifications.",
"description" : "This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"summary" : "Subscribe to notifications.",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"requestBody" : {
@@ -53,6 +54,7 @@
"post" : {
"summary" : "Delete an existing notification subscription configuration.",
"description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"requestBody" : {
@@ -82,6 +84,7 @@
"post" : {
"summary" : "Retrieve an existing notification subscription configuration.",
"description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"requestBody" : {
@@ -111,6 +114,7 @@
"post" : {
"summary" : "Retrieve a list of existing notification subscription configurations.",
"description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"requestBody" : {
@@ -140,6 +144,7 @@
"post" : {
"summary" : "Test an existing notification configuration.",
"description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"requestBody" : {
@@ -169,6 +174,7 @@
"post" : {
"summary" : "Update an existing notification subscription configuration.",
"description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"requestBody" : {
@@ -239,7 +245,7 @@
"GenericResponse" : {
"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" : {
@@ -247,14 +253,10 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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"
]
}
},
"GetNotificationConfigurationListResponse" : {
"properties" : {
@@ -266,7 +268,7 @@
"type" : "array"
},
"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" : {
@@ -274,13 +276,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"configurations"
]
},
@@ -303,7 +303,7 @@
"$ref" : "#/components/schemas/NotificationConfigurationDetails"
},
"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" : {
@@ -311,13 +311,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"configurationDetails"
]
},
@@ -333,7 +331,7 @@
"type" : "integer"
},
"description" : {
"description" : "A description of the notification subscription configuration.\n>Required when creating a configuration, forbidden when updating a configuration.",
"description" : "A description of the notification subscription configuration.",
"type" : "string"
},
"eventConfigs" : {
@@ -413,10 +411,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -455,10 +453,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -502,10 +500,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -531,7 +529,7 @@
"type" : "array"
},
"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" : {
@@ -539,13 +537,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"notificationId",
"eventTypes",
"okMessages",
@@ -563,6 +559,17 @@
"configurationDetails"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
}
}
}

69
json/NotificationConfigurationService-v3.json
View File

@@ -1,5 +1,5 @@
{
"openapi" : "3.0.0",
"openapi" : "3.0.3",
"servers" : [
{
"url" : "https://cal-test.adyen.com/cal/services/Notification/v3"
@@ -7,8 +7,8 @@
],
"info" : {
"version" : "3",
"title" : "Adyen MarketPay Notification Configuration API",
"description" : "The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).\n## Authentication\nTo connect to the MarketPay 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\nMarketPay 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/Notification/v3/createNotificationConfiguration\n```",
"title" : "Adyen for Platforms: Notification Configuration API",
"description" : "The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketpay/marketpay-notifications).\n## Authentication\nTo connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [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 Notification Configuration 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/Notification/v3/createNotificationConfiguration\n```",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Support",
@@ -22,8 +22,9 @@
"paths" : {
"/createNotificationConfiguration" : {
"post" : {
"summary" : "Configure a new subscription to notifications.",
"description" : "This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"summary" : "Subscribe to notifications.",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"requestBody" : {
@@ -53,6 +54,7 @@
"post" : {
"summary" : "Delete an existing notification subscription configuration.",
"description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"requestBody" : {
@@ -82,6 +84,7 @@
"post" : {
"summary" : "Retrieve an existing notification subscription configuration.",
"description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"requestBody" : {
@@ -111,6 +114,7 @@
"post" : {
"summary" : "Retrieve a list of existing notification subscription configurations.",
"description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"requestBody" : {
@@ -140,6 +144,7 @@
"post" : {
"summary" : "Test an existing notification configuration.",
"description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"requestBody" : {
@@ -169,6 +174,7 @@
"post" : {
"summary" : "Update an existing notification subscription configuration.",
"description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"requestBody" : {
@@ -239,7 +245,7 @@
"GenericResponse" : {
"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" : {
@@ -247,14 +253,10 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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"
]
}
},
"GetNotificationConfigurationListResponse" : {
"properties" : {
@@ -266,7 +268,7 @@
"type" : "array"
},
"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" : {
@@ -274,13 +276,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"configurations"
]
},
@@ -303,7 +303,7 @@
"$ref" : "#/components/schemas/NotificationConfigurationDetails"
},
"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" : {
@@ -311,13 +311,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"configurationDetails"
]
},
@@ -333,7 +331,7 @@
"type" : "integer"
},
"description" : {
"description" : "A description of the notification subscription configuration.\n>Required when creating a configuration, forbidden when updating a configuration.",
"description" : "A description of the notification subscription configuration.",
"type" : "string"
},
"eventConfigs" : {
@@ -413,10 +411,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -455,10 +453,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -502,10 +500,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -531,7 +529,7 @@
"type" : "array"
},
"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" : {
@@ -539,13 +537,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"notificationId",
"eventTypes",
"okMessages",
@@ -563,6 +559,17 @@
"configurationDetails"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
}
}
}

69
json/NotificationConfigurationService-v4.json
View File

@@ -1,5 +1,5 @@
{
"openapi" : "3.0.0",
"openapi" : "3.0.3",
"servers" : [
{
"url" : "https://cal-test.adyen.com/cal/services/Notification/v4"
@@ -7,8 +7,8 @@
],
"info" : {
"version" : "4",
"title" : "Adyen MarketPay Notification Configuration API",
"description" : "The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).\n## Authentication\nTo connect to the MarketPay 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\nMarketPay 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/Notification/v4/createNotificationConfiguration\n```",
"title" : "Adyen for Platforms: Notification Configuration API",
"description" : "The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketpay/marketpay-notifications).\n## Authentication\nTo connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [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 Notification Configuration 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/Notification/v4/createNotificationConfiguration\n```",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Support",
@@ -22,8 +22,9 @@
"paths" : {
"/createNotificationConfiguration" : {
"post" : {
"summary" : "Configure a new subscription to notifications.",
"description" : "This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"summary" : "Subscribe to notifications.",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"requestBody" : {
@@ -53,6 +54,7 @@
"post" : {
"summary" : "Delete an existing notification subscription configuration.",
"description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"requestBody" : {
@@ -82,6 +84,7 @@
"post" : {
"summary" : "Retrieve an existing notification subscription configuration.",
"description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"requestBody" : {
@@ -111,6 +114,7 @@
"post" : {
"summary" : "Retrieve a list of existing notification subscription configurations.",
"description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"requestBody" : {
@@ -140,6 +144,7 @@
"post" : {
"summary" : "Test an existing notification configuration.",
"description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"requestBody" : {
@@ -169,6 +174,7 @@
"post" : {
"summary" : "Update an existing notification subscription configuration.",
"description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"requestBody" : {
@@ -239,7 +245,7 @@
"GenericResponse" : {
"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" : {
@@ -247,14 +253,10 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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"
]
}
},
"GetNotificationConfigurationListResponse" : {
"properties" : {
@@ -266,7 +268,7 @@
"type" : "array"
},
"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" : {
@@ -274,13 +276,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"configurations"
]
},
@@ -303,7 +303,7 @@
"$ref" : "#/components/schemas/NotificationConfigurationDetails"
},
"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" : {
@@ -311,13 +311,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"configurationDetails"
]
},
@@ -333,7 +331,7 @@
"type" : "integer"
},
"description" : {
"description" : "A description of the notification subscription configuration.\n>Required when creating a configuration, forbidden when updating a configuration.",
"description" : "A description of the notification subscription configuration.",
"type" : "string"
},
"eventConfigs" : {
@@ -413,10 +411,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -455,10 +453,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -502,10 +500,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -531,7 +529,7 @@
"type" : "array"
},
"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" : {
@@ -539,13 +537,11 @@
"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:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
"description" : "Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **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",
"notificationId",
"eventTypes",
"okMessages",
@@ -563,6 +559,17 @@
"configurationDetails"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
}
}
}

60
json/NotificationConfigurationService-v5.json
View File

@@ -1,5 +1,5 @@
{
"openapi" : "3.0.0",
"openapi" : "3.0.3",
"servers" : [
{
"url" : "https://cal-test.adyen.com/cal/services/Notification/v5"
@@ -7,8 +7,8 @@
],
"info" : {
"version" : "5",
"title" : "Adyen MarketPay Notification Configuration API",
"description" : "The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).\n## Authentication\nTo connect to the MarketPay 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\nMarketPay 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/Notification/v5/createNotificationConfiguration\n```",
"title" : "Adyen for Platforms: Notification Configuration API",
"description" : "The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketpay/marketpay-notifications).\n## Authentication\nTo connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [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 Notification Configuration 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/Notification/v5/createNotificationConfiguration\n```",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Support",
@@ -22,8 +22,9 @@
"paths" : {
"/createNotificationConfiguration" : {
"post" : {
"summary" : "Configure a new subscription to notifications.",
"description" : "This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"summary" : "Subscribe to notifications.",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"requestBody" : {
@@ -53,6 +54,7 @@
"post" : {
"summary" : "Delete an existing notification subscription configuration.",
"description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"requestBody" : {
@@ -82,6 +84,7 @@
"post" : {
"summary" : "Retrieve an existing notification subscription configuration.",
"description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"requestBody" : {
@@ -111,6 +114,7 @@
"post" : {
"summary" : "Retrieve a list of existing notification subscription configurations.",
"description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"requestBody" : {
@@ -140,6 +144,7 @@
"post" : {
"summary" : "Test an existing notification configuration.",
"description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"requestBody" : {
@@ -169,6 +174,7 @@
"post" : {
"summary" : "Update an existing notification subscription configuration.",
"description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"requestBody" : {
@@ -352,6 +358,9 @@
"sourceAccountCode",
"stateOrProvince",
"status",
"stockExchange",
"stockNumber",
"stockTicker",
"store",
"storeDetail",
"storeName",
@@ -385,17 +394,14 @@
"type" : "array"
},
"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"
}
},
"required" : [
"pspReference"
]
}
},
"GetNotificationConfigurationListResponse" : {
"properties" : {
@@ -414,7 +420,7 @@
"type" : "array"
},
"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" : {
@@ -423,7 +429,6 @@
}
},
"required" : [
"pspReference",
"configurations"
]
},
@@ -453,7 +458,7 @@
"type" : "array"
},
"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" : {
@@ -462,7 +467,6 @@
}
},
"required" : [
"pspReference",
"configurationDetails"
]
},
@@ -478,7 +482,7 @@
"type" : "integer"
},
"description" : {
"description" : "A description of the notification subscription configuration.\n>Required when creating a configuration, forbidden when updating a configuration.",
"description" : "A description of the notification subscription configuration.",
"type" : "string"
},
"eventConfigs" : {
@@ -548,10 +552,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -590,10 +594,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -637,10 +641,10 @@
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REFUND"
"TRANSFER_FUNDS"
],
"type" : "string"
},
@@ -673,7 +677,7 @@
"type" : "array"
},
"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" : {
@@ -682,7 +686,6 @@
}
},
"required" : [
"pspReference",
"notificationId",
"eventTypes",
"okMessages",
@@ -700,6 +703,17 @@
"configurationDetails"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
}
}
}

719
json/NotificationConfigurationService-v6.json Normal file
View File

@@ -0,0 +1,719 @@
{
"openapi" : "3.0.3",
"servers" : [
{
"url" : "https://cal-test.adyen.com/cal/services/Notification/v6"
}
],
"info" : {
"version" : "6",
"title" : "Adyen for Platforms: Notification Configuration API",
"description" : "The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketpay/marketpay-notifications).\n## Authentication\nTo connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [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 Notification Configuration 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/Notification/v6/createNotificationConfiguration\n```",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Support",
"url" : "https://support.adyen.com/",
"email" : "support@adyen.com"
}
},
"x-groups" : [
"General"
],
"paths" : {
"/createNotificationConfiguration" : {
"post" : {
"summary" : "Subscribe to notifications.",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateNotificationConfigurationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNotificationConfigurationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/deleteNotificationConfigurations" : {
"post" : {
"summary" : "Delete an existing notification subscription configuration.",
"description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteNotificationConfigurationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenericResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/getNotificationConfiguration" : {
"post" : {
"summary" : "Retrieve an existing notification subscription configuration.",
"description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNotificationConfigurationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNotificationConfigurationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/getNotificationConfigurationList" : {
"post" : {
"summary" : "Retrieve a list of existing notification subscription configurations.",
"description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EmptyRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNotificationConfigurationListResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/testNotificationConfiguration" : {
"post" : {
"summary" : "Test an existing notification configuration.",
"description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestNotificationConfigurationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestNotificationConfigurationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/updateNotificationConfiguration" : {
"post" : {
"summary" : "Update an existing notification subscription configuration.",
"description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateNotificationConfigurationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNotificationConfigurationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
}
},
"components" : {
"schemas" : {
"CreateNotificationConfigurationRequest" : {
"properties" : {
"configurationDetails" : {
"description" : "Details of the prospective notification subscription configuration.",
"$ref" : "#/components/schemas/NotificationConfigurationDetails"
}
},
"required" : [
"configurationDetails"
]
},
"DeleteNotificationConfigurationRequest" : {
"properties" : {
"notificationIds" : {
"description" : "A list of IDs of the notification subscription configurations to be deleted.",
"items" : {
"format" : "int64",
"type" : "integer"
},
"type" : "array"
}
},
"required" : [
"notificationIds"
]
},
"EmptyRequest" : {
},
"ErrorFieldType" : {
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
"format" : "int32",
"type" : "integer"
},
"errorDescription" : {
"description" : "A description of the validation error.",
"type" : "string"
},
"fieldType" : {
"description" : "The type of error field.",
"$ref" : "#/components/schemas/FieldType"
}
}
},
"ExchangeMessage" : {
"properties" : {
"messageCode" : {
"type" : "string"
},
"messageDescription" : {
"type" : "string"
}
}
},
"FieldType" : {
"properties" : {
"field" : {
"description" : "The full name of the property.",
"type" : "string"
},
"fieldName" : {
"description" : "The type of the field.",
"enum" : [
"accountCode",
"accountHolderCode",
"accountHolderDetails",
"accountNumber",
"accountStateType",
"accountStatus",
"accountType",
"address",
"bankAccount",
"bankAccountCode",
"bankAccountName",
"bankAccountUUID",
"bankBicSwift",
"bankCity",
"bankCode",
"bankName",
"bankStatement",
"branchCode",
"businessContact",
"cardToken",
"checkCode",
"city",
"companyRegistration",
"country",
"countryCode",
"currency",
"currencyCode",
"dateOfBirth",
"description",
"destinationAccountCode",
"document",
"documentExpirationDate",
"documentIssuerCountry",
"documentIssuerState",
"documentName",
"documentNumber",
"documentType",
"doingBusinessAs",
"drivingLicence",
"drivingLicenceBack",
"drivingLicense",
"email",
"firstName",
"fullPhoneNumber",
"gender",
"hopWebserviceUser",
"houseNumberOrName",
"iban",
"idCard",
"idCardBack",
"idCardFront",
"idNumber",
"identityDocument",
"individualDetails",
"lastName",
"legalBusinessName",
"legalEntity",
"legalEntityType",
"merchantAccount",
"merchantCategoryCode",
"merchantReference",
"microDeposit",
"name",
"nationality",
"originalReference",
"ownerCity",
"ownerCountryCode",
"ownerHouseNumberOrName",
"ownerName",
"ownerPostalCode",
"ownerState",
"ownerStreet",
"passport",
"passportNumber",
"payoutMethodCode",
"personalData",
"phoneCountryCode",
"phoneNumber",
"postalCode",
"primaryCurrency",
"reason",
"registrationNumber",
"returnUrl",
"schedule",
"shareholder",
"shareholderCode",
"socialSecurityNumber",
"sourceAccountCode",
"stateOrProvince",
"status",
"stockExchange",
"stockNumber",
"stockTicker",
"store",
"storeDetail",
"storeName",
"storeReference",
"street",
"taxId",
"tier",
"tierNumber",
"transferCode",
"unknown",
"value",
"virtualAccount",
"visaNumber",
"webAddress"
],
"type" : "string"
},
"shareholderCode" : {
"description" : "The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.",
"type" : "string"
}
}
},
"GenericResponse" : {
"properties" : {
"invalidFields" : {
"description" : "Contains field validation errors that would prevent requests from being processed.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result code.",
"type" : "string"
}
}
},
"GetNotificationConfigurationListResponse" : {
"properties" : {
"configurations" : {
"description" : "Details of the notification subscription configurations.",
"items" : {
"$ref" : "#/components/schemas/NotificationConfigurationDetails"
},
"type" : "array"
},
"invalidFields" : {
"description" : "Contains field validation errors that would prevent requests from being processed.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result code.",
"type" : "string"
}
},
"required" : [
"configurations"
]
},
"GetNotificationConfigurationRequest" : {
"properties" : {
"notificationId" : {
"description" : "The ID of the notification subscription configuration whose details are to be retrieved.",
"format" : "int64",
"type" : "integer"
}
},
"required" : [
"notificationId"
]
},
"GetNotificationConfigurationResponse" : {
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration.",
"$ref" : "#/components/schemas/NotificationConfigurationDetails"
},
"invalidFields" : {
"description" : "Contains field validation errors that would prevent requests from being processed.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result code.",
"type" : "string"
}
},
"required" : [
"configurationDetails"
]
},
"NotificationConfigurationDetails" : {
"properties" : {
"active" : {
"description" : "Indicates whether the notification subscription is active.",
"type" : "boolean"
},
"apiVersion" : {
"description" : "The API version of the notification to send.",
"format" : "int32",
"type" : "integer"
},
"description" : {
"description" : "A description of the notification subscription configuration.",
"type" : "string"
},
"eventConfigs" : {
"description" : "The types of events whose notifications apply to this configuration.",
"items" : {
"$ref" : "#/components/schemas/NotificationEventConfiguration"
},
"type" : "array"
},
"hmacSignatureKey" : {
"description" : "A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the notification header `Protocol`. A notification body along with its `hmacSignatureKey` and `Protocol` can be used to calculate a hash value; matching this hash value with the `HmacSignature` will ensure that the notification body has not been tampered with or corrupted.\n\n>Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. \"b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27\").\n\nThe omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).",
"type" : "string"
},
"notificationId" : {
"description" : "The ID of the configuration.\n>Required if updating an existing configuration, ignored during the creation of a configuration.",
"format" : "int64",
"type" : "integer"
},
"notifyPassword" : {
"description" : "The password to use when accessing the notifyURL with the specified username.",
"type" : "string"
},
"notifyURL" : {
"description" : "The URL to which the notifications are to be sent.",
"type" : "string"
},
"notifyUsername" : {
"description" : "The username to use when accessing the notifyURL.",
"type" : "string"
},
"sslProtocol" : {
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.",
"enum" : [
"SSL",
"SSLInsecureCiphers",
"TLS",
"TLSv10",
"TLSv10InsecureCiphers",
"TLSv11",
"TLSv12"
],
"type" : "string"
}
},
"required" : [
"eventConfigs",
"notifyURL"
]
},
"NotificationEventConfiguration" : {
"properties" : {
"eventType" : {
"description" : "The type of event triggering the notification.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.",
"enum" : [
"ACCOUNT_CLOSED",
"ACCOUNT_CREATED",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
"ACCOUNT_HOLDER_UPCOMING_DEADLINE",
"ACCOUNT_HOLDER_UPDATED",
"ACCOUNT_HOLDER_VERIFICATION",
"ACCOUNT_UPDATED",
"BENEFICIARY_SETUP",
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS"
],
"type" : "string"
},
"includeMode" : {
"description" : "Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent.\n>Permitted values: `INCLUDE`, `EXCLUDE`.\n>- `INCLUDE`: send the specified eventType.\n>- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).",
"enum" : [
"EXCLUDE",
"INCLUDE"
],
"type" : "string"
}
},
"required" : [
"eventType",
"includeMode"
]
},
"TestNotificationConfigurationRequest" : {
"properties" : {
"eventTypes" : {
"description" : "The event types to test. If left blank, then all of the configured event types will be tested.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.",
"items" : {
"enum" : [
"ACCOUNT_CLOSED",
"ACCOUNT_CREATED",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
"ACCOUNT_HOLDER_UPCOMING_DEADLINE",
"ACCOUNT_HOLDER_UPDATED",
"ACCOUNT_HOLDER_VERIFICATION",
"ACCOUNT_UPDATED",
"BENEFICIARY_SETUP",
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS"
],
"type" : "string"
},
"type" : "array"
},
"notificationId" : {
"description" : "The ID of the notification subscription configuration to be tested.",
"format" : "int64",
"type" : "integer"
}
},
"required" : [
"notificationId"
]
},
"TestNotificationConfigurationResponse" : {
"properties" : {
"errorMessages" : {
"description" : "Any error messages encountered.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"eventTypes" : {
"description" : "The event types that were tested.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.",
"items" : {
"enum" : [
"ACCOUNT_CLOSED",
"ACCOUNT_CREATED",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
"ACCOUNT_HOLDER_UPCOMING_DEADLINE",
"ACCOUNT_HOLDER_UPDATED",
"ACCOUNT_HOLDER_VERIFICATION",
"ACCOUNT_UPDATED",
"BENEFICIARY_SETUP",
"COMPENSATE_NEGATIVE_BALANCE",
"DIRECT_DEBIT_INITIATED",
"PAYMENT_FAILURE",
"REFUND_FUNDS_TRANSFER",
"REPORT_AVAILABLE",
"SCHEDULED_REFUNDS",
"TRANSFER_FUNDS"
],
"type" : "string"
},
"type" : "array"
},
"exchangeMessages" : {
"description" : "The notification message and related response messages.",
"items" : {
"$ref" : "#/components/schemas/ExchangeMessage"
},
"type" : "array"
},
"invalidFields" : {
"description" : "Contains field validation errors that would prevent requests from being processed.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"notificationId" : {
"description" : "The ID of the notification subscription configuration.",
"format" : "int64",
"type" : "integer"
},
"okMessages" : {
"description" : "A list of messages describing the testing steps.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result code.",
"type" : "string"
}
},
"required" : [
"notificationId",
"eventTypes",
"okMessages",
"exchangeMessages"
]
},
"UpdateNotificationConfigurationRequest" : {
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration to be updated.",
"$ref" : "#/components/schemas/NotificationConfigurationDetails"
}
},
"required" : [
"configurationDetails"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
}
}
}

149
yaml/MarketPayNotificationService-v3.yaml
View File

@@ -1,11 +1,11 @@
openapi: 3.0.0
openapi: 3.0.3
info:
version: '3'
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:
@@ -475,6 +512,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.
@@ -570,10 +609,6 @@ components:
type: string
required:
- status
- statusReason
- processingState
- payoutState
- events
AccountHolderStatusChangeNotification:
properties:
content:
@@ -614,7 +649,6 @@ components:
- accountHolderCode
- oldStatus
- newStatus
- reason
AccountHolderStoreStatusChangeNotification:
properties:
content:
@@ -772,10 +806,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
@@ -797,12 +833,6 @@ components:
description: The payout tier that the account holder occupies.
format: int32
type: integer
required:
- allowPayout
- disabled
- tierNumber
- disableReason
- payoutLimit
AccountProcessingState:
properties:
disableReason:
@@ -821,12 +851,6 @@ components:
description: The processing tier that the account holder occupies.
format: int32
type: integer
required:
- disabled
- disableReason
- processedFrom
- processedTo
- tierNumber
AccountUpdateNotification:
properties:
content:
@@ -1094,7 +1118,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.
@@ -1111,10 +1135,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
@@ -1187,17 +1210,16 @@ components:
$ref: '#/components/schemas/ErrorFieldType'
type: array
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.
@@ -1221,7 +1243,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.
@@ -1238,10 +1260,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
@@ -1402,6 +1423,9 @@ components:
- sourceAccountCode
- stateOrProvince
- status
- stockExchange
- stockNumber
- stockTicker
- store
- storeDetail
- storeName
@@ -1440,9 +1464,6 @@ components:
items:
$ref: '#/components/schemas/KYCCheckStatusData'
type: array
required:
- checks
- bankAccountUUID
KYCCheckDataSummaryItem:
properties:
itemCode:
@@ -1459,8 +1480,6 @@ components:
items:
$ref: '#/components/schemas/KYCCheckStatusData'
type: array
required:
- checks
KYCCheckStatusData:
properties:
requiredFields:
@@ -1489,19 +1508,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:
@@ -1523,9 +1542,6 @@ components:
shareholderCode:
description: The code of the shareholder to which the check applies.
type: string
required:
- checks
- shareholderCode
KYCVerificationResult:
properties:
accountHolder:
@@ -1541,10 +1557,6 @@ components:
items:
$ref: '#/components/schemas/KYCShareholderCheckResult'
type: array
required:
- accountHolder
- shareholders
- bankAccounts
LocalDate:
properties:
month:
@@ -1564,10 +1576,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:
@@ -1674,7 +1684,6 @@ components:
type: string
required:
- type
- number
RefundFundsTransferNotification:
properties:
content:
@@ -1898,15 +1907,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
@@ -1995,17 +2007,16 @@ components:
$ref: '#/components/schemas/ErrorFieldType'
type: array
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.
@@ -2029,23 +2040,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:
@@ -2157,3 +2166,11 @@ components:
required:
- phoneCountryCode
- phoneNumber
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http

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

150
yaml/MarketPayNotificationService-v5.yaml
View File

@@ -1,11 +1,11 @@
openapi: 3.0.0
openapi: 3.0.3
info:
version: '5'
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:
@@ -473,6 +510,9 @@ components:
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
bankAggregatorDataReference:
description: The opaque reference value returned by the Adyen API during bank account login.
type: string
businessDetails:
description: |-
Details applicable to `Business` legal entities.
@@ -499,6 +539,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.
@@ -587,6 +629,12 @@ components:
originalPspReference:
description: The PSP reference of the original payout.
type: string
payoutSpeed:
description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.'
enum:
- SAME_DAY
- STANDARD
type: string
status:
description: The payout status.
$ref: '#/components/schemas/OperationStatus'
@@ -621,10 +669,6 @@ components:
type: string
required:
- status
- statusReason
- processingState
- payoutState
- events
AccountHolderStatusChangeNotification:
properties:
content:
@@ -678,7 +722,6 @@ components:
- accountHolderCode
- oldStatus
- newStatus
- reason
AccountHolderStoreStatusChangeNotification:
properties:
content:
@@ -752,7 +795,6 @@ components:
- storeReference
- oldStatus
- newStatus
- reason
AccountHolderUpcomingDeadlineNotification:
properties:
content:
@@ -914,13 +956,6 @@ components:
description: The payout tier that the account holder occupies.
format: int32
type: integer
required:
- allowPayout
- disabled
- tierNumber
- disableReason
- payoutLimit
- notAllowedReason
AccountProcessingState:
properties:
disableReason:
@@ -939,12 +974,6 @@ components:
description: The processing tier that the account holder occupies.
format: int32
type: integer
required:
- disabled
- disableReason
- processedFrom
- processedTo
- tierNumber
AccountUpdateNotification:
properties:
content:
@@ -1242,7 +1271,7 @@ components:
$ref: '#/components/schemas/ErrorFieldType'
type: array
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.
@@ -1350,7 +1379,7 @@ components:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.'
type: string
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.
@@ -1388,8 +1417,14 @@ components:
payoutSchedule:
description: The payout schedule of the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.'
enum:
- SAME_DAY
- STANDARD
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.
@@ -1570,6 +1605,9 @@ components:
- sourceAccountCode
- stateOrProvince
- status
- stockExchange
- stockNumber
- stockTicker
- store
- storeDetail
- storeName
@@ -1608,9 +1646,16 @@ components:
items:
$ref: '#/components/schemas/KYCCheckStatusData'
type: array
required:
- checks
- bankAccountUUID
KYCCardCheckResult:
properties:
checks:
description: A list of the checks and their statuses.
items:
$ref: '#/components/schemas/KYCCheckStatusData'
type: array
payoutMethodCode:
description: The unique ID of the card to which the check applies.
type: string
KYCCheckResult:
properties:
checks:
@@ -1618,8 +1663,6 @@ components:
items:
$ref: '#/components/schemas/KYCCheckStatusData'
type: array
required:
- checks
KYCCheckStatusData:
properties:
requiredFields:
@@ -1648,19 +1691,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:
kycCheckCode:
@@ -1680,9 +1723,6 @@ components:
shareholderCode:
description: The code of the shareholder to which the check applies.
type: string
required:
- checks
- shareholderCode
KYCVerificationResult:
properties:
accountHolder:
@@ -1693,15 +1733,16 @@ components:
items:
$ref: '#/components/schemas/KYCBankAccountCheckResult'
type: array
cards:
description: The result(s) of the checks on the card(s).
items:
$ref: '#/components/schemas/KYCCardCheckResult'
type: array
shareholders:
description: The result(s) of the checks on the shareholder(s).
items:
$ref: '#/components/schemas/KYCShareholderCheckResult'
type: array
required:
- accountHolder
- shareholders
- bankAccounts
LocalDate:
properties:
month:
@@ -1729,10 +1770,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:
@@ -1865,7 +1904,6 @@ components:
type: string
required:
- type
- number
RefundFundsTransferNotification:
properties:
content:
@@ -2126,15 +2164,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
@@ -2251,7 +2292,7 @@ components:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.'
type: string
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.
@@ -2284,8 +2325,14 @@ components:
payoutSchedule:
description: The payout schedule of the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.'
enum:
- SAME_DAY
- STANDARD
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.
@@ -2293,7 +2340,6 @@ components:
required:
- pspReference
- accountCode
- payoutSchedule
ViasAddress:
properties:
city:
@@ -2401,3 +2447,11 @@ components:
required:
- phoneCountryCode
- phoneNumber
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http

2470
yaml/MarketPayNotificationService-v6.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

85
yaml/NotificationConfigurationService-v1.yaml
View File

@@ -1,15 +1,15 @@
openapi: 3.0.0
openapi: 3.0.3
servers:
- url: 'https://cal-test.adyen.com/cal/services/Notification/v1'
info:
version: '1'
title: Adyen MarketPay Notification Configuration API
title: 'Adyen for Platforms: Notification Configuration API'
description: |-
The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.
The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.
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).
## Authentication
To connect to the MarketPay 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:
To connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:
```
curl
@@ -20,7 +20,7 @@ info:
Note 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).
## Versioning
MarketPay 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.
The Notification Configuration 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:
```
@@ -36,8 +36,9 @@ x-groups:
paths:
/createNotificationConfiguration:
post:
summary: Configure a new subscription to notifications.
description: 'This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
summary: Subscribe to notifications.
description: 'Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
requestBody:
@@ -56,6 +57,7 @@ paths:
post:
summary: Delete an existing notification subscription configuration.
description: 'This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.'
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
requestBody:
@@ -74,6 +76,7 @@ paths:
post:
summary: Retrieve an existing notification subscription configuration.
description: This endpoint is used to retrieve the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
requestBody:
@@ -92,6 +95,7 @@ paths:
post:
summary: Retrieve a list of existing notification subscription configurations.
description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
requestBody:
@@ -110,6 +114,7 @@ paths:
post:
summary: Test an existing notification configuration.
description: 'This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.'
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
requestBody:
@@ -128,6 +133,7 @@ paths:
post:
summary: Update an existing notification subscription configuration.
description: 'This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.'
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
requestBody:
@@ -171,21 +177,17 @@ components:
GenericResponse:
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.
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
GetNotificationConfigurationListResponse:
properties:
configurations:
@@ -194,21 +196,18 @@ components:
$ref: '#/components/schemas/NotificationConfigurationDetails'
type: array
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
- configurations
GetNotificationConfigurationRequest:
properties:
@@ -224,21 +223,18 @@ components:
description: Details of the notification subscription configuration.
$ref: '#/components/schemas/NotificationConfigurationDetails'
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
- configurationDetails
NotificationConfigurationDetails:
properties:
@@ -250,9 +246,7 @@ components:
format: int32
type: integer
description:
description: |-
A description of the notification subscription configuration.
>Required when creating a configuration, forbidden when updating a configuration.
description: A description of the notification subscription configuration.
type: string
eventConfigs:
description: The types of events whose notifications apply to this configuration.
@@ -327,10 +321,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
includeMode:
description: |-
@@ -368,10 +362,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
notificationId:
@@ -408,10 +402,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
exchangeMessages:
@@ -429,21 +423,18 @@ components:
type: string
type: array
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
- notificationId
- eventTypes
- okMessages
@@ -455,3 +446,11 @@ components:
$ref: '#/components/schemas/NotificationConfigurationDetails'
required:
- configurationDetails
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http

85
yaml/NotificationConfigurationService-v2.yaml
View File

@@ -1,15 +1,15 @@
openapi: 3.0.0
openapi: 3.0.3
servers:
- url: 'https://cal-test.adyen.com/cal/services/Notification/v2'
info:
version: '2'
title: Adyen MarketPay Notification Configuration API
title: 'Adyen for Platforms: Notification Configuration API'
description: |-
The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.
The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.
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).
## Authentication
To connect to the MarketPay 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:
To connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:
```
curl
@@ -20,7 +20,7 @@ info:
Note 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).
## Versioning
MarketPay 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.
The Notification Configuration 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:
```
@@ -36,8 +36,9 @@ x-groups:
paths:
/createNotificationConfiguration:
post:
summary: Configure a new subscription to notifications.
description: 'This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
summary: Subscribe to notifications.
description: 'Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
requestBody:
@@ -56,6 +57,7 @@ paths:
post:
summary: Delete an existing notification subscription configuration.
description: 'This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.'
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
requestBody:
@@ -74,6 +76,7 @@ paths:
post:
summary: Retrieve an existing notification subscription configuration.
description: This endpoint is used to retrieve the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
requestBody:
@@ -92,6 +95,7 @@ paths:
post:
summary: Retrieve a list of existing notification subscription configurations.
description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
requestBody:
@@ -110,6 +114,7 @@ paths:
post:
summary: Test an existing notification configuration.
description: 'This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.'
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
requestBody:
@@ -128,6 +133,7 @@ paths:
post:
summary: Update an existing notification subscription configuration.
description: 'This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.'
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
requestBody:
@@ -171,21 +177,17 @@ components:
GenericResponse:
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.
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
GetNotificationConfigurationListResponse:
properties:
configurations:
@@ -194,21 +196,18 @@ components:
$ref: '#/components/schemas/NotificationConfigurationDetails'
type: array
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
- configurations
GetNotificationConfigurationRequest:
properties:
@@ -224,21 +223,18 @@ components:
description: Details of the notification subscription configuration.
$ref: '#/components/schemas/NotificationConfigurationDetails'
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
- configurationDetails
NotificationConfigurationDetails:
properties:
@@ -250,9 +246,7 @@ components:
format: int32
type: integer
description:
description: |-
A description of the notification subscription configuration.
>Required when creating a configuration, forbidden when updating a configuration.
description: A description of the notification subscription configuration.
type: string
eventConfigs:
description: The types of events whose notifications apply to this configuration.
@@ -327,10 +321,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
includeMode:
description: |-
@@ -368,10 +362,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
notificationId:
@@ -408,10 +402,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
exchangeMessages:
@@ -429,21 +423,18 @@ components:
type: string
type: array
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
- notificationId
- eventTypes
- okMessages
@@ -455,3 +446,11 @@ components:
$ref: '#/components/schemas/NotificationConfigurationDetails'
required:
- configurationDetails
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http

85
yaml/NotificationConfigurationService-v3.yaml
View File

@@ -1,15 +1,15 @@
openapi: 3.0.0
openapi: 3.0.3
servers:
- url: 'https://cal-test.adyen.com/cal/services/Notification/v3'
info:
version: '3'
title: Adyen MarketPay Notification Configuration API
title: 'Adyen for Platforms: Notification Configuration API'
description: |-
The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.
The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.
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).
## Authentication
To connect to the MarketPay 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:
To connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:
```
curl
@@ -20,7 +20,7 @@ info:
Note 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).
## Versioning
MarketPay 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.
The Notification Configuration 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:
```
@@ -36,8 +36,9 @@ x-groups:
paths:
/createNotificationConfiguration:
post:
summary: Configure a new subscription to notifications.
description: 'This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
summary: Subscribe to notifications.
description: 'Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
requestBody:
@@ -56,6 +57,7 @@ paths:
post:
summary: Delete an existing notification subscription configuration.
description: 'This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.'
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
requestBody:
@@ -74,6 +76,7 @@ paths:
post:
summary: Retrieve an existing notification subscription configuration.
description: This endpoint is used to retrieve the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
requestBody:
@@ -92,6 +95,7 @@ paths:
post:
summary: Retrieve a list of existing notification subscription configurations.
description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
requestBody:
@@ -110,6 +114,7 @@ paths:
post:
summary: Test an existing notification configuration.
description: 'This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.'
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
requestBody:
@@ -128,6 +133,7 @@ paths:
post:
summary: Update an existing notification subscription configuration.
description: 'This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.'
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
requestBody:
@@ -171,21 +177,17 @@ components:
GenericResponse:
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.
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
GetNotificationConfigurationListResponse:
properties:
configurations:
@@ -194,21 +196,18 @@ components:
$ref: '#/components/schemas/NotificationConfigurationDetails'
type: array
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
- configurations
GetNotificationConfigurationRequest:
properties:
@@ -224,21 +223,18 @@ components:
description: Details of the notification subscription configuration.
$ref: '#/components/schemas/NotificationConfigurationDetails'
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
- configurationDetails
NotificationConfigurationDetails:
properties:
@@ -250,9 +246,7 @@ components:
format: int32
type: integer
description:
description: |-
A description of the notification subscription configuration.
>Required when creating a configuration, forbidden when updating a configuration.
description: A description of the notification subscription configuration.
type: string
eventConfigs:
description: The types of events whose notifications apply to this configuration.
@@ -327,10 +321,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
includeMode:
description: |-
@@ -368,10 +362,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
notificationId:
@@ -408,10 +402,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
exchangeMessages:
@@ -429,21 +423,18 @@ components:
type: string
type: array
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
- notificationId
- eventTypes
- okMessages
@@ -455,3 +446,11 @@ components:
$ref: '#/components/schemas/NotificationConfigurationDetails'
required:
- configurationDetails
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http

85
yaml/NotificationConfigurationService-v4.yaml
View File

@@ -1,15 +1,15 @@
openapi: 3.0.0
openapi: 3.0.3
servers:
- url: 'https://cal-test.adyen.com/cal/services/Notification/v4'
info:
version: '4'
title: Adyen MarketPay Notification Configuration API
title: 'Adyen for Platforms: Notification Configuration API'
description: |-
The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.
The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.
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).
## Authentication
To connect to the MarketPay 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:
To connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:
```
curl
@@ -20,7 +20,7 @@ info:
Note 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).
## Versioning
MarketPay 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.
The Notification Configuration 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:
```
@@ -36,8 +36,9 @@ x-groups:
paths:
/createNotificationConfiguration:
post:
summary: Configure a new subscription to notifications.
description: 'This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
summary: Subscribe to notifications.
description: 'Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
requestBody:
@@ -56,6 +57,7 @@ paths:
post:
summary: Delete an existing notification subscription configuration.
description: 'This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.'
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
requestBody:
@@ -74,6 +76,7 @@ paths:
post:
summary: Retrieve an existing notification subscription configuration.
description: This endpoint is used to retrieve the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
requestBody:
@@ -92,6 +95,7 @@ paths:
post:
summary: Retrieve a list of existing notification subscription configurations.
description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
requestBody:
@@ -110,6 +114,7 @@ paths:
post:
summary: Test an existing notification configuration.
description: 'This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.'
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
requestBody:
@@ -128,6 +133,7 @@ paths:
post:
summary: Update an existing notification subscription configuration.
description: 'This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.'
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
requestBody:
@@ -171,21 +177,17 @@ components:
GenericResponse:
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.
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
GetNotificationConfigurationListResponse:
properties:
configurations:
@@ -194,21 +196,18 @@ components:
$ref: '#/components/schemas/NotificationConfigurationDetails'
type: array
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
- configurations
GetNotificationConfigurationRequest:
properties:
@@ -224,21 +223,18 @@ components:
description: Details of the notification subscription configuration.
$ref: '#/components/schemas/NotificationConfigurationDetails'
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
- configurationDetails
NotificationConfigurationDetails:
properties:
@@ -250,9 +246,7 @@ components:
format: int32
type: integer
description:
description: |-
A description of the notification subscription configuration.
>Required when creating a configuration, forbidden when updating a configuration.
description: A description of the notification subscription configuration.
type: string
eventConfigs:
description: The types of events whose notifications apply to this configuration.
@@ -327,10 +321,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
includeMode:
description: |-
@@ -368,10 +362,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
notificationId:
@@ -408,10 +402,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
exchangeMessages:
@@ -429,21 +423,18 @@ components:
type: string
type: array
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
- notificationId
- eventTypes
- okMessages
@@ -455,3 +446,11 @@ components:
$ref: '#/components/schemas/NotificationConfigurationDetails'
required:
- configurationDetails
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http

56
yaml/NotificationConfigurationService-v5.yaml
View File

@@ -1,15 +1,15 @@
openapi: 3.0.0
openapi: 3.0.3
servers:
- url: 'https://cal-test.adyen.com/cal/services/Notification/v5'
info:
version: '5'
title: Adyen MarketPay Notification Configuration API
title: 'Adyen for Platforms: Notification Configuration API'
description: |-
The MarketPay Notification Configuration API provides endpoints for configuration a subscription to a marketplace's MarketPay-related notifications. Notifications are sent upon the occurrence of certain events (such as a KYC check completion or a payout completion), and the subscription to these notifications dictates to where they are sent.
The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.
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).
## Authentication
To connect to the MarketPay 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:
To connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:
```
curl
@@ -20,7 +20,7 @@ info:
Note 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).
## Versioning
MarketPay 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.
The Notification Configuration 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:
```
@@ -36,8 +36,9 @@ x-groups:
paths:
/createNotificationConfiguration:
post:
summary: Configure a new subscription to notifications.
description: 'This endpoint is used to create a subscription to MarketPay event notifications. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
summary: Subscribe to notifications.
description: 'Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
requestBody:
@@ -56,6 +57,7 @@ paths:
post:
summary: Delete an existing notification subscription configuration.
description: 'This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.'
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
requestBody:
@@ -74,6 +76,7 @@ paths:
post:
summary: Retrieve an existing notification subscription configuration.
description: This endpoint is used to retrieve the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
requestBody:
@@ -92,6 +95,7 @@ paths:
post:
summary: Retrieve a list of existing notification subscription configurations.
description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
requestBody:
@@ -110,6 +114,7 @@ paths:
post:
summary: Test an existing notification configuration.
description: 'This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.'
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
requestBody:
@@ -128,6 +133,7 @@ paths:
post:
summary: Update an existing notification subscription configuration.
description: 'This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.'
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
requestBody:
@@ -278,6 +284,9 @@ components:
- sourceAccountCode
- stateOrProvince
- status
- stockExchange
- stockNumber
- stockTicker
- store
- storeDetail
- storeName
@@ -304,13 +313,11 @@ components:
$ref: '#/components/schemas/ErrorFieldType'
type: array
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
required:
- pspReference
GetNotificationConfigurationListResponse:
properties:
configurations:
@@ -324,13 +331,12 @@ components:
$ref: '#/components/schemas/ErrorFieldType'
type: array
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
required:
- pspReference
- configurations
GetNotificationConfigurationRequest:
properties:
@@ -351,13 +357,12 @@ components:
$ref: '#/components/schemas/ErrorFieldType'
type: array
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
required:
- pspReference
- configurationDetails
NotificationConfigurationDetails:
properties:
@@ -369,9 +374,7 @@ components:
format: int32
type: integer
description:
description: |-
A description of the notification subscription configuration.
>Required when creating a configuration, forbidden when updating a configuration.
description: A description of the notification subscription configuration.
type: string
eventConfigs:
description: The types of events whose notifications apply to this configuration.
@@ -439,10 +442,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
includeMode:
description: |-
@@ -480,10 +483,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
notificationId:
@@ -520,10 +523,10 @@ components:
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
- TRANSFER_FUNDS_REFUND
type: string
type: array
exchangeMessages:
@@ -546,13 +549,12 @@ components:
type: string
type: array
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
required:
- pspReference
- notificationId
- eventTypes
- okMessages
@@ -564,3 +566,11 @@ components:
$ref: '#/components/schemas/NotificationConfigurationDetails'
required:
- configurationDetails
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http

576
yaml/NotificationConfigurationService-v6.yaml Normal file
View File

@@ -0,0 +1,576 @@
openapi: 3.0.3
servers:
- url: 'https://cal-test.adyen.com/cal/services/Notification/v6'
info:
version: '6'
title: 'Adyen for Platforms: Notification Configuration API'
description: |-
The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.
For more information, refer to our [documentation](https://docs.adyen.com/marketpay/marketpay-notifications).
## Authentication
To connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:
```
curl
-U "ws@MarketPlace.YourMarketPlace":"YourWsPassword" \
-H "Content-Type: application/json" \
...
```
Note 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).
## Versioning
The Notification Configuration 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/Notification/v6/createNotificationConfiguration
```
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
contact:
name: Adyen Support
url: 'https://support.adyen.com/'
email: support@adyen.com
x-groups:
- General
paths:
/createNotificationConfiguration:
post:
summary: Subscribe to notifications.
description: 'Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.'
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotificationConfigurationResponse'
description: OK - the request has succeeded.
/deleteNotificationConfigurations:
post:
summary: Delete an existing notification subscription configuration.
description: 'This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.'
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GenericResponse'
description: OK - the request has succeeded.
/getNotificationConfiguration:
post:
summary: Retrieve an existing notification subscription configuration.
description: This endpoint is used to retrieve the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotificationConfigurationResponse'
description: OK - the request has succeeded.
/getNotificationConfigurationList:
post:
summary: Retrieve a list of existing notification subscription configurations.
description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotificationConfigurationListResponse'
description: OK - the request has succeeded.
/testNotificationConfiguration:
post:
summary: Test an existing notification configuration.
description: 'This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.'
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TestNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TestNotificationConfigurationResponse'
description: OK - the request has succeeded.
/updateNotificationConfiguration:
post:
summary: Update an existing notification subscription configuration.
description: 'This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.'
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotificationConfigurationResponse'
description: OK - the request has succeeded.
components:
schemas:
CreateNotificationConfigurationRequest:
properties:
configurationDetails:
description: Details of the prospective notification subscription configuration.
$ref: '#/components/schemas/NotificationConfigurationDetails'
required:
- configurationDetails
DeleteNotificationConfigurationRequest:
properties:
notificationIds:
description: A list of IDs of the notification subscription configurations to be deleted.
items:
format: int64
type: integer
type: array
required:
- notificationIds
EmptyRequest: {}
ErrorFieldType:
properties:
errorCode:
description: The validation error code.
format: int32
type: integer
errorDescription:
description: A description of the validation error.
type: string
fieldType:
description: The type of error field.
$ref: '#/components/schemas/FieldType'
ExchangeMessage:
properties:
messageCode:
type: string
messageDescription:
type: string
FieldType:
properties:
field:
description: The full name of the property.
type: string
fieldName:
description: The type of the field.
enum:
- accountCode
- accountHolderCode
- accountHolderDetails
- accountNumber
- accountStateType
- accountStatus
- accountType
- address
- bankAccount
- bankAccountCode
- bankAccountName
- bankAccountUUID
- bankBicSwift
- bankCity
- bankCode
- bankName
- bankStatement
- branchCode
- businessContact
- cardToken
- checkCode
- city
- companyRegistration
- country
- countryCode
- currency
- currencyCode
- dateOfBirth
- description
- destinationAccountCode
- document
- documentExpirationDate
- documentIssuerCountry
- documentIssuerState
- documentName
- documentNumber
- documentType
- doingBusinessAs
- drivingLicence
- drivingLicenceBack
- drivingLicense
- email
- firstName
- fullPhoneNumber
- gender
- hopWebserviceUser
- houseNumberOrName
- iban
- idCard
- idCardBack
- idCardFront
- idNumber
- identityDocument
- individualDetails
- lastName
- legalBusinessName
- legalEntity
- legalEntityType
- merchantAccount
- merchantCategoryCode
- merchantReference
- microDeposit
- name
- nationality
- originalReference
- ownerCity
- ownerCountryCode
- ownerHouseNumberOrName
- ownerName
- ownerPostalCode
- ownerState
- ownerStreet
- passport
- passportNumber
- payoutMethodCode
- personalData
- phoneCountryCode
- phoneNumber
- postalCode
- primaryCurrency
- reason
- registrationNumber
- returnUrl
- schedule
- shareholder
- shareholderCode
- socialSecurityNumber
- sourceAccountCode
- stateOrProvince
- status
- stockExchange
- stockNumber
- stockTicker
- store
- storeDetail
- storeName
- storeReference
- street
- taxId
- tier
- tierNumber
- transferCode
- unknown
- value
- virtualAccount
- visaNumber
- webAddress
type: string
shareholderCode:
description: 'The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.'
type: string
GenericResponse:
properties:
invalidFields:
description: Contains field validation errors that would prevent requests from being processed.
items:
$ref: '#/components/schemas/ErrorFieldType'
type: array
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
type: string
GetNotificationConfigurationListResponse:
properties:
configurations:
description: Details of the notification subscription configurations.
items:
$ref: '#/components/schemas/NotificationConfigurationDetails'
type: array
invalidFields:
description: Contains field validation errors that would prevent requests from being processed.
items:
$ref: '#/components/schemas/ErrorFieldType'
type: array
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
type: string
required:
- configurations
GetNotificationConfigurationRequest:
properties:
notificationId:
description: The ID of the notification subscription configuration whose details are to be retrieved.
format: int64
type: integer
required:
- notificationId
GetNotificationConfigurationResponse:
properties:
configurationDetails:
description: Details of the notification subscription configuration.
$ref: '#/components/schemas/NotificationConfigurationDetails'
invalidFields:
description: Contains field validation errors that would prevent requests from being processed.
items:
$ref: '#/components/schemas/ErrorFieldType'
type: array
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
type: string
required:
- configurationDetails
NotificationConfigurationDetails:
properties:
active:
description: Indicates whether the notification subscription is active.
type: boolean
apiVersion:
description: The API version of the notification to send.
format: int32
type: integer
description:
description: A description of the notification subscription configuration.
type: string
eventConfigs:
description: The types of events whose notifications apply to this configuration.
items:
$ref: '#/components/schemas/NotificationEventConfiguration'
type: array
hmacSignatureKey:
description: |-
A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the notification header `Protocol`. A notification body along with its `hmacSignatureKey` and `Protocol` can be used to calculate a hash value; matching this hash value with the `HmacSignature` will ensure that the notification body has not been tampered with or corrupted.
>Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. "b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27").
The omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).
type: string
notificationId:
description: |-
The ID of the configuration.
>Required if updating an existing configuration, ignored during the creation of a configuration.
format: int64
type: integer
notifyPassword:
description: The password to use when accessing the notifyURL with the specified username.
type: string
notifyURL:
description: The URL to which the notifications are to be sent.
type: string
notifyUsername:
description: The username to use when accessing the notifyURL.
type: string
sslProtocol:
description: |-
The SSL protocol employed by the endpoint.
>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.
enum:
- SSL
- SSLInsecureCiphers
- TLS
- TLSv10
- TLSv10InsecureCiphers
- TLSv11
- TLSv12
type: string
required:
- eventConfigs
- notifyURL
NotificationEventConfiguration:
properties:
eventType:
description: |-
The type of event triggering the notification.
>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.
enum:
- ACCOUNT_CLOSED
- ACCOUNT_CREATED
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
- ACCOUNT_HOLDER_UPCOMING_DEADLINE
- ACCOUNT_HOLDER_UPDATED
- ACCOUNT_HOLDER_VERIFICATION
- ACCOUNT_UPDATED
- BENEFICIARY_SETUP
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
type: string
includeMode:
description: |-
Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent.
>Permitted values: `INCLUDE`, `EXCLUDE`.
>- `INCLUDE`: send the specified eventType.
>- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).
enum:
- EXCLUDE
- INCLUDE
type: string
required:
- eventType
- includeMode
TestNotificationConfigurationRequest:
properties:
eventTypes:
description: |-
The event types to test. If left blank, then all of the configured event types will be tested.
>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.
items:
enum:
- ACCOUNT_CLOSED
- ACCOUNT_CREATED
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
- ACCOUNT_HOLDER_UPCOMING_DEADLINE
- ACCOUNT_HOLDER_UPDATED
- ACCOUNT_HOLDER_VERIFICATION
- ACCOUNT_UPDATED
- BENEFICIARY_SETUP
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
type: string
type: array
notificationId:
description: The ID of the notification subscription configuration to be tested.
format: int64
type: integer
required:
- notificationId
TestNotificationConfigurationResponse:
properties:
errorMessages:
description: Any error messages encountered.
items:
type: string
type: array
eventTypes:
description: |-
The event types that were tested.
>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.
items:
enum:
- ACCOUNT_CLOSED
- ACCOUNT_CREATED
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
- ACCOUNT_HOLDER_UPCOMING_DEADLINE
- ACCOUNT_HOLDER_UPDATED
- ACCOUNT_HOLDER_VERIFICATION
- ACCOUNT_UPDATED
- BENEFICIARY_SETUP
- COMPENSATE_NEGATIVE_BALANCE
- DIRECT_DEBIT_INITIATED
- PAYMENT_FAILURE
- REFUND_FUNDS_TRANSFER
- REPORT_AVAILABLE
- SCHEDULED_REFUNDS
- TRANSFER_FUNDS
type: string
type: array
exchangeMessages:
description: The notification message and related response messages.
items:
$ref: '#/components/schemas/ExchangeMessage'
type: array
invalidFields:
description: Contains field validation errors that would prevent requests from being processed.
items:
$ref: '#/components/schemas/ErrorFieldType'
type: array
notificationId:
description: The ID of the notification subscription configuration.
format: int64
type: integer
okMessages:
description: A list of messages describing the testing steps.
items:
type: string
type: array
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
type: string
required:
- notificationId
- eventTypes
- okMessages
- exchangeMessages
UpdateNotificationConfigurationRequest:
properties:
configurationDetails:
description: Details of the notification subscription configuration to be updated.
$ref: '#/components/schemas/NotificationConfigurationDetails'
required:
- configurationDetails
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http