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

spec release

Browse Source
This commit is contained in:
Adyen Automation
2023-04-19 10:19:30 +00:00
parent 279c4e893a
commit 8cf5d065c4
16 changed files with 944 additions and 496 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
json/PayoutService-v30.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Payout API",
"description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payout/v30/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v30/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2022-12-13T09:27:04Z",
"x-timestamp" : "2023-04-11T21:25:15Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -46,7 +46,7 @@
"operationId" : "post-confirmThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 1,
"x-methodName" : "confirmPayout",
"x-methodName" : "confirmThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -156,7 +156,7 @@
"operationId" : "post-declineThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 2,
"x-methodName" : "cancelPayout",
"x-methodName" : "declineThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -266,7 +266,7 @@
"operationId" : "post-payout",
"x-groupName" : "Instant payouts",
"x-sortIndex" : 1,
"x-methodName" : "makeInstantCardPayout",
"x-methodName" : "payout",
"security" : [
{
"BasicAuth" : [
@@ -373,7 +373,7 @@
"operationId" : "post-storeDetail",
"x-groupName" : "Initialization",
"x-sortIndex" : 2,
"x-methodName" : "storePayoutDetails",
"x-methodName" : "storeDetail",
"security" : [
{
"BasicAuth" : [
@@ -483,7 +483,7 @@
"operationId" : "post-storeDetailAndSubmitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 1,
"x-methodName" : "storeDetailsAndSubmitPayout",
"x-methodName" : "storeDetailAndSubmitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -600,7 +600,7 @@
"operationId" : "post-submitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 3,
"x-methodName" : "submitPayout",
"x-methodName" : "submitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -733,7 +733,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -752,7 +753,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -794,7 +796,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -847,12 +850,7 @@
"type" : "string"
}
},
"required" : [
"number",
"expiryMonth",
"expiryYear",
"holderName"
]
"type" : "object"
},
"FraudCheckResult" : {
"properties" : {
@@ -875,7 +873,15 @@
"checkId",
"name",
"accountScore"
]
],
"type" : "object"
},
"FraudCheckResultWrapper" : {
"properties" : {
"FraudCheckResult" : {
"$ref" : "#/components/schemas/FraudCheckResult"
}
}
},
"FraudResult" : {
"properties" : {
@@ -887,14 +893,15 @@
"results" : {
"description" : "The result of the individual risk checks.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
"$ref" : "#/components/schemas/FraudCheckResultWrapper"
},
"type" : "array"
}
},
"required" : [
"accountScore"
]
],
"type" : "object"
},
"FundSource" : {
"properties" : {
@@ -925,7 +932,8 @@
"description" : "Phone number of the person",
"type" : "string"
}
}
},
"type" : "object"
},
"ModifyRequest" : {
"properties" : {
@@ -948,7 +956,8 @@
"required" : [
"merchantAccount",
"originalReference"
]
],
"type" : "object"
},
"ModifyResponse" : {
"properties" : {
@@ -971,7 +980,8 @@
"required" : [
"pspReference",
"response"
]
],
"type" : "object"
},
"Name" : {
"properties" : {
@@ -987,7 +997,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"PayoutRequest" : {
"properties" : {
@@ -1063,7 +1074,8 @@
"merchantAccount",
"reference",
"amount"
]
],
"type" : "object"
},
"PayoutResponse" : {
"properties" : {
@@ -1156,7 +1168,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1182,7 +1195,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalData3DSecure" : {
"properties" : {
@@ -1206,7 +1220,8 @@
"description" : "Indicates whether a card is enrolled for 3D Secure 2.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataBillingAddress" : {
"properties" : {
@@ -1234,7 +1249,8 @@
"description" : "The billing address street passed in the payment request.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCard" : {
"properties" : {
@@ -1270,7 +1286,8 @@
"description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCommon" : {
"properties" : {
@@ -1512,7 +1529,8 @@
"description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataInstallments" : {
"properties" : {
@@ -1564,7 +1582,8 @@
"description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataNetworkTokens" : {
"properties" : {
@@ -1580,7 +1599,8 @@
"description" : "The last four digits of a network token.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataOpi" : {
"properties" : {
@@ -1588,7 +1608,8 @@
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataSepa" : {
"properties" : {
@@ -1604,7 +1625,8 @@
"description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF",
"type" : "string"
}
}
},
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1629,7 +1651,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"StoreDetailAndSubmitRequest" : {
"properties" : {
@@ -1660,7 +1683,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1734,7 +1757,8 @@
"entityType",
"reference",
"amount"
]
],
"type" : "object"
},
"StoreDetailAndSubmitResponse" : {
"properties" : {
@@ -1761,7 +1785,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
},
"StoreDetailRequest" : {
"properties" : {
@@ -1788,7 +1813,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1851,7 +1876,8 @@
"dateOfBirth",
"nationality",
"entityType"
]
],
"type" : "object"
},
"StoreDetailResponse" : {
"properties" : {
@@ -1879,7 +1905,8 @@
"pspReference",
"recurringDetailReference",
"resultCode"
]
],
"type" : "object"
},
"SubmitRequest" : {
"properties" : {
@@ -1897,7 +1924,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1967,7 +1994,8 @@
"shopperReference",
"recurring",
"selectedRecurringDetailReference"
]
],
"type" : "object"
},
"SubmitResponse" : {
"properties" : {
@@ -1994,7 +2022,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -2187,7 +2216,7 @@
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"recurring" : {
"contract" : "RECURRING,PAYOUT"
"contract" : "PAYOUT"
},
"amount" : {
"value" : 2000,

119
json/PayoutService-v40.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Payout API",
"description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payout/v40/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v40/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2022-12-13T09:27:04Z",
"x-timestamp" : "2023-04-11T21:25:15Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -46,7 +46,7 @@
"operationId" : "post-confirmThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 1,
"x-methodName" : "confirmPayout",
"x-methodName" : "confirmThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -156,7 +156,7 @@
"operationId" : "post-declineThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 2,
"x-methodName" : "cancelPayout",
"x-methodName" : "declineThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -266,7 +266,7 @@
"operationId" : "post-payout",
"x-groupName" : "Instant payouts",
"x-sortIndex" : 1,
"x-methodName" : "makeInstantCardPayout",
"x-methodName" : "payout",
"security" : [
{
"BasicAuth" : [
@@ -373,7 +373,7 @@
"operationId" : "post-storeDetail",
"x-groupName" : "Initialization",
"x-sortIndex" : 2,
"x-methodName" : "storePayoutDetails",
"x-methodName" : "storeDetail",
"security" : [
{
"BasicAuth" : [
@@ -483,7 +483,7 @@
"operationId" : "post-storeDetailAndSubmitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 1,
"x-methodName" : "storeDetailsAndSubmitPayout",
"x-methodName" : "storeDetailAndSubmitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -600,7 +600,7 @@
"operationId" : "post-submitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 3,
"x-methodName" : "submitPayout",
"x-methodName" : "submitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -733,7 +733,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -752,7 +753,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -794,7 +796,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -847,12 +850,7 @@
"type" : "string"
}
},
"required" : [
"number",
"expiryMonth",
"expiryYear",
"holderName"
]
"type" : "object"
},
"FraudCheckResult" : {
"properties" : {
@@ -875,7 +873,15 @@
"checkId",
"name",
"accountScore"
]
],
"type" : "object"
},
"FraudCheckResultWrapper" : {
"properties" : {
"FraudCheckResult" : {
"$ref" : "#/components/schemas/FraudCheckResult"
}
}
},
"FraudResult" : {
"properties" : {
@@ -887,14 +893,15 @@
"results" : {
"description" : "The result of the individual risk checks.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
"$ref" : "#/components/schemas/FraudCheckResultWrapper"
},
"type" : "array"
}
},
"required" : [
"accountScore"
]
],
"type" : "object"
},
"FundSource" : {
"properties" : {
@@ -925,7 +932,8 @@
"description" : "Phone number of the person",
"type" : "string"
}
}
},
"type" : "object"
},
"ModifyRequest" : {
"properties" : {
@@ -948,7 +956,8 @@
"required" : [
"merchantAccount",
"originalReference"
]
],
"type" : "object"
},
"ModifyResponse" : {
"properties" : {
@@ -971,7 +980,8 @@
"required" : [
"pspReference",
"response"
]
],
"type" : "object"
},
"Name" : {
"properties" : {
@@ -987,7 +997,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"PayoutRequest" : {
"properties" : {
@@ -1063,7 +1074,8 @@
"merchantAccount",
"reference",
"amount"
]
],
"type" : "object"
},
"PayoutResponse" : {
"properties" : {
@@ -1156,7 +1168,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1193,7 +1206,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalData3DSecure" : {
"properties" : {
@@ -1217,7 +1231,8 @@
"description" : "Indicates whether a card is enrolled for 3D Secure 2.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataBillingAddress" : {
"properties" : {
@@ -1245,7 +1260,8 @@
"description" : "The billing address street passed in the payment request.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCard" : {
"properties" : {
@@ -1281,7 +1297,8 @@
"description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCommon" : {
"properties" : {
@@ -1543,7 +1560,8 @@
"description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataInstallments" : {
"properties" : {
@@ -1595,7 +1613,8 @@
"description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataNetworkTokens" : {
"properties" : {
@@ -1611,7 +1630,8 @@
"description" : "The last four digits of a network token.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataOpi" : {
"properties" : {
@@ -1619,7 +1639,8 @@
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataSepa" : {
"properties" : {
@@ -1635,7 +1656,8 @@
"description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF",
"type" : "string"
}
}
},
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1660,7 +1682,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"StoreDetailAndSubmitRequest" : {
"properties" : {
@@ -1691,7 +1714,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1765,7 +1788,8 @@
"entityType",
"reference",
"amount"
]
],
"type" : "object"
},
"StoreDetailAndSubmitResponse" : {
"properties" : {
@@ -1792,7 +1816,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
},
"StoreDetailRequest" : {
"properties" : {
@@ -1819,7 +1844,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1882,7 +1907,8 @@
"dateOfBirth",
"nationality",
"entityType"
]
],
"type" : "object"
},
"StoreDetailResponse" : {
"properties" : {
@@ -1910,7 +1936,8 @@
"pspReference",
"recurringDetailReference",
"resultCode"
]
],
"type" : "object"
},
"SubmitRequest" : {
"properties" : {
@@ -1928,7 +1955,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1998,7 +2025,8 @@
"shopperReference",
"recurring",
"selectedRecurringDetailReference"
]
],
"type" : "object"
},
"SubmitResponse" : {
"properties" : {
@@ -2025,7 +2053,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -2218,7 +2247,7 @@
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"recurring" : {
"contract" : "RECURRING,PAYOUT"
"contract" : "PAYOUT"
},
"amount" : {
"value" : 2000,

119
json/PayoutService-v50.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Payout API",
"description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payout/v50/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v50/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2022-12-13T09:27:04Z",
"x-timestamp" : "2023-04-11T21:25:14Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -46,7 +46,7 @@
"operationId" : "post-confirmThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 1,
"x-methodName" : "confirmPayout",
"x-methodName" : "confirmThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -156,7 +156,7 @@
"operationId" : "post-declineThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 2,
"x-methodName" : "cancelPayout",
"x-methodName" : "declineThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -266,7 +266,7 @@
"operationId" : "post-payout",
"x-groupName" : "Instant payouts",
"x-sortIndex" : 1,
"x-methodName" : "makeInstantCardPayout",
"x-methodName" : "payout",
"security" : [
{
"BasicAuth" : [
@@ -373,7 +373,7 @@
"operationId" : "post-storeDetail",
"x-groupName" : "Initialization",
"x-sortIndex" : 2,
"x-methodName" : "storePayoutDetails",
"x-methodName" : "storeDetail",
"security" : [
{
"BasicAuth" : [
@@ -483,7 +483,7 @@
"operationId" : "post-storeDetailAndSubmitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 1,
"x-methodName" : "storeDetailsAndSubmitPayout",
"x-methodName" : "storeDetailAndSubmitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -600,7 +600,7 @@
"operationId" : "post-submitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 3,
"x-methodName" : "submitPayout",
"x-methodName" : "submitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -733,7 +733,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -752,7 +753,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -794,7 +796,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -847,12 +850,7 @@
"type" : "string"
}
},
"required" : [
"number",
"expiryMonth",
"expiryYear",
"holderName"
]
"type" : "object"
},
"FraudCheckResult" : {
"properties" : {
@@ -875,7 +873,15 @@
"checkId",
"name",
"accountScore"
]
],
"type" : "object"
},
"FraudCheckResultWrapper" : {
"properties" : {
"FraudCheckResult" : {
"$ref" : "#/components/schemas/FraudCheckResult"
}
}
},
"FraudResult" : {
"properties" : {
@@ -887,14 +893,15 @@
"results" : {
"description" : "The result of the individual risk checks.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
"$ref" : "#/components/schemas/FraudCheckResultWrapper"
},
"type" : "array"
}
},
"required" : [
"accountScore"
]
],
"type" : "object"
},
"FundSource" : {
"properties" : {
@@ -925,7 +932,8 @@
"description" : "Phone number of the person",
"type" : "string"
}
}
},
"type" : "object"
},
"ModifyRequest" : {
"properties" : {
@@ -948,7 +956,8 @@
"required" : [
"merchantAccount",
"originalReference"
]
],
"type" : "object"
},
"ModifyResponse" : {
"properties" : {
@@ -971,7 +980,8 @@
"required" : [
"pspReference",
"response"
]
],
"type" : "object"
},
"Name" : {
"properties" : {
@@ -987,7 +997,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"PayoutRequest" : {
"properties" : {
@@ -1063,7 +1074,8 @@
"merchantAccount",
"reference",
"amount"
]
],
"type" : "object"
},
"PayoutResponse" : {
"properties" : {
@@ -1156,7 +1168,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1193,7 +1206,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalData3DSecure" : {
"properties" : {
@@ -1217,7 +1231,8 @@
"description" : "Indicates whether a card is enrolled for 3D Secure 2.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataBillingAddress" : {
"properties" : {
@@ -1245,7 +1260,8 @@
"description" : "The billing address street passed in the payment request.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCard" : {
"properties" : {
@@ -1281,7 +1297,8 @@
"description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCommon" : {
"properties" : {
@@ -1543,7 +1560,8 @@
"description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataInstallments" : {
"properties" : {
@@ -1595,7 +1613,8 @@
"description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataNetworkTokens" : {
"properties" : {
@@ -1611,7 +1630,8 @@
"description" : "The last four digits of a network token.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataOpi" : {
"properties" : {
@@ -1619,7 +1639,8 @@
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataSepa" : {
"properties" : {
@@ -1635,7 +1656,8 @@
"description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF",
"type" : "string"
}
}
},
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1668,7 +1690,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"StoreDetailAndSubmitRequest" : {
"properties" : {
@@ -1699,7 +1722,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1773,7 +1796,8 @@
"entityType",
"reference",
"amount"
]
],
"type" : "object"
},
"StoreDetailAndSubmitResponse" : {
"properties" : {
@@ -1800,7 +1824,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
},
"StoreDetailRequest" : {
"properties" : {
@@ -1827,7 +1852,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1890,7 +1915,8 @@
"dateOfBirth",
"nationality",
"entityType"
]
],
"type" : "object"
},
"StoreDetailResponse" : {
"properties" : {
@@ -1918,7 +1944,8 @@
"pspReference",
"recurringDetailReference",
"resultCode"
]
],
"type" : "object"
},
"SubmitRequest" : {
"properties" : {
@@ -1936,7 +1963,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -2006,7 +2033,8 @@
"shopperReference",
"recurring",
"selectedRecurringDetailReference"
]
],
"type" : "object"
},
"SubmitResponse" : {
"properties" : {
@@ -2033,7 +2061,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -2226,7 +2255,7 @@
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"recurring" : {
"contract" : "RECURRING,PAYOUT"
"contract" : "PAYOUT"
},
"amount" : {
"value" : 2000,

119
json/PayoutService-v51.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Payout API",
"description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payout/v51/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v51/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2022-12-13T09:27:04Z",
"x-timestamp" : "2023-04-11T21:25:14Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -46,7 +46,7 @@
"operationId" : "post-confirmThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 1,
"x-methodName" : "confirmPayout",
"x-methodName" : "confirmThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -156,7 +156,7 @@
"operationId" : "post-declineThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 2,
"x-methodName" : "cancelPayout",
"x-methodName" : "declineThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -266,7 +266,7 @@
"operationId" : "post-payout",
"x-groupName" : "Instant payouts",
"x-sortIndex" : 1,
"x-methodName" : "makeInstantCardPayout",
"x-methodName" : "payout",
"security" : [
{
"BasicAuth" : [
@@ -373,7 +373,7 @@
"operationId" : "post-storeDetail",
"x-groupName" : "Initialization",
"x-sortIndex" : 2,
"x-methodName" : "storePayoutDetails",
"x-methodName" : "storeDetail",
"security" : [
{
"BasicAuth" : [
@@ -483,7 +483,7 @@
"operationId" : "post-storeDetailAndSubmitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 1,
"x-methodName" : "storeDetailsAndSubmitPayout",
"x-methodName" : "storeDetailAndSubmitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -600,7 +600,7 @@
"operationId" : "post-submitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 3,
"x-methodName" : "submitPayout",
"x-methodName" : "submitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -733,7 +733,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -752,7 +753,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -794,7 +796,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -847,12 +850,7 @@
"type" : "string"
}
},
"required" : [
"number",
"expiryMonth",
"expiryYear",
"holderName"
]
"type" : "object"
},
"FraudCheckResult" : {
"properties" : {
@@ -875,7 +873,15 @@
"checkId",
"name",
"accountScore"
]
],
"type" : "object"
},
"FraudCheckResultWrapper" : {
"properties" : {
"FraudCheckResult" : {
"$ref" : "#/components/schemas/FraudCheckResult"
}
}
},
"FraudResult" : {
"properties" : {
@@ -887,14 +893,15 @@
"results" : {
"description" : "The result of the individual risk checks.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
"$ref" : "#/components/schemas/FraudCheckResultWrapper"
},
"type" : "array"
}
},
"required" : [
"accountScore"
]
],
"type" : "object"
},
"FundSource" : {
"properties" : {
@@ -925,7 +932,8 @@
"description" : "Phone number of the person",
"type" : "string"
}
}
},
"type" : "object"
},
"ModifyRequest" : {
"properties" : {
@@ -948,7 +956,8 @@
"required" : [
"merchantAccount",
"originalReference"
]
],
"type" : "object"
},
"ModifyResponse" : {
"properties" : {
@@ -971,7 +980,8 @@
"required" : [
"pspReference",
"response"
]
],
"type" : "object"
},
"Name" : {
"properties" : {
@@ -987,7 +997,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"PayoutRequest" : {
"properties" : {
@@ -1063,7 +1074,8 @@
"merchantAccount",
"reference",
"amount"
]
],
"type" : "object"
},
"PayoutResponse" : {
"properties" : {
@@ -1156,7 +1168,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1193,7 +1206,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalData3DSecure" : {
"properties" : {
@@ -1217,7 +1231,8 @@
"description" : "Indicates whether a card is enrolled for 3D Secure 2.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataBillingAddress" : {
"properties" : {
@@ -1245,7 +1260,8 @@
"description" : "The billing address street passed in the payment request.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCard" : {
"properties" : {
@@ -1281,7 +1297,8 @@
"description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCommon" : {
"properties" : {
@@ -1543,7 +1560,8 @@
"description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataInstallments" : {
"properties" : {
@@ -1595,7 +1613,8 @@
"description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataNetworkTokens" : {
"properties" : {
@@ -1611,7 +1630,8 @@
"description" : "The last four digits of a network token.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataOpi" : {
"properties" : {
@@ -1619,7 +1639,8 @@
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataSepa" : {
"properties" : {
@@ -1635,7 +1656,8 @@
"description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF",
"type" : "string"
}
}
},
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1668,7 +1690,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"StoreDetailAndSubmitRequest" : {
"properties" : {
@@ -1699,7 +1722,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1773,7 +1796,8 @@
"entityType",
"reference",
"amount"
]
],
"type" : "object"
},
"StoreDetailAndSubmitResponse" : {
"properties" : {
@@ -1800,7 +1824,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
},
"StoreDetailRequest" : {
"properties" : {
@@ -1827,7 +1852,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1890,7 +1915,8 @@
"dateOfBirth",
"nationality",
"entityType"
]
],
"type" : "object"
},
"StoreDetailResponse" : {
"properties" : {
@@ -1918,7 +1944,8 @@
"pspReference",
"recurringDetailReference",
"resultCode"
]
],
"type" : "object"
},
"SubmitRequest" : {
"properties" : {
@@ -1936,7 +1963,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -2006,7 +2033,8 @@
"shopperReference",
"recurring",
"selectedRecurringDetailReference"
]
],
"type" : "object"
},
"SubmitResponse" : {
"properties" : {
@@ -2033,7 +2061,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -2226,7 +2255,7 @@
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"recurring" : {
"contract" : "RECURRING,PAYOUT"
"contract" : "PAYOUT"
},
"amount" : {
"value" : 2000,

119
json/PayoutService-v52.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Payout API",
"description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payout/v52/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v52/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2022-12-13T09:27:04Z",
"x-timestamp" : "2023-04-11T21:25:15Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -46,7 +46,7 @@
"operationId" : "post-confirmThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 1,
"x-methodName" : "confirmPayout",
"x-methodName" : "confirmThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -156,7 +156,7 @@
"operationId" : "post-declineThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 2,
"x-methodName" : "cancelPayout",
"x-methodName" : "declineThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -266,7 +266,7 @@
"operationId" : "post-payout",
"x-groupName" : "Instant payouts",
"x-sortIndex" : 1,
"x-methodName" : "makeInstantCardPayout",
"x-methodName" : "payout",
"security" : [
{
"BasicAuth" : [
@@ -373,7 +373,7 @@
"operationId" : "post-storeDetail",
"x-groupName" : "Initialization",
"x-sortIndex" : 2,
"x-methodName" : "storePayoutDetails",
"x-methodName" : "storeDetail",
"security" : [
{
"BasicAuth" : [
@@ -483,7 +483,7 @@
"operationId" : "post-storeDetailAndSubmitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 1,
"x-methodName" : "storeDetailsAndSubmitPayout",
"x-methodName" : "storeDetailAndSubmitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -600,7 +600,7 @@
"operationId" : "post-submitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 3,
"x-methodName" : "submitPayout",
"x-methodName" : "submitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -733,7 +733,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -752,7 +753,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -794,7 +796,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -847,12 +850,7 @@
"type" : "string"
}
},
"required" : [
"number",
"expiryMonth",
"expiryYear",
"holderName"
]
"type" : "object"
},
"FraudCheckResult" : {
"properties" : {
@@ -875,7 +873,15 @@
"checkId",
"name",
"accountScore"
]
],
"type" : "object"
},
"FraudCheckResultWrapper" : {
"properties" : {
"FraudCheckResult" : {
"$ref" : "#/components/schemas/FraudCheckResult"
}
}
},
"FraudResult" : {
"properties" : {
@@ -887,14 +893,15 @@
"results" : {
"description" : "The result of the individual risk checks.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
"$ref" : "#/components/schemas/FraudCheckResultWrapper"
},
"type" : "array"
}
},
"required" : [
"accountScore"
]
],
"type" : "object"
},
"FundSource" : {
"properties" : {
@@ -925,7 +932,8 @@
"description" : "Phone number of the person",
"type" : "string"
}
}
},
"type" : "object"
},
"ModifyRequest" : {
"properties" : {
@@ -948,7 +956,8 @@
"required" : [
"merchantAccount",
"originalReference"
]
],
"type" : "object"
},
"ModifyResponse" : {
"properties" : {
@@ -971,7 +980,8 @@
"required" : [
"pspReference",
"response"
]
],
"type" : "object"
},
"Name" : {
"properties" : {
@@ -987,7 +997,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"PayoutRequest" : {
"properties" : {
@@ -1063,7 +1074,8 @@
"merchantAccount",
"reference",
"amount"
]
],
"type" : "object"
},
"PayoutResponse" : {
"properties" : {
@@ -1156,7 +1168,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1193,7 +1206,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalData3DSecure" : {
"properties" : {
@@ -1217,7 +1231,8 @@
"description" : "Indicates whether a card is enrolled for 3D Secure 2.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataBillingAddress" : {
"properties" : {
@@ -1245,7 +1260,8 @@
"description" : "The billing address street passed in the payment request.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCard" : {
"properties" : {
@@ -1281,7 +1297,8 @@
"description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCommon" : {
"properties" : {
@@ -1543,7 +1560,8 @@
"description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataInstallments" : {
"properties" : {
@@ -1595,7 +1613,8 @@
"description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataNetworkTokens" : {
"properties" : {
@@ -1611,7 +1630,8 @@
"description" : "The last four digits of a network token.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataOpi" : {
"properties" : {
@@ -1619,7 +1639,8 @@
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataSepa" : {
"properties" : {
@@ -1635,7 +1656,8 @@
"description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF",
"type" : "string"
}
}
},
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1668,7 +1690,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"StoreDetailAndSubmitRequest" : {
"properties" : {
@@ -1699,7 +1722,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1778,7 +1801,8 @@
"entityType",
"reference",
"amount"
]
],
"type" : "object"
},
"StoreDetailAndSubmitResponse" : {
"properties" : {
@@ -1805,7 +1829,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
},
"StoreDetailRequest" : {
"properties" : {
@@ -1832,7 +1857,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1900,7 +1925,8 @@
"dateOfBirth",
"nationality",
"entityType"
]
],
"type" : "object"
},
"StoreDetailResponse" : {
"properties" : {
@@ -1928,7 +1954,8 @@
"pspReference",
"recurringDetailReference",
"resultCode"
]
],
"type" : "object"
},
"SubmitRequest" : {
"properties" : {
@@ -1946,7 +1973,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -2016,7 +2043,8 @@
"shopperReference",
"recurring",
"selectedRecurringDetailReference"
]
],
"type" : "object"
},
"SubmitResponse" : {
"properties" : {
@@ -2043,7 +2071,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -2236,7 +2265,7 @@
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"recurring" : {
"contract" : "RECURRING,PAYOUT"
"contract" : "PAYOUT"
},
"amount" : {
"value" : 2000,

119
json/PayoutService-v64.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Payout API",
"description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payout/v64/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v64/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2022-12-13T09:27:04Z",
"x-timestamp" : "2023-04-11T21:25:14Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -46,7 +46,7 @@
"operationId" : "post-confirmThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 1,
"x-methodName" : "confirmPayout",
"x-methodName" : "confirmThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -156,7 +156,7 @@
"operationId" : "post-declineThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 2,
"x-methodName" : "cancelPayout",
"x-methodName" : "declineThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -266,7 +266,7 @@
"operationId" : "post-payout",
"x-groupName" : "Instant payouts",
"x-sortIndex" : 1,
"x-methodName" : "makeInstantCardPayout",
"x-methodName" : "payout",
"security" : [
{
"BasicAuth" : [
@@ -373,7 +373,7 @@
"operationId" : "post-storeDetail",
"x-groupName" : "Initialization",
"x-sortIndex" : 2,
"x-methodName" : "storePayoutDetails",
"x-methodName" : "storeDetail",
"security" : [
{
"BasicAuth" : [
@@ -483,7 +483,7 @@
"operationId" : "post-storeDetailAndSubmitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 1,
"x-methodName" : "storeDetailsAndSubmitPayout",
"x-methodName" : "storeDetailAndSubmitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -600,7 +600,7 @@
"operationId" : "post-submitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 3,
"x-methodName" : "submitPayout",
"x-methodName" : "submitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -733,7 +733,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -752,7 +753,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -794,7 +796,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -847,12 +850,7 @@
"type" : "string"
}
},
"required" : [
"number",
"expiryMonth",
"expiryYear",
"holderName"
]
"type" : "object"
},
"FraudCheckResult" : {
"properties" : {
@@ -875,7 +873,15 @@
"checkId",
"name",
"accountScore"
]
],
"type" : "object"
},
"FraudCheckResultWrapper" : {
"properties" : {
"FraudCheckResult" : {
"$ref" : "#/components/schemas/FraudCheckResult"
}
}
},
"FraudResult" : {
"properties" : {
@@ -887,14 +893,15 @@
"results" : {
"description" : "The result of the individual risk checks.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
"$ref" : "#/components/schemas/FraudCheckResultWrapper"
},
"type" : "array"
}
},
"required" : [
"accountScore"
]
],
"type" : "object"
},
"FundSource" : {
"properties" : {
@@ -925,7 +932,8 @@
"description" : "Phone number of the person",
"type" : "string"
}
}
},
"type" : "object"
},
"ModifyRequest" : {
"properties" : {
@@ -948,7 +956,8 @@
"required" : [
"merchantAccount",
"originalReference"
]
],
"type" : "object"
},
"ModifyResponse" : {
"properties" : {
@@ -971,7 +980,8 @@
"required" : [
"pspReference",
"response"
]
],
"type" : "object"
},
"Name" : {
"properties" : {
@@ -987,7 +997,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"PayoutRequest" : {
"properties" : {
@@ -1063,7 +1074,8 @@
"merchantAccount",
"reference",
"amount"
]
],
"type" : "object"
},
"PayoutResponse" : {
"properties" : {
@@ -1156,7 +1168,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1193,7 +1206,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalData3DSecure" : {
"properties" : {
@@ -1217,7 +1231,8 @@
"description" : "Indicates whether a card is enrolled for 3D Secure 2.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataBillingAddress" : {
"properties" : {
@@ -1245,7 +1260,8 @@
"description" : "The billing address street passed in the payment request.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCard" : {
"properties" : {
@@ -1281,7 +1297,8 @@
"description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCommon" : {
"properties" : {
@@ -1543,7 +1560,8 @@
"description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataInstallments" : {
"properties" : {
@@ -1595,7 +1613,8 @@
"description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataNetworkTokens" : {
"properties" : {
@@ -1611,7 +1630,8 @@
"description" : "The last four digits of a network token.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataOpi" : {
"properties" : {
@@ -1619,7 +1639,8 @@
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataSepa" : {
"properties" : {
@@ -1635,7 +1656,8 @@
"description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF",
"type" : "string"
}
}
},
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1668,7 +1690,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"StoreDetailAndSubmitRequest" : {
"properties" : {
@@ -1699,7 +1722,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1778,7 +1801,8 @@
"entityType",
"reference",
"amount"
]
],
"type" : "object"
},
"StoreDetailAndSubmitResponse" : {
"properties" : {
@@ -1805,7 +1829,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
},
"StoreDetailRequest" : {
"properties" : {
@@ -1832,7 +1857,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1900,7 +1925,8 @@
"dateOfBirth",
"nationality",
"entityType"
]
],
"type" : "object"
},
"StoreDetailResponse" : {
"properties" : {
@@ -1928,7 +1954,8 @@
"pspReference",
"recurringDetailReference",
"resultCode"
]
],
"type" : "object"
},
"SubmitRequest" : {
"properties" : {
@@ -1946,7 +1973,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -2016,7 +2043,8 @@
"shopperReference",
"recurring",
"selectedRecurringDetailReference"
]
],
"type" : "object"
},
"SubmitResponse" : {
"properties" : {
@@ -2043,7 +2071,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -2236,7 +2265,7 @@
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"recurring" : {
"contract" : "RECURRING,PAYOUT"
"contract" : "PAYOUT"
},
"amount" : {
"value" : 2000,

119
json/PayoutService-v67.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Payout API",
"description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payout/v67/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v67/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2022-12-13T09:27:04Z",
"x-timestamp" : "2023-04-11T21:25:15Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -46,7 +46,7 @@
"operationId" : "post-confirmThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 1,
"x-methodName" : "confirmPayout",
"x-methodName" : "confirmThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -156,7 +156,7 @@
"operationId" : "post-declineThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 2,
"x-methodName" : "cancelPayout",
"x-methodName" : "declineThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -266,7 +266,7 @@
"operationId" : "post-payout",
"x-groupName" : "Instant payouts",
"x-sortIndex" : 1,
"x-methodName" : "makeInstantCardPayout",
"x-methodName" : "payout",
"security" : [
{
"BasicAuth" : [
@@ -373,7 +373,7 @@
"operationId" : "post-storeDetail",
"x-groupName" : "Initialization",
"x-sortIndex" : 2,
"x-methodName" : "storePayoutDetails",
"x-methodName" : "storeDetail",
"security" : [
{
"BasicAuth" : [
@@ -483,7 +483,7 @@
"operationId" : "post-storeDetailAndSubmitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 1,
"x-methodName" : "storeDetailsAndSubmitPayout",
"x-methodName" : "storeDetailAndSubmitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -600,7 +600,7 @@
"operationId" : "post-submitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 3,
"x-methodName" : "submitPayout",
"x-methodName" : "submitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -733,7 +733,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -752,7 +753,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -794,7 +796,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -847,12 +850,7 @@
"type" : "string"
}
},
"required" : [
"number",
"expiryMonth",
"expiryYear",
"holderName"
]
"type" : "object"
},
"FraudCheckResult" : {
"properties" : {
@@ -875,7 +873,15 @@
"checkId",
"name",
"accountScore"
]
],
"type" : "object"
},
"FraudCheckResultWrapper" : {
"properties" : {
"FraudCheckResult" : {
"$ref" : "#/components/schemas/FraudCheckResult"
}
}
},
"FraudResult" : {
"properties" : {
@@ -887,14 +893,15 @@
"results" : {
"description" : "The result of the individual risk checks.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
"$ref" : "#/components/schemas/FraudCheckResultWrapper"
},
"type" : "array"
}
},
"required" : [
"accountScore"
]
],
"type" : "object"
},
"FundSource" : {
"properties" : {
@@ -925,7 +932,8 @@
"description" : "Phone number of the person",
"type" : "string"
}
}
},
"type" : "object"
},
"ModifyRequest" : {
"properties" : {
@@ -948,7 +956,8 @@
"required" : [
"merchantAccount",
"originalReference"
]
],
"type" : "object"
},
"ModifyResponse" : {
"properties" : {
@@ -971,7 +980,8 @@
"required" : [
"pspReference",
"response"
]
],
"type" : "object"
},
"Name" : {
"properties" : {
@@ -987,7 +997,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"PayoutRequest" : {
"properties" : {
@@ -1063,7 +1074,8 @@
"merchantAccount",
"reference",
"amount"
]
],
"type" : "object"
},
"PayoutResponse" : {
"properties" : {
@@ -1156,7 +1168,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1193,7 +1206,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalData3DSecure" : {
"properties" : {
@@ -1217,7 +1231,8 @@
"description" : "Indicates whether a card is enrolled for 3D Secure 2.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataBillingAddress" : {
"properties" : {
@@ -1245,7 +1260,8 @@
"description" : "The billing address street passed in the payment request.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCard" : {
"properties" : {
@@ -1281,7 +1297,8 @@
"description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCommon" : {
"properties" : {
@@ -1535,7 +1552,8 @@
"description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataInstallments" : {
"properties" : {
@@ -1587,7 +1605,8 @@
"description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataNetworkTokens" : {
"properties" : {
@@ -1603,7 +1622,8 @@
"description" : "The last four digits of a network token.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataOpi" : {
"properties" : {
@@ -1611,7 +1631,8 @@
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataSepa" : {
"properties" : {
@@ -1627,7 +1648,8 @@
"description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF",
"type" : "string"
}
}
},
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1660,7 +1682,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"StoreDetailAndSubmitRequest" : {
"properties" : {
@@ -1691,7 +1714,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1770,7 +1793,8 @@
"entityType",
"reference",
"amount"
]
],
"type" : "object"
},
"StoreDetailAndSubmitResponse" : {
"properties" : {
@@ -1797,7 +1821,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
},
"StoreDetailRequest" : {
"properties" : {
@@ -1824,7 +1849,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1892,7 +1917,8 @@
"dateOfBirth",
"nationality",
"entityType"
]
],
"type" : "object"
},
"StoreDetailResponse" : {
"properties" : {
@@ -1920,7 +1946,8 @@
"pspReference",
"recurringDetailReference",
"resultCode"
]
],
"type" : "object"
},
"SubmitRequest" : {
"properties" : {
@@ -1938,7 +1965,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -2008,7 +2035,8 @@
"shopperReference",
"recurring",
"selectedRecurringDetailReference"
]
],
"type" : "object"
},
"SubmitResponse" : {
"properties" : {
@@ -2035,7 +2063,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -2228,7 +2257,7 @@
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"recurring" : {
"contract" : "RECURRING,PAYOUT"
"contract" : "PAYOUT"
},
"amount" : {
"value" : 2000,

119
json/PayoutService-v68.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Payout API",
"description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payout/v68/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v68/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2022-12-13T09:27:04Z",
"x-timestamp" : "2023-04-11T21:25:15Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -46,7 +46,7 @@
"operationId" : "post-confirmThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 1,
"x-methodName" : "confirmPayout",
"x-methodName" : "confirmThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -156,7 +156,7 @@
"operationId" : "post-declineThirdParty",
"x-groupName" : "Reviewing",
"x-sortIndex" : 2,
"x-methodName" : "cancelPayout",
"x-methodName" : "declineThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -266,7 +266,7 @@
"operationId" : "post-payout",
"x-groupName" : "Instant payouts",
"x-sortIndex" : 1,
"x-methodName" : "makeInstantCardPayout",
"x-methodName" : "payout",
"security" : [
{
"BasicAuth" : [
@@ -373,7 +373,7 @@
"operationId" : "post-storeDetail",
"x-groupName" : "Initialization",
"x-sortIndex" : 2,
"x-methodName" : "storePayoutDetails",
"x-methodName" : "storeDetail",
"security" : [
{
"BasicAuth" : [
@@ -483,7 +483,7 @@
"operationId" : "post-storeDetailAndSubmitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 1,
"x-methodName" : "storeDetailsAndSubmitPayout",
"x-methodName" : "storeDetailAndSubmitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -600,7 +600,7 @@
"operationId" : "post-submitThirdParty",
"x-groupName" : "Initialization",
"x-sortIndex" : 3,
"x-methodName" : "submitPayout",
"x-methodName" : "submitThirdParty",
"security" : [
{
"BasicAuth" : [
@@ -733,7 +733,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -752,7 +753,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -794,7 +796,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -847,12 +850,7 @@
"type" : "string"
}
},
"required" : [
"number",
"expiryMonth",
"expiryYear",
"holderName"
]
"type" : "object"
},
"FraudCheckResult" : {
"properties" : {
@@ -875,7 +873,15 @@
"checkId",
"name",
"accountScore"
]
],
"type" : "object"
},
"FraudCheckResultWrapper" : {
"properties" : {
"FraudCheckResult" : {
"$ref" : "#/components/schemas/FraudCheckResult"
}
}
},
"FraudResult" : {
"properties" : {
@@ -887,14 +893,15 @@
"results" : {
"description" : "The result of the individual risk checks.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
"$ref" : "#/components/schemas/FraudCheckResultWrapper"
},
"type" : "array"
}
},
"required" : [
"accountScore"
]
],
"type" : "object"
},
"FundSource" : {
"properties" : {
@@ -925,7 +932,8 @@
"description" : "Phone number of the person",
"type" : "string"
}
}
},
"type" : "object"
},
"ModifyRequest" : {
"properties" : {
@@ -948,7 +956,8 @@
"required" : [
"merchantAccount",
"originalReference"
]
],
"type" : "object"
},
"ModifyResponse" : {
"properties" : {
@@ -971,7 +980,8 @@
"required" : [
"pspReference",
"response"
]
],
"type" : "object"
},
"Name" : {
"properties" : {
@@ -987,7 +997,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"PayoutRequest" : {
"properties" : {
@@ -1063,7 +1074,8 @@
"merchantAccount",
"reference",
"amount"
]
],
"type" : "object"
},
"PayoutResponse" : {
"properties" : {
@@ -1156,7 +1168,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1193,7 +1206,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalData3DSecure" : {
"properties" : {
@@ -1217,7 +1231,8 @@
"description" : "Indicates whether a card is enrolled for 3D Secure 2.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataBillingAddress" : {
"properties" : {
@@ -1245,7 +1260,8 @@
"description" : "The billing address street passed in the payment request.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCard" : {
"properties" : {
@@ -1281,7 +1297,8 @@
"description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataCommon" : {
"properties" : {
@@ -1535,7 +1552,8 @@
"description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataInstallments" : {
"properties" : {
@@ -1587,7 +1605,8 @@
"description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataNetworkTokens" : {
"properties" : {
@@ -1603,7 +1622,8 @@
"description" : "The last four digits of a network token.",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataOpi" : {
"properties" : {
@@ -1611,7 +1631,8 @@
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"type" : "object"
},
"ResponseAdditionalDataSepa" : {
"properties" : {
@@ -1627,7 +1648,8 @@
"description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF",
"type" : "string"
}
}
},
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1660,7 +1682,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"StoreDetailAndSubmitRequest" : {
"properties" : {
@@ -1691,7 +1714,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1770,7 +1793,8 @@
"entityType",
"reference",
"amount"
]
],
"type" : "object"
},
"StoreDetailAndSubmitResponse" : {
"properties" : {
@@ -1797,7 +1821,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
},
"StoreDetailRequest" : {
"properties" : {
@@ -1824,7 +1849,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -1892,7 +1917,8 @@
"dateOfBirth",
"nationality",
"entityType"
]
],
"type" : "object"
},
"StoreDetailResponse" : {
"properties" : {
@@ -1920,7 +1946,8 @@
"pspReference",
"recurringDetailReference",
"resultCode"
]
],
"type" : "object"
},
"SubmitRequest" : {
"properties" : {
@@ -1938,7 +1965,7 @@
"dateOfBirth" : {
"x-addedInVersion" : "24",
"description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.",
"format" : "date-time",
"format" : "date",
"type" : "string"
},
"entityType" : {
@@ -2008,7 +2035,8 @@
"shopperReference",
"recurring",
"selectedRecurringDetailReference"
]
],
"type" : "object"
},
"SubmitResponse" : {
"properties" : {
@@ -2035,7 +2063,8 @@
"required" : [
"pspReference",
"resultCode"
]
],
"type" : "object"
}
},
"securitySchemes" : {
@@ -2228,7 +2257,7 @@
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"recurring" : {
"contract" : "RECURRING,PAYOUT"
"contract" : "PAYOUT"
},
"amount" : {
"value" : 2000,

61
yaml/PayoutService-v30.yaml
View File

@@ -72,7 +72,7 @@ info:
Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
URLs** > **Prefix**.'
x-timestamp: '2022-12-13T09:27:04Z'
x-timestamp: '2023-04-11T21:25:15Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -100,7 +100,7 @@ paths:
operationId: post-confirmThirdParty
x-groupName: Reviewing
x-sortIndex: 1
x-methodName: confirmPayout
x-methodName: confirmThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -168,7 +168,7 @@ paths:
operationId: post-declineThirdParty
x-groupName: Reviewing
x-sortIndex: 2
x-methodName: cancelPayout
x-methodName: declineThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -236,7 +236,7 @@ paths:
operationId: post-payout
x-groupName: Instant payouts
x-sortIndex: 1
x-methodName: makeInstantCardPayout
x-methodName: payout
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -301,7 +301,7 @@ paths:
operationId: post-storeDetail
x-groupName: Initialization
x-sortIndex: 2
x-methodName: storePayoutDetails
x-methodName: storeDetail
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -370,7 +370,7 @@ paths:
operationId: post-storeDetailAndSubmitThirdParty
x-groupName: Initialization
x-sortIndex: 1
x-methodName: storeDetailsAndSubmitPayout
x-methodName: storeDetailAndSubmitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -445,7 +445,7 @@ paths:
operationId: post-submitThirdParty
x-groupName: Initialization
x-sortIndex: 3
x-methodName: submitPayout
x-methodName: submitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -539,6 +539,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -553,6 +554,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -601,6 +603,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -664,11 +667,7 @@ components:
maxLength: 4
minLength: 4
type: string
required:
- number
- expiryMonth
- expiryYear
- holderName
type: object
FraudCheckResult:
properties:
accountScore:
@@ -686,6 +685,11 @@ components:
- checkId
- name
- accountScore
type: object
FraudCheckResultWrapper:
properties:
FraudCheckResult:
$ref: '#/components/schemas/FraudCheckResult'
FraudResult:
properties:
accountScore:
@@ -695,10 +699,11 @@ components:
results:
description: The result of the individual risk checks.
items:
$ref: '#/components/schemas/FraudCheckResult'
$ref: '#/components/schemas/FraudCheckResultWrapper'
type: array
required:
- accountScore
type: object
FundSource:
properties:
additionalData:
@@ -726,6 +731,7 @@ components:
telephoneNumber:
description: Phone number of the person
type: string
type: object
ModifyRequest:
properties:
additionalData:
@@ -744,6 +750,7 @@ components:
required:
- merchantAccount
- originalReference
type: object
ModifyResponse:
properties:
additionalData:
@@ -767,6 +774,7 @@ components:
required:
- pspReference
- response
type: object
Name:
properties:
firstName:
@@ -778,6 +786,7 @@ components:
required:
- firstName
- lastName
type: object
PayoutRequest:
properties:
amount:
@@ -888,6 +897,7 @@ components:
- merchantAccount
- reference
- amount
type: object
PayoutResponse:
properties:
additionalData:
@@ -1008,6 +1018,7 @@ components:
- Refused
- Success
type: string
type: object
Recurring:
properties:
contract:
@@ -1034,6 +1045,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
ResponseAdditionalData3DSecure:
properties:
cardHolderInfo:
@@ -1055,6 +1067,7 @@ components:
threeds2.cardEnrolled:
description: Indicates whether a card is enrolled for 3D Secure 2.
type: boolean
type: object
ResponseAdditionalDataBillingAddress:
properties:
billingAddress.city:
@@ -1086,6 +1099,7 @@ components:
billingAddress.street:
description: The billing address street passed in the payment request.
type: string
type: object
ResponseAdditionalDataCard:
properties:
cardBin:
@@ -1140,6 +1154,7 @@ components:
Example: 52123423'
type: string
type: object
ResponseAdditionalDataCommon:
properties:
acquirerAccountCode:
@@ -1568,6 +1583,7 @@ components:
Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
type: string
type: object
ResponseAdditionalDataInstallments:
properties:
installmentPaymentData.installmentType:
@@ -1619,6 +1635,7 @@ components:
> Only relevant for card payments in countries that support installments.'
type: string
type: object
ResponseAdditionalDataNetworkTokens:
properties:
networkToken.available:
@@ -1632,6 +1649,7 @@ components:
networkToken.tokenSummary:
description: The last four digits of a network token.
type: string
type: object
ResponseAdditionalDataOpi:
properties:
opi.transToken:
@@ -1641,6 +1659,7 @@ components:
tokenized ecommerce transactions. For more information and required settings,
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
type: string
type: object
ResponseAdditionalDataSepa:
properties:
sepadirectdebit.dateOfSignature:
@@ -1669,6 +1688,7 @@ components:
Example: OOFF'
type: string
type: object
ServiceError:
properties:
errorCode:
@@ -1687,6 +1707,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
StoreDetailAndSubmitRequest:
properties:
additionalData:
@@ -1727,7 +1748,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1805,6 +1826,7 @@ components:
- entityType
- reference
- amount
type: object
StoreDetailAndSubmitResponse:
properties:
additionalData:
@@ -1830,6 +1852,7 @@ components:
required:
- pspReference
- resultCode
type: object
StoreDetailRequest:
properties:
additionalData:
@@ -1866,7 +1889,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1931,6 +1954,7 @@ components:
- dateOfBirth
- nationality
- entityType
type: object
StoreDetailResponse:
properties:
additionalData:
@@ -1953,6 +1977,7 @@ components:
- pspReference
- recurringDetailReference
- resultCode
type: object
SubmitRequest:
properties:
additionalData:
@@ -1972,7 +1997,7 @@ components:
\ account.\n\n> This field is mandatory for natural persons. \n> This\
\ field is required to update the existing `dateOfBirth` that is associated\
\ with this recurring contract."
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -2066,6 +2091,7 @@ components:
- shopperReference
- recurring
- selectedRecurringDetailReference
type: object
SubmitResponse:
properties:
additionalData:
@@ -2090,6 +2116,7 @@ components:
required:
- pspReference
- resultCode
type: object
securitySchemes:
ApiKeyAuth:
in: header
@@ -2242,7 +2269,7 @@ components:
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING,PAYOUT
contract: PAYOUT
amount:
value: 2000
currency: EUR

61
yaml/PayoutService-v40.yaml
View File

@@ -72,7 +72,7 @@ info:
Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
URLs** > **Prefix**.'
x-timestamp: '2022-12-13T09:27:04Z'
x-timestamp: '2023-04-11T21:25:15Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -100,7 +100,7 @@ paths:
operationId: post-confirmThirdParty
x-groupName: Reviewing
x-sortIndex: 1
x-methodName: confirmPayout
x-methodName: confirmThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -168,7 +168,7 @@ paths:
operationId: post-declineThirdParty
x-groupName: Reviewing
x-sortIndex: 2
x-methodName: cancelPayout
x-methodName: declineThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -236,7 +236,7 @@ paths:
operationId: post-payout
x-groupName: Instant payouts
x-sortIndex: 1
x-methodName: makeInstantCardPayout
x-methodName: payout
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -301,7 +301,7 @@ paths:
operationId: post-storeDetail
x-groupName: Initialization
x-sortIndex: 2
x-methodName: storePayoutDetails
x-methodName: storeDetail
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -370,7 +370,7 @@ paths:
operationId: post-storeDetailAndSubmitThirdParty
x-groupName: Initialization
x-sortIndex: 1
x-methodName: storeDetailsAndSubmitPayout
x-methodName: storeDetailAndSubmitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -445,7 +445,7 @@ paths:
operationId: post-submitThirdParty
x-groupName: Initialization
x-sortIndex: 3
x-methodName: submitPayout
x-methodName: submitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -539,6 +539,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -553,6 +554,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -601,6 +603,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -664,11 +667,7 @@ components:
maxLength: 4
minLength: 4
type: string
required:
- number
- expiryMonth
- expiryYear
- holderName
type: object
FraudCheckResult:
properties:
accountScore:
@@ -686,6 +685,11 @@ components:
- checkId
- name
- accountScore
type: object
FraudCheckResultWrapper:
properties:
FraudCheckResult:
$ref: '#/components/schemas/FraudCheckResult'
FraudResult:
properties:
accountScore:
@@ -695,10 +699,11 @@ components:
results:
description: The result of the individual risk checks.
items:
$ref: '#/components/schemas/FraudCheckResult'
$ref: '#/components/schemas/FraudCheckResultWrapper'
type: array
required:
- accountScore
type: object
FundSource:
properties:
additionalData:
@@ -726,6 +731,7 @@ components:
telephoneNumber:
description: Phone number of the person
type: string
type: object
ModifyRequest:
properties:
additionalData:
@@ -744,6 +750,7 @@ components:
required:
- merchantAccount
- originalReference
type: object
ModifyResponse:
properties:
additionalData:
@@ -767,6 +774,7 @@ components:
required:
- pspReference
- response
type: object
Name:
properties:
firstName:
@@ -778,6 +786,7 @@ components:
required:
- firstName
- lastName
type: object
PayoutRequest:
properties:
amount:
@@ -888,6 +897,7 @@ components:
- merchantAccount
- reference
- amount
type: object
PayoutResponse:
properties:
additionalData:
@@ -1008,6 +1018,7 @@ components:
- Refused
- Success
type: string
type: object
Recurring:
properties:
contract:
@@ -1045,6 +1056,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
ResponseAdditionalData3DSecure:
properties:
cardHolderInfo:
@@ -1066,6 +1078,7 @@ components:
threeds2.cardEnrolled:
description: Indicates whether a card is enrolled for 3D Secure 2.
type: boolean
type: object
ResponseAdditionalDataBillingAddress:
properties:
billingAddress.city:
@@ -1097,6 +1110,7 @@ components:
billingAddress.street:
description: The billing address street passed in the payment request.
type: string
type: object
ResponseAdditionalDataCard:
properties:
cardBin:
@@ -1151,6 +1165,7 @@ components:
Example: 52123423'
type: string
type: object
ResponseAdditionalDataCommon:
properties:
acquirerAccountCode:
@@ -1595,6 +1610,7 @@ components:
Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
type: string
type: object
ResponseAdditionalDataInstallments:
properties:
installmentPaymentData.installmentType:
@@ -1646,6 +1662,7 @@ components:
> Only relevant for card payments in countries that support installments.'
type: string
type: object
ResponseAdditionalDataNetworkTokens:
properties:
networkToken.available:
@@ -1659,6 +1676,7 @@ components:
networkToken.tokenSummary:
description: The last four digits of a network token.
type: string
type: object
ResponseAdditionalDataOpi:
properties:
opi.transToken:
@@ -1668,6 +1686,7 @@ components:
tokenized ecommerce transactions. For more information and required settings,
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
type: string
type: object
ResponseAdditionalDataSepa:
properties:
sepadirectdebit.dateOfSignature:
@@ -1696,6 +1715,7 @@ components:
Example: OOFF'
type: string
type: object
ServiceError:
properties:
errorCode:
@@ -1714,6 +1734,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
StoreDetailAndSubmitRequest:
properties:
additionalData:
@@ -1754,7 +1775,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1832,6 +1853,7 @@ components:
- entityType
- reference
- amount
type: object
StoreDetailAndSubmitResponse:
properties:
additionalData:
@@ -1857,6 +1879,7 @@ components:
required:
- pspReference
- resultCode
type: object
StoreDetailRequest:
properties:
additionalData:
@@ -1893,7 +1916,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1958,6 +1981,7 @@ components:
- dateOfBirth
- nationality
- entityType
type: object
StoreDetailResponse:
properties:
additionalData:
@@ -1980,6 +2004,7 @@ components:
- pspReference
- recurringDetailReference
- resultCode
type: object
SubmitRequest:
properties:
additionalData:
@@ -1999,7 +2024,7 @@ components:
\ account.\n\n> This field is mandatory for natural persons. \n> This\
\ field is required to update the existing `dateOfBirth` that is associated\
\ with this recurring contract."
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -2093,6 +2118,7 @@ components:
- shopperReference
- recurring
- selectedRecurringDetailReference
type: object
SubmitResponse:
properties:
additionalData:
@@ -2117,6 +2143,7 @@ components:
required:
- pspReference
- resultCode
type: object
securitySchemes:
ApiKeyAuth:
in: header
@@ -2269,7 +2296,7 @@ components:
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING,PAYOUT
contract: PAYOUT
amount:
value: 2000
currency: EUR

61
yaml/PayoutService-v50.yaml
View File

@@ -72,7 +72,7 @@ info:
Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
URLs** > **Prefix**.'
x-timestamp: '2022-12-13T09:27:04Z'
x-timestamp: '2023-04-11T21:25:14Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -100,7 +100,7 @@ paths:
operationId: post-confirmThirdParty
x-groupName: Reviewing
x-sortIndex: 1
x-methodName: confirmPayout
x-methodName: confirmThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -168,7 +168,7 @@ paths:
operationId: post-declineThirdParty
x-groupName: Reviewing
x-sortIndex: 2
x-methodName: cancelPayout
x-methodName: declineThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -236,7 +236,7 @@ paths:
operationId: post-payout
x-groupName: Instant payouts
x-sortIndex: 1
x-methodName: makeInstantCardPayout
x-methodName: payout
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -301,7 +301,7 @@ paths:
operationId: post-storeDetail
x-groupName: Initialization
x-sortIndex: 2
x-methodName: storePayoutDetails
x-methodName: storeDetail
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -370,7 +370,7 @@ paths:
operationId: post-storeDetailAndSubmitThirdParty
x-groupName: Initialization
x-sortIndex: 1
x-methodName: storeDetailsAndSubmitPayout
x-methodName: storeDetailAndSubmitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -445,7 +445,7 @@ paths:
operationId: post-submitThirdParty
x-groupName: Initialization
x-sortIndex: 3
x-methodName: submitPayout
x-methodName: submitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -539,6 +539,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -553,6 +554,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -601,6 +603,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -664,11 +667,7 @@ components:
maxLength: 4
minLength: 4
type: string
required:
- number
- expiryMonth
- expiryYear
- holderName
type: object
FraudCheckResult:
properties:
accountScore:
@@ -686,6 +685,11 @@ components:
- checkId
- name
- accountScore
type: object
FraudCheckResultWrapper:
properties:
FraudCheckResult:
$ref: '#/components/schemas/FraudCheckResult'
FraudResult:
properties:
accountScore:
@@ -695,10 +699,11 @@ components:
results:
description: The result of the individual risk checks.
items:
$ref: '#/components/schemas/FraudCheckResult'
$ref: '#/components/schemas/FraudCheckResultWrapper'
type: array
required:
- accountScore
type: object
FundSource:
properties:
additionalData:
@@ -726,6 +731,7 @@ components:
telephoneNumber:
description: Phone number of the person
type: string
type: object
ModifyRequest:
properties:
additionalData:
@@ -744,6 +750,7 @@ components:
required:
- merchantAccount
- originalReference
type: object
ModifyResponse:
properties:
additionalData:
@@ -767,6 +774,7 @@ components:
required:
- pspReference
- response
type: object
Name:
properties:
firstName:
@@ -778,6 +786,7 @@ components:
required:
- firstName
- lastName
type: object
PayoutRequest:
properties:
amount:
@@ -888,6 +897,7 @@ components:
- merchantAccount
- reference
- amount
type: object
PayoutResponse:
properties:
additionalData:
@@ -1008,6 +1018,7 @@ components:
- Refused
- Success
type: string
type: object
Recurring:
properties:
contract:
@@ -1045,6 +1056,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
ResponseAdditionalData3DSecure:
properties:
cardHolderInfo:
@@ -1066,6 +1078,7 @@ components:
threeds2.cardEnrolled:
description: Indicates whether a card is enrolled for 3D Secure 2.
type: boolean
type: object
ResponseAdditionalDataBillingAddress:
properties:
billingAddress.city:
@@ -1097,6 +1110,7 @@ components:
billingAddress.street:
description: The billing address street passed in the payment request.
type: string
type: object
ResponseAdditionalDataCard:
properties:
cardBin:
@@ -1151,6 +1165,7 @@ components:
Example: 52123423'
type: string
type: object
ResponseAdditionalDataCommon:
properties:
acquirerAccountCode:
@@ -1595,6 +1610,7 @@ components:
Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
type: string
type: object
ResponseAdditionalDataInstallments:
properties:
installmentPaymentData.installmentType:
@@ -1646,6 +1662,7 @@ components:
> Only relevant for card payments in countries that support installments.'
type: string
type: object
ResponseAdditionalDataNetworkTokens:
properties:
networkToken.available:
@@ -1659,6 +1676,7 @@ components:
networkToken.tokenSummary:
description: The last four digits of a network token.
type: string
type: object
ResponseAdditionalDataOpi:
properties:
opi.transToken:
@@ -1668,6 +1686,7 @@ components:
tokenized ecommerce transactions. For more information and required settings,
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
type: string
type: object
ResponseAdditionalDataSepa:
properties:
sepadirectdebit.dateOfSignature:
@@ -1696,6 +1715,7 @@ components:
Example: OOFF'
type: string
type: object
ServiceError:
properties:
additionalData:
@@ -1722,6 +1742,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
StoreDetailAndSubmitRequest:
properties:
additionalData:
@@ -1762,7 +1783,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1840,6 +1861,7 @@ components:
- entityType
- reference
- amount
type: object
StoreDetailAndSubmitResponse:
properties:
additionalData:
@@ -1865,6 +1887,7 @@ components:
required:
- pspReference
- resultCode
type: object
StoreDetailRequest:
properties:
additionalData:
@@ -1901,7 +1924,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1966,6 +1989,7 @@ components:
- dateOfBirth
- nationality
- entityType
type: object
StoreDetailResponse:
properties:
additionalData:
@@ -1988,6 +2012,7 @@ components:
- pspReference
- recurringDetailReference
- resultCode
type: object
SubmitRequest:
properties:
additionalData:
@@ -2007,7 +2032,7 @@ components:
\ account.\n\n> This field is mandatory for natural persons. \n> This\
\ field is required to update the existing `dateOfBirth` that is associated\
\ with this recurring contract."
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -2101,6 +2126,7 @@ components:
- shopperReference
- recurring
- selectedRecurringDetailReference
type: object
SubmitResponse:
properties:
additionalData:
@@ -2125,6 +2151,7 @@ components:
required:
- pspReference
- resultCode
type: object
securitySchemes:
ApiKeyAuth:
in: header
@@ -2277,7 +2304,7 @@ components:
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING,PAYOUT
contract: PAYOUT
amount:
value: 2000
currency: EUR

61
yaml/PayoutService-v51.yaml
View File

@@ -72,7 +72,7 @@ info:
Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
URLs** > **Prefix**.'
x-timestamp: '2022-12-13T09:27:04Z'
x-timestamp: '2023-04-11T21:25:14Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -100,7 +100,7 @@ paths:
operationId: post-confirmThirdParty
x-groupName: Reviewing
x-sortIndex: 1
x-methodName: confirmPayout
x-methodName: confirmThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -168,7 +168,7 @@ paths:
operationId: post-declineThirdParty
x-groupName: Reviewing
x-sortIndex: 2
x-methodName: cancelPayout
x-methodName: declineThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -236,7 +236,7 @@ paths:
operationId: post-payout
x-groupName: Instant payouts
x-sortIndex: 1
x-methodName: makeInstantCardPayout
x-methodName: payout
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -301,7 +301,7 @@ paths:
operationId: post-storeDetail
x-groupName: Initialization
x-sortIndex: 2
x-methodName: storePayoutDetails
x-methodName: storeDetail
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -370,7 +370,7 @@ paths:
operationId: post-storeDetailAndSubmitThirdParty
x-groupName: Initialization
x-sortIndex: 1
x-methodName: storeDetailsAndSubmitPayout
x-methodName: storeDetailAndSubmitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -445,7 +445,7 @@ paths:
operationId: post-submitThirdParty
x-groupName: Initialization
x-sortIndex: 3
x-methodName: submitPayout
x-methodName: submitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -539,6 +539,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -553,6 +554,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -601,6 +603,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -664,11 +667,7 @@ components:
maxLength: 4
minLength: 4
type: string
required:
- number
- expiryMonth
- expiryYear
- holderName
type: object
FraudCheckResult:
properties:
accountScore:
@@ -686,6 +685,11 @@ components:
- checkId
- name
- accountScore
type: object
FraudCheckResultWrapper:
properties:
FraudCheckResult:
$ref: '#/components/schemas/FraudCheckResult'
FraudResult:
properties:
accountScore:
@@ -695,10 +699,11 @@ components:
results:
description: The result of the individual risk checks.
items:
$ref: '#/components/schemas/FraudCheckResult'
$ref: '#/components/schemas/FraudCheckResultWrapper'
type: array
required:
- accountScore
type: object
FundSource:
properties:
additionalData:
@@ -726,6 +731,7 @@ components:
telephoneNumber:
description: Phone number of the person
type: string
type: object
ModifyRequest:
properties:
additionalData:
@@ -744,6 +750,7 @@ components:
required:
- merchantAccount
- originalReference
type: object
ModifyResponse:
properties:
additionalData:
@@ -767,6 +774,7 @@ components:
required:
- pspReference
- response
type: object
Name:
properties:
firstName:
@@ -778,6 +786,7 @@ components:
required:
- firstName
- lastName
type: object
PayoutRequest:
properties:
amount:
@@ -888,6 +897,7 @@ components:
- merchantAccount
- reference
- amount
type: object
PayoutResponse:
properties:
additionalData:
@@ -1008,6 +1018,7 @@ components:
- Refused
- Success
type: string
type: object
Recurring:
properties:
contract:
@@ -1045,6 +1056,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
ResponseAdditionalData3DSecure:
properties:
cardHolderInfo:
@@ -1066,6 +1078,7 @@ components:
threeds2.cardEnrolled:
description: Indicates whether a card is enrolled for 3D Secure 2.
type: boolean
type: object
ResponseAdditionalDataBillingAddress:
properties:
billingAddress.city:
@@ -1097,6 +1110,7 @@ components:
billingAddress.street:
description: The billing address street passed in the payment request.
type: string
type: object
ResponseAdditionalDataCard:
properties:
cardBin:
@@ -1151,6 +1165,7 @@ components:
Example: 52123423'
type: string
type: object
ResponseAdditionalDataCommon:
properties:
acquirerAccountCode:
@@ -1595,6 +1610,7 @@ components:
Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
type: string
type: object
ResponseAdditionalDataInstallments:
properties:
installmentPaymentData.installmentType:
@@ -1646,6 +1662,7 @@ components:
> Only relevant for card payments in countries that support installments.'
type: string
type: object
ResponseAdditionalDataNetworkTokens:
properties:
networkToken.available:
@@ -1659,6 +1676,7 @@ components:
networkToken.tokenSummary:
description: The last four digits of a network token.
type: string
type: object
ResponseAdditionalDataOpi:
properties:
opi.transToken:
@@ -1668,6 +1686,7 @@ components:
tokenized ecommerce transactions. For more information and required settings,
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
type: string
type: object
ResponseAdditionalDataSepa:
properties:
sepadirectdebit.dateOfSignature:
@@ -1696,6 +1715,7 @@ components:
Example: OOFF'
type: string
type: object
ServiceError:
properties:
additionalData:
@@ -1722,6 +1742,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
StoreDetailAndSubmitRequest:
properties:
additionalData:
@@ -1762,7 +1783,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1840,6 +1861,7 @@ components:
- entityType
- reference
- amount
type: object
StoreDetailAndSubmitResponse:
properties:
additionalData:
@@ -1865,6 +1887,7 @@ components:
required:
- pspReference
- resultCode
type: object
StoreDetailRequest:
properties:
additionalData:
@@ -1901,7 +1924,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1966,6 +1989,7 @@ components:
- dateOfBirth
- nationality
- entityType
type: object
StoreDetailResponse:
properties:
additionalData:
@@ -1988,6 +2012,7 @@ components:
- pspReference
- recurringDetailReference
- resultCode
type: object
SubmitRequest:
properties:
additionalData:
@@ -2007,7 +2032,7 @@ components:
\ account.\n\n> This field is mandatory for natural persons. \n> This\
\ field is required to update the existing `dateOfBirth` that is associated\
\ with this recurring contract."
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -2101,6 +2126,7 @@ components:
- shopperReference
- recurring
- selectedRecurringDetailReference
type: object
SubmitResponse:
properties:
additionalData:
@@ -2125,6 +2151,7 @@ components:
required:
- pspReference
- resultCode
type: object
securitySchemes:
ApiKeyAuth:
in: header
@@ -2277,7 +2304,7 @@ components:
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING,PAYOUT
contract: PAYOUT
amount:
value: 2000
currency: EUR

61
yaml/PayoutService-v52.yaml
View File

@@ -72,7 +72,7 @@ info:
Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
URLs** > **Prefix**.'
x-timestamp: '2022-12-13T09:27:04Z'
x-timestamp: '2023-04-11T21:25:15Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -100,7 +100,7 @@ paths:
operationId: post-confirmThirdParty
x-groupName: Reviewing
x-sortIndex: 1
x-methodName: confirmPayout
x-methodName: confirmThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -168,7 +168,7 @@ paths:
operationId: post-declineThirdParty
x-groupName: Reviewing
x-sortIndex: 2
x-methodName: cancelPayout
x-methodName: declineThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -236,7 +236,7 @@ paths:
operationId: post-payout
x-groupName: Instant payouts
x-sortIndex: 1
x-methodName: makeInstantCardPayout
x-methodName: payout
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -301,7 +301,7 @@ paths:
operationId: post-storeDetail
x-groupName: Initialization
x-sortIndex: 2
x-methodName: storePayoutDetails
x-methodName: storeDetail
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -370,7 +370,7 @@ paths:
operationId: post-storeDetailAndSubmitThirdParty
x-groupName: Initialization
x-sortIndex: 1
x-methodName: storeDetailsAndSubmitPayout
x-methodName: storeDetailAndSubmitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -445,7 +445,7 @@ paths:
operationId: post-submitThirdParty
x-groupName: Initialization
x-sortIndex: 3
x-methodName: submitPayout
x-methodName: submitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -539,6 +539,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -553,6 +554,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -601,6 +603,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -664,11 +667,7 @@ components:
maxLength: 4
minLength: 4
type: string
required:
- number
- expiryMonth
- expiryYear
- holderName
type: object
FraudCheckResult:
properties:
accountScore:
@@ -686,6 +685,11 @@ components:
- checkId
- name
- accountScore
type: object
FraudCheckResultWrapper:
properties:
FraudCheckResult:
$ref: '#/components/schemas/FraudCheckResult'
FraudResult:
properties:
accountScore:
@@ -695,10 +699,11 @@ components:
results:
description: The result of the individual risk checks.
items:
$ref: '#/components/schemas/FraudCheckResult'
$ref: '#/components/schemas/FraudCheckResultWrapper'
type: array
required:
- accountScore
type: object
FundSource:
properties:
additionalData:
@@ -726,6 +731,7 @@ components:
telephoneNumber:
description: Phone number of the person
type: string
type: object
ModifyRequest:
properties:
additionalData:
@@ -744,6 +750,7 @@ components:
required:
- merchantAccount
- originalReference
type: object
ModifyResponse:
properties:
additionalData:
@@ -767,6 +774,7 @@ components:
required:
- pspReference
- response
type: object
Name:
properties:
firstName:
@@ -778,6 +786,7 @@ components:
required:
- firstName
- lastName
type: object
PayoutRequest:
properties:
amount:
@@ -888,6 +897,7 @@ components:
- merchantAccount
- reference
- amount
type: object
PayoutResponse:
properties:
additionalData:
@@ -1008,6 +1018,7 @@ components:
- Refused
- Success
type: string
type: object
Recurring:
properties:
contract:
@@ -1045,6 +1056,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
ResponseAdditionalData3DSecure:
properties:
cardHolderInfo:
@@ -1066,6 +1078,7 @@ components:
threeds2.cardEnrolled:
description: Indicates whether a card is enrolled for 3D Secure 2.
type: boolean
type: object
ResponseAdditionalDataBillingAddress:
properties:
billingAddress.city:
@@ -1097,6 +1110,7 @@ components:
billingAddress.street:
description: The billing address street passed in the payment request.
type: string
type: object
ResponseAdditionalDataCard:
properties:
cardBin:
@@ -1151,6 +1165,7 @@ components:
Example: 52123423'
type: string
type: object
ResponseAdditionalDataCommon:
properties:
acquirerAccountCode:
@@ -1595,6 +1610,7 @@ components:
Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
type: string
type: object
ResponseAdditionalDataInstallments:
properties:
installmentPaymentData.installmentType:
@@ -1646,6 +1662,7 @@ components:
> Only relevant for card payments in countries that support installments.'
type: string
type: object
ResponseAdditionalDataNetworkTokens:
properties:
networkToken.available:
@@ -1659,6 +1676,7 @@ components:
networkToken.tokenSummary:
description: The last four digits of a network token.
type: string
type: object
ResponseAdditionalDataOpi:
properties:
opi.transToken:
@@ -1668,6 +1686,7 @@ components:
tokenized ecommerce transactions. For more information and required settings,
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
type: string
type: object
ResponseAdditionalDataSepa:
properties:
sepadirectdebit.dateOfSignature:
@@ -1696,6 +1715,7 @@ components:
Example: OOFF'
type: string
type: object
ServiceError:
properties:
additionalData:
@@ -1722,6 +1742,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
StoreDetailAndSubmitRequest:
properties:
additionalData:
@@ -1762,7 +1783,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1844,6 +1865,7 @@ components:
- entityType
- reference
- amount
type: object
StoreDetailAndSubmitResponse:
properties:
additionalData:
@@ -1869,6 +1891,7 @@ components:
required:
- pspReference
- resultCode
type: object
StoreDetailRequest:
properties:
additionalData:
@@ -1905,7 +1928,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1974,6 +1997,7 @@ components:
- dateOfBirth
- nationality
- entityType
type: object
StoreDetailResponse:
properties:
additionalData:
@@ -1996,6 +2020,7 @@ components:
- pspReference
- recurringDetailReference
- resultCode
type: object
SubmitRequest:
properties:
additionalData:
@@ -2015,7 +2040,7 @@ components:
\ account.\n\n> This field is mandatory for natural persons. \n> This\
\ field is required to update the existing `dateOfBirth` that is associated\
\ with this recurring contract."
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -2109,6 +2134,7 @@ components:
- shopperReference
- recurring
- selectedRecurringDetailReference
type: object
SubmitResponse:
properties:
additionalData:
@@ -2133,6 +2159,7 @@ components:
required:
- pspReference
- resultCode
type: object
securitySchemes:
ApiKeyAuth:
in: header
@@ -2285,7 +2312,7 @@ components:
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING,PAYOUT
contract: PAYOUT
amount:
value: 2000
currency: EUR

61
yaml/PayoutService-v64.yaml
View File

@@ -72,7 +72,7 @@ info:
Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
URLs** > **Prefix**.'
x-timestamp: '2022-12-13T09:27:04Z'
x-timestamp: '2023-04-11T21:25:14Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -100,7 +100,7 @@ paths:
operationId: post-confirmThirdParty
x-groupName: Reviewing
x-sortIndex: 1
x-methodName: confirmPayout
x-methodName: confirmThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -168,7 +168,7 @@ paths:
operationId: post-declineThirdParty
x-groupName: Reviewing
x-sortIndex: 2
x-methodName: cancelPayout
x-methodName: declineThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -236,7 +236,7 @@ paths:
operationId: post-payout
x-groupName: Instant payouts
x-sortIndex: 1
x-methodName: makeInstantCardPayout
x-methodName: payout
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -301,7 +301,7 @@ paths:
operationId: post-storeDetail
x-groupName: Initialization
x-sortIndex: 2
x-methodName: storePayoutDetails
x-methodName: storeDetail
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -370,7 +370,7 @@ paths:
operationId: post-storeDetailAndSubmitThirdParty
x-groupName: Initialization
x-sortIndex: 1
x-methodName: storeDetailsAndSubmitPayout
x-methodName: storeDetailAndSubmitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -445,7 +445,7 @@ paths:
operationId: post-submitThirdParty
x-groupName: Initialization
x-sortIndex: 3
x-methodName: submitPayout
x-methodName: submitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -539,6 +539,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -553,6 +554,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -601,6 +603,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -664,11 +667,7 @@ components:
maxLength: 4
minLength: 4
type: string
required:
- number
- expiryMonth
- expiryYear
- holderName
type: object
FraudCheckResult:
properties:
accountScore:
@@ -686,6 +685,11 @@ components:
- checkId
- name
- accountScore
type: object
FraudCheckResultWrapper:
properties:
FraudCheckResult:
$ref: '#/components/schemas/FraudCheckResult'
FraudResult:
properties:
accountScore:
@@ -695,10 +699,11 @@ components:
results:
description: The result of the individual risk checks.
items:
$ref: '#/components/schemas/FraudCheckResult'
$ref: '#/components/schemas/FraudCheckResultWrapper'
type: array
required:
- accountScore
type: object
FundSource:
properties:
additionalData:
@@ -726,6 +731,7 @@ components:
telephoneNumber:
description: Phone number of the person
type: string
type: object
ModifyRequest:
properties:
additionalData:
@@ -744,6 +750,7 @@ components:
required:
- merchantAccount
- originalReference
type: object
ModifyResponse:
properties:
additionalData:
@@ -767,6 +774,7 @@ components:
required:
- pspReference
- response
type: object
Name:
properties:
firstName:
@@ -778,6 +786,7 @@ components:
required:
- firstName
- lastName
type: object
PayoutRequest:
properties:
amount:
@@ -888,6 +897,7 @@ components:
- merchantAccount
- reference
- amount
type: object
PayoutResponse:
properties:
additionalData:
@@ -1008,6 +1018,7 @@ components:
- Refused
- Success
type: string
type: object
Recurring:
properties:
contract:
@@ -1045,6 +1056,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
ResponseAdditionalData3DSecure:
properties:
cardHolderInfo:
@@ -1066,6 +1078,7 @@ components:
threeds2.cardEnrolled:
description: Indicates whether a card is enrolled for 3D Secure 2.
type: boolean
type: object
ResponseAdditionalDataBillingAddress:
properties:
billingAddress.city:
@@ -1097,6 +1110,7 @@ components:
billingAddress.street:
description: The billing address street passed in the payment request.
type: string
type: object
ResponseAdditionalDataCard:
properties:
cardBin:
@@ -1151,6 +1165,7 @@ components:
Example: 52123423'
type: string
type: object
ResponseAdditionalDataCommon:
properties:
acquirerAccountCode:
@@ -1595,6 +1610,7 @@ components:
Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
type: string
type: object
ResponseAdditionalDataInstallments:
properties:
installmentPaymentData.installmentType:
@@ -1646,6 +1662,7 @@ components:
> Only relevant for card payments in countries that support installments.'
type: string
type: object
ResponseAdditionalDataNetworkTokens:
properties:
networkToken.available:
@@ -1659,6 +1676,7 @@ components:
networkToken.tokenSummary:
description: The last four digits of a network token.
type: string
type: object
ResponseAdditionalDataOpi:
properties:
opi.transToken:
@@ -1668,6 +1686,7 @@ components:
tokenized ecommerce transactions. For more information and required settings,
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
type: string
type: object
ResponseAdditionalDataSepa:
properties:
sepadirectdebit.dateOfSignature:
@@ -1696,6 +1715,7 @@ components:
Example: OOFF'
type: string
type: object
ServiceError:
properties:
additionalData:
@@ -1722,6 +1742,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
StoreDetailAndSubmitRequest:
properties:
additionalData:
@@ -1762,7 +1783,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1844,6 +1865,7 @@ components:
- entityType
- reference
- amount
type: object
StoreDetailAndSubmitResponse:
properties:
additionalData:
@@ -1869,6 +1891,7 @@ components:
required:
- pspReference
- resultCode
type: object
StoreDetailRequest:
properties:
additionalData:
@@ -1905,7 +1928,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1974,6 +1997,7 @@ components:
- dateOfBirth
- nationality
- entityType
type: object
StoreDetailResponse:
properties:
additionalData:
@@ -1996,6 +2020,7 @@ components:
- pspReference
- recurringDetailReference
- resultCode
type: object
SubmitRequest:
properties:
additionalData:
@@ -2015,7 +2040,7 @@ components:
\ account.\n\n> This field is mandatory for natural persons. \n> This\
\ field is required to update the existing `dateOfBirth` that is associated\
\ with this recurring contract."
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -2109,6 +2134,7 @@ components:
- shopperReference
- recurring
- selectedRecurringDetailReference
type: object
SubmitResponse:
properties:
additionalData:
@@ -2133,6 +2159,7 @@ components:
required:
- pspReference
- resultCode
type: object
securitySchemes:
ApiKeyAuth:
in: header
@@ -2285,7 +2312,7 @@ components:
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING,PAYOUT
contract: PAYOUT
amount:
value: 2000
currency: EUR

61
yaml/PayoutService-v67.yaml
View File

@@ -72,7 +72,7 @@ info:
Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
URLs** > **Prefix**.'
x-timestamp: '2022-12-13T09:27:04Z'
x-timestamp: '2023-04-11T21:25:15Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -100,7 +100,7 @@ paths:
operationId: post-confirmThirdParty
x-groupName: Reviewing
x-sortIndex: 1
x-methodName: confirmPayout
x-methodName: confirmThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -168,7 +168,7 @@ paths:
operationId: post-declineThirdParty
x-groupName: Reviewing
x-sortIndex: 2
x-methodName: cancelPayout
x-methodName: declineThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -236,7 +236,7 @@ paths:
operationId: post-payout
x-groupName: Instant payouts
x-sortIndex: 1
x-methodName: makeInstantCardPayout
x-methodName: payout
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -301,7 +301,7 @@ paths:
operationId: post-storeDetail
x-groupName: Initialization
x-sortIndex: 2
x-methodName: storePayoutDetails
x-methodName: storeDetail
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -370,7 +370,7 @@ paths:
operationId: post-storeDetailAndSubmitThirdParty
x-groupName: Initialization
x-sortIndex: 1
x-methodName: storeDetailsAndSubmitPayout
x-methodName: storeDetailAndSubmitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -445,7 +445,7 @@ paths:
operationId: post-submitThirdParty
x-groupName: Initialization
x-sortIndex: 3
x-methodName: submitPayout
x-methodName: submitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -539,6 +539,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -553,6 +554,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -601,6 +603,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -664,11 +667,7 @@ components:
maxLength: 4
minLength: 4
type: string
required:
- number
- expiryMonth
- expiryYear
- holderName
type: object
FraudCheckResult:
properties:
accountScore:
@@ -686,6 +685,11 @@ components:
- checkId
- name
- accountScore
type: object
FraudCheckResultWrapper:
properties:
FraudCheckResult:
$ref: '#/components/schemas/FraudCheckResult'
FraudResult:
properties:
accountScore:
@@ -695,10 +699,11 @@ components:
results:
description: The result of the individual risk checks.
items:
$ref: '#/components/schemas/FraudCheckResult'
$ref: '#/components/schemas/FraudCheckResultWrapper'
type: array
required:
- accountScore
type: object
FundSource:
properties:
additionalData:
@@ -726,6 +731,7 @@ components:
telephoneNumber:
description: Phone number of the person
type: string
type: object
ModifyRequest:
properties:
additionalData:
@@ -744,6 +750,7 @@ components:
required:
- merchantAccount
- originalReference
type: object
ModifyResponse:
properties:
additionalData:
@@ -767,6 +774,7 @@ components:
required:
- pspReference
- response
type: object
Name:
properties:
firstName:
@@ -778,6 +786,7 @@ components:
required:
- firstName
- lastName
type: object
PayoutRequest:
properties:
amount:
@@ -888,6 +897,7 @@ components:
- merchantAccount
- reference
- amount
type: object
PayoutResponse:
properties:
additionalData:
@@ -1008,6 +1018,7 @@ components:
- Refused
- Success
type: string
type: object
Recurring:
properties:
contract:
@@ -1045,6 +1056,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
ResponseAdditionalData3DSecure:
properties:
cardHolderInfo:
@@ -1066,6 +1078,7 @@ components:
threeds2.cardEnrolled:
description: Indicates whether a card is enrolled for 3D Secure 2.
type: boolean
type: object
ResponseAdditionalDataBillingAddress:
properties:
billingAddress.city:
@@ -1097,6 +1110,7 @@ components:
billingAddress.street:
description: The billing address street passed in the payment request.
type: string
type: object
ResponseAdditionalDataCard:
properties:
cardBin:
@@ -1151,6 +1165,7 @@ components:
Example: 52123423'
type: string
type: object
ResponseAdditionalDataCommon:
properties:
acquirerAccountCode:
@@ -1588,6 +1603,7 @@ components:
Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
type: string
type: object
ResponseAdditionalDataInstallments:
properties:
installmentPaymentData.installmentType:
@@ -1639,6 +1655,7 @@ components:
> Only relevant for card payments in countries that support installments.'
type: string
type: object
ResponseAdditionalDataNetworkTokens:
properties:
networkToken.available:
@@ -1652,6 +1669,7 @@ components:
networkToken.tokenSummary:
description: The last four digits of a network token.
type: string
type: object
ResponseAdditionalDataOpi:
properties:
opi.transToken:
@@ -1661,6 +1679,7 @@ components:
tokenized ecommerce transactions. For more information and required settings,
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
type: string
type: object
ResponseAdditionalDataSepa:
properties:
sepadirectdebit.dateOfSignature:
@@ -1689,6 +1708,7 @@ components:
Example: OOFF'
type: string
type: object
ServiceError:
properties:
additionalData:
@@ -1715,6 +1735,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
StoreDetailAndSubmitRequest:
properties:
additionalData:
@@ -1755,7 +1776,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1837,6 +1858,7 @@ components:
- entityType
- reference
- amount
type: object
StoreDetailAndSubmitResponse:
properties:
additionalData:
@@ -1862,6 +1884,7 @@ components:
required:
- pspReference
- resultCode
type: object
StoreDetailRequest:
properties:
additionalData:
@@ -1898,7 +1921,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1967,6 +1990,7 @@ components:
- dateOfBirth
- nationality
- entityType
type: object
StoreDetailResponse:
properties:
additionalData:
@@ -1989,6 +2013,7 @@ components:
- pspReference
- recurringDetailReference
- resultCode
type: object
SubmitRequest:
properties:
additionalData:
@@ -2008,7 +2033,7 @@ components:
\ account.\n\n> This field is mandatory for natural persons. \n> This\
\ field is required to update the existing `dateOfBirth` that is associated\
\ with this recurring contract."
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -2102,6 +2127,7 @@ components:
- shopperReference
- recurring
- selectedRecurringDetailReference
type: object
SubmitResponse:
properties:
additionalData:
@@ -2126,6 +2152,7 @@ components:
required:
- pspReference
- resultCode
type: object
securitySchemes:
ApiKeyAuth:
in: header
@@ -2278,7 +2305,7 @@ components:
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING,PAYOUT
contract: PAYOUT
amount:
value: 2000
currency: EUR

61
yaml/PayoutService-v68.yaml
View File

@@ -72,7 +72,7 @@ info:
Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
URLs** > **Prefix**.'
x-timestamp: '2022-12-13T09:27:04Z'
x-timestamp: '2023-04-11T21:25:15Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -100,7 +100,7 @@ paths:
operationId: post-confirmThirdParty
x-groupName: Reviewing
x-sortIndex: 1
x-methodName: confirmPayout
x-methodName: confirmThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -168,7 +168,7 @@ paths:
operationId: post-declineThirdParty
x-groupName: Reviewing
x-sortIndex: 2
x-methodName: cancelPayout
x-methodName: declineThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -236,7 +236,7 @@ paths:
operationId: post-payout
x-groupName: Instant payouts
x-sortIndex: 1
x-methodName: makeInstantCardPayout
x-methodName: payout
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -301,7 +301,7 @@ paths:
operationId: post-storeDetail
x-groupName: Initialization
x-sortIndex: 2
x-methodName: storePayoutDetails
x-methodName: storeDetail
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -370,7 +370,7 @@ paths:
operationId: post-storeDetailAndSubmitThirdParty
x-groupName: Initialization
x-sortIndex: 1
x-methodName: storeDetailsAndSubmitPayout
x-methodName: storeDetailAndSubmitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -445,7 +445,7 @@ paths:
operationId: post-submitThirdParty
x-groupName: Initialization
x-sortIndex: 3
x-methodName: submitPayout
x-methodName: submitThirdParty
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -539,6 +539,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -553,6 +554,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -601,6 +603,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -664,11 +667,7 @@ components:
maxLength: 4
minLength: 4
type: string
required:
- number
- expiryMonth
- expiryYear
- holderName
type: object
FraudCheckResult:
properties:
accountScore:
@@ -686,6 +685,11 @@ components:
- checkId
- name
- accountScore
type: object
FraudCheckResultWrapper:
properties:
FraudCheckResult:
$ref: '#/components/schemas/FraudCheckResult'
FraudResult:
properties:
accountScore:
@@ -695,10 +699,11 @@ components:
results:
description: The result of the individual risk checks.
items:
$ref: '#/components/schemas/FraudCheckResult'
$ref: '#/components/schemas/FraudCheckResultWrapper'
type: array
required:
- accountScore
type: object
FundSource:
properties:
additionalData:
@@ -726,6 +731,7 @@ components:
telephoneNumber:
description: Phone number of the person
type: string
type: object
ModifyRequest:
properties:
additionalData:
@@ -744,6 +750,7 @@ components:
required:
- merchantAccount
- originalReference
type: object
ModifyResponse:
properties:
additionalData:
@@ -767,6 +774,7 @@ components:
required:
- pspReference
- response
type: object
Name:
properties:
firstName:
@@ -778,6 +786,7 @@ components:
required:
- firstName
- lastName
type: object
PayoutRequest:
properties:
amount:
@@ -888,6 +897,7 @@ components:
- merchantAccount
- reference
- amount
type: object
PayoutResponse:
properties:
additionalData:
@@ -1008,6 +1018,7 @@ components:
- Refused
- Success
type: string
type: object
Recurring:
properties:
contract:
@@ -1045,6 +1056,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
ResponseAdditionalData3DSecure:
properties:
cardHolderInfo:
@@ -1066,6 +1078,7 @@ components:
threeds2.cardEnrolled:
description: Indicates whether a card is enrolled for 3D Secure 2.
type: boolean
type: object
ResponseAdditionalDataBillingAddress:
properties:
billingAddress.city:
@@ -1097,6 +1110,7 @@ components:
billingAddress.street:
description: The billing address street passed in the payment request.
type: string
type: object
ResponseAdditionalDataCard:
properties:
cardBin:
@@ -1151,6 +1165,7 @@ components:
Example: 52123423'
type: string
type: object
ResponseAdditionalDataCommon:
properties:
acquirerAccountCode:
@@ -1588,6 +1603,7 @@ components:
Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
type: string
type: object
ResponseAdditionalDataInstallments:
properties:
installmentPaymentData.installmentType:
@@ -1639,6 +1655,7 @@ components:
> Only relevant for card payments in countries that support installments.'
type: string
type: object
ResponseAdditionalDataNetworkTokens:
properties:
networkToken.available:
@@ -1652,6 +1669,7 @@ components:
networkToken.tokenSummary:
description: The last four digits of a network token.
type: string
type: object
ResponseAdditionalDataOpi:
properties:
opi.transToken:
@@ -1661,6 +1679,7 @@ components:
tokenized ecommerce transactions. For more information and required settings,
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
type: string
type: object
ResponseAdditionalDataSepa:
properties:
sepadirectdebit.dateOfSignature:
@@ -1689,6 +1708,7 @@ components:
Example: OOFF'
type: string
type: object
ServiceError:
properties:
additionalData:
@@ -1715,6 +1735,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
StoreDetailAndSubmitRequest:
properties:
additionalData:
@@ -1755,7 +1776,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1837,6 +1858,7 @@ components:
- entityType
- reference
- amount
type: object
StoreDetailAndSubmitResponse:
properties:
additionalData:
@@ -1862,6 +1884,7 @@ components:
required:
- pspReference
- resultCode
type: object
StoreDetailRequest:
properties:
additionalData:
@@ -1898,7 +1921,7 @@ components:
account.
> This field is mandatory for natural persons.'
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -1967,6 +1990,7 @@ components:
- dateOfBirth
- nationality
- entityType
type: object
StoreDetailResponse:
properties:
additionalData:
@@ -1989,6 +2013,7 @@ components:
- pspReference
- recurringDetailReference
- resultCode
type: object
SubmitRequest:
properties:
additionalData:
@@ -2008,7 +2033,7 @@ components:
\ account.\n\n> This field is mandatory for natural persons. \n> This\
\ field is required to update the existing `dateOfBirth` that is associated\
\ with this recurring contract."
format: date-time
format: date
type: string
entityType:
x-addedInVersion: '24'
@@ -2102,6 +2127,7 @@ components:
- shopperReference
- recurring
- selectedRecurringDetailReference
type: object
SubmitResponse:
properties:
additionalData:
@@ -2126,6 +2152,7 @@ components:
required:
- pspReference
- resultCode
type: object
securitySchemes:
ApiKeyAuth:
in: header
@@ -2278,7 +2305,7 @@ components:
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING,PAYOUT
contract: PAYOUT
amount:
value: 2000
currency: EUR