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
2025-02-26 10:58:45 +01:00
parent 335f42987a
commit c0af888cfa
6 changed files with 404 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
json/ManagementNotificationService-v3.json
View File

@@ -161,7 +161,7 @@
} }
} }
}, },
"paymentMethod.requestRemoved" : { "paymentMethodRequest.removed" : {
"post" : { "post" : {
"tags" : [ "tags" : [
"Payment method" "Payment method"
@@ -169,7 +169,7 @@
"summary" : "Payment method request removed", "summary" : "Payment method request removed",
"description" : "A request to add a payment method is removed. You must make another request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings).", "description" : "A request to add a payment method is removed. You must make another request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings).",
"x-addedInVersion" : "2", "x-addedInVersion" : "2",
"operationId" : "post-paymentMethod.requestRemoved", "operationId" : "post-paymentMethodRequest.removed",
"x-sortIndex" : 3, "x-sortIndex" : 3,
"x-methodName" : "paymentMethodRequestRemoved", "x-methodName" : "paymentMethodRequestRemoved",
"security" : [ "security" : [
@@ -181,11 +181,6 @@
"requestBody" : { "requestBody" : {
"content" : { "content" : {
"application/json" : { "application/json" : {
"examples" : {
"paymentMethod.requestRemoved" : {
"$ref" : "#/components/examples/post-paymentMethod.requestRemoved-paymentMethod.requestRemoved"
}
},
"schema" : { "schema" : {
"$ref" : "#/components/schemas/PaymentMethodRequestRemovedNotificationRequest" "$ref" : "#/components/schemas/PaymentMethodRequestRemovedNotificationRequest"
} }
@@ -206,7 +201,7 @@
} }
} }
}, },
"paymentMethod.requestScheduledForRemoval" : { "paymentMethodRequest.scheduledForRemoval" : {
"post" : { "post" : {
"tags" : [ "tags" : [
"Payment method" "Payment method"
@@ -214,7 +209,7 @@
"summary" : "Payment method request scheduled for removal", "summary" : "Payment method request scheduled for removal",
"description" : "A request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings) will be removed in 30 days. To make sure the payment method is added, provide the missing [KYC information](https://docs.adyen.com/platforms/onboard-users).", "description" : "A request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings) will be removed in 30 days. To make sure the payment method is added, provide the missing [KYC information](https://docs.adyen.com/platforms/onboard-users).",
"x-addedInVersion" : "2", "x-addedInVersion" : "2",
"operationId" : "post-paymentMethod.requestScheduledForRemoval", "operationId" : "post-paymentMethodRequest.scheduledForRemoval",
"x-sortIndex" : 2, "x-sortIndex" : 2,
"x-methodName" : "paymentMethodRequestScheduledForRemoval", "x-methodName" : "paymentMethodRequestScheduledForRemoval",
"security" : [ "security" : [
@@ -226,11 +221,6 @@
"requestBody" : { "requestBody" : {
"content" : { "content" : {
"application/json" : { "application/json" : {
"examples" : {
"paymentMethod.requestScheduledForRemoval" : {
"$ref" : "#/components/examples/post-paymentMethod.requestScheduledForRemoval-paymentMethod.requestScheduledForRemoval"
}
},
"schema" : { "schema" : {
"$ref" : "#/components/schemas/PaymentMethodScheduledForRemovalNotificationRequest" "$ref" : "#/components/schemas/PaymentMethodScheduledForRemovalNotificationRequest"
} }
@@ -757,7 +747,7 @@
"type" : { "type" : {
"description" : "Type of notification.", "description" : "Type of notification.",
"enum" : [ "enum" : [
"paymentMethod.requestRemoved" "paymentMethodRequest.removed"
], ],
"type" : "string" "type" : "string"
} }
@@ -789,7 +779,7 @@
"type" : { "type" : {
"description" : "Type of notification.", "description" : "Type of notification.",
"enum" : [ "enum" : [
"paymentMethod.requestScheduledForRemoval" "paymentMethodRequest.scheduledForRemoval"
], ],
"type" : "string" "type" : "string"
} }
@@ -1210,38 +1200,6 @@
"environment" : "test", "environment" : "test",
"type" : "paymentMethod.created" "type" : "paymentMethod.created"
} }
},
"post-paymentMethod.requestRemoved-paymentMethod.requestRemoved" : {
"summary" : "Payment method request is removed",
"value" : {
"type" : "paymentMethod.requestRemoved",
"environment" : "devl",
"createdAt" : "2023-06-12T18:59:17+02:00",
"data" : {
"id" : "PM322WP223224M5HJ6PX77BW8",
"storeId" : "TestStore",
"type" : "amex",
"status" : "dataRequired",
"merchantId" : "TestMerchant",
"enabled" : false
}
}
},
"post-paymentMethod.requestScheduledForRemoval-paymentMethod.requestScheduledForRemoval" : {
"summary" : "Payment method request scheduled for removal",
"value" : {
"type" : "paymentMethod.requestScheduledForRemoval",
"environment" : "devl",
"createdAt" : "2023-06-12T19:02:42+02:00",
"data" : {
"id" : "PM322WP223224M5HJ6PX77BW8",
"storeId" : "TestStore",
"type" : "visa",
"status" : "updatesExpected",
"merchantId" : "TestMerchant",
"enabled" : false
}
}
} }
} }
} }

104
json/ManagementService-v1.json
View File

@@ -15190,6 +15190,19 @@
}, },
"type" : "object" "type" : "object"
}, },
"AffirmInfo" : {
"additionalProperties" : false,
"properties" : {
"supportEmail" : {
"description" : "Merchant support email",
"type" : "string"
}
},
"required" : [
"supportEmail"
],
"type" : "object"
},
"AfterpayTouchInfo" : { "AfterpayTouchInfo" : {
"additionalProperties" : false, "additionalProperties" : false,
"properties" : { "properties" : {
@@ -15312,6 +15325,13 @@
}, },
"status" : { "status" : {
"description" : "The status of the app. Possible values: \n* `processing`: the app is being signed and converted to a format that the terminal can handle.\n* `error`: something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n* `invalid`: there is something wrong with the APK file of the app.\n* `ready`: the app has been signed and converted.\n* `archived`: the app is no longer available.", "description" : "The status of the app. Possible values: \n* `processing`: the app is being signed and converted to a format that the terminal can handle.\n* `error`: something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n* `invalid`: there is something wrong with the APK file of the app.\n* `ready`: the app has been signed and converted.\n* `archived`: the app is no longer available.",
"enum" : [
"archived",
"error",
"invalid",
"processing",
"ready"
],
"type" : "string" "type" : "string"
}, },
"versionCode" : { "versionCode" : {
@@ -17979,6 +17999,24 @@
], ],
"type" : "object" "type" : "object"
}, },
"PayToInfo" : {
"additionalProperties" : false,
"properties" : {
"merchantName" : {
"description" : "Merchant name displayed to the shopper in the Agreements",
"type" : "string"
},
"payToPurpose" : {
"description" : "Represents the purpose of the Agreements created, it relates to the business type\n**Allowed values**: mortgage, utility, loan, gambling, retail, salary, personal, government, pension, tax, other",
"type" : "string"
}
},
"required" : [
"merchantName",
"payToPurpose"
],
"type" : "object"
},
"Payment" : { "Payment" : {
"additionalProperties" : false, "additionalProperties" : false,
"properties" : { "properties" : {
@@ -18005,6 +18043,10 @@
"description" : "ACCEL details.", "description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo" "$ref" : "#/components/schemas/AccelInfo"
}, },
"affirm" : {
"description" : "Affirm details.",
"$ref" : "#/components/schemas/AffirmInfo"
},
"afterpayTouch" : { "afterpayTouch" : {
"description" : "Afterpay Touch details.", "description" : "Afterpay Touch details.",
"$ref" : "#/components/schemas/AfterpayTouchInfo" "$ref" : "#/components/schemas/AfterpayTouchInfo"
@@ -18070,6 +18112,10 @@
"description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.", "description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}, },
"eft_directdebit_CA" : {
"description" : "EFT Direct Debit Canada details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : { "eftpos_australia" : {
"description" : "Eftpos Australia details.", "description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -18134,6 +18180,10 @@
"description" : "PayPal details.", "description" : "PayPal details.",
"$ref" : "#/components/schemas/PayPalInfo" "$ref" : "#/components/schemas/PayPalInfo"
}, },
"payto" : {
"description" : "PayTo details.",
"$ref" : "#/components/schemas/PayToInfo"
},
"pulse" : { "pulse" : {
"description" : "PULSE details.", "description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo" "$ref" : "#/components/schemas/PulseInfo"
@@ -18240,11 +18290,13 @@
"items" : { "items" : {
"enum" : [ "enum" : [
"accel", "accel",
"ach",
"affirm", "affirm",
"afterpaytouch", "afterpaytouch",
"alelo", "alelo",
"alipay", "alipay",
"alipay_hk", "alipay_hk",
"alipay_wap",
"amex", "amex",
"applepay", "applepay",
"banese_card", "banese_card",
@@ -18264,6 +18316,7 @@
"directdebit_GB", "directdebit_GB",
"discover", "discover",
"ebanking_FI", "ebanking_FI",
"eft_directdebit_CA",
"eftpos_australia", "eftpos_australia",
"elo", "elo",
"elocredit", "elocredit",
@@ -18294,6 +18347,7 @@
"paynow_pos", "paynow_pos",
"paypal", "paypal",
"payshop", "payshop",
"payto",
"pulse", "pulse",
"sodexo", "sodexo",
"star", "star",
@@ -18331,6 +18385,10 @@
"description" : "ACCEL details.", "description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo" "$ref" : "#/components/schemas/AccelInfo"
}, },
"affirm" : {
"description" : "Affirm details.",
"$ref" : "#/components/schemas/AffirmInfo"
},
"afterpayTouch" : { "afterpayTouch" : {
"description" : "Afterpay Touch details.", "description" : "Afterpay Touch details.",
"$ref" : "#/components/schemas/AfterpayTouchInfo" "$ref" : "#/components/schemas/AfterpayTouchInfo"
@@ -18392,6 +18450,10 @@
"description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.", "description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}, },
"eft_directdebit_CA" : {
"description" : "EFT Direct Debit Canada details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : { "eftpos_australia" : {
"description" : "Eftpos Australia details.", "description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -18448,6 +18510,10 @@
"description" : "PayPal details.", "description" : "PayPal details.",
"$ref" : "#/components/schemas/PayPalInfo" "$ref" : "#/components/schemas/PayPalInfo"
}, },
"payto" : {
"description" : "PayTo details.",
"$ref" : "#/components/schemas/PayToInfo"
},
"pulse" : { "pulse" : {
"description" : "PULSE details.", "description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo" "$ref" : "#/components/schemas/PulseInfo"
@@ -18499,11 +18565,13 @@
"description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).", "description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
"enum" : [ "enum" : [
"accel", "accel",
"ach",
"affirm", "affirm",
"afterpaytouch", "afterpaytouch",
"alelo", "alelo",
"alipay", "alipay",
"alipay_hk", "alipay_hk",
"alipay_wap",
"amex", "amex",
"applepay", "applepay",
"banese_card", "banese_card",
@@ -18523,6 +18591,7 @@
"directdebit_GB", "directdebit_GB",
"discover", "discover",
"ebanking_FI", "ebanking_FI",
"eft_directdebit_CA",
"eftpos_australia", "eftpos_australia",
"elo", "elo",
"elocredit", "elocredit",
@@ -18553,6 +18622,7 @@
"paynow_pos", "paynow_pos",
"paypal", "paypal",
"payshop", "payshop",
"payto",
"pulse", "pulse",
"sodexo", "sodexo",
"star", "star",
@@ -19392,7 +19462,7 @@
"type" : "string" "type" : "string"
}, },
"fundingSource" : { "fundingSource" : {
"description" : "The funding source condition of the payment method (only for cards).\n\nPossible values: **credit**, **debit**, or **ANY**.", "description" : "The funding source of the payment method. This only applies to card transactions.\n\nPossible values:\n* **credit**\n* **debit**\n* **prepaid**\n* **deferred_debit**\n* **charged**\n* **ANY**",
"enum" : [ "enum" : [
"credit", "credit",
"debit", "debit",
@@ -19741,6 +19811,10 @@
"$ref" : "#/components/schemas/Configuration" "$ref" : "#/components/schemas/Configuration"
}, },
"type" : "array" "type" : "array"
},
"excludeGratuityFromSurcharge" : {
"description" : "Exclude the tip amount from the surcharge calculation.",
"type" : "boolean"
} }
}, },
"type" : "object" "type" : "object"
@@ -20764,6 +20838,10 @@
"description" : "Discover details.", "description" : "Discover details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}, },
"eft_directdebit_CA" : {
"description" : "EFT Direct Debit Canada details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : { "eftpos_australia" : {
"description" : "Eftpos Australia details.", "description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -20990,7 +21068,7 @@
"type" : "string" "type" : "string"
}, },
"fundingSource" : { "fundingSource" : {
"description" : "The funding source condition of the payment method (only for cards).\n\nPossible values: **credit**, **debit**, or **ANY**.", "description" : "The funding source of the payment method. This only applies to card transactions.\n\nPossible values:\n* **credit**\n* **debit**\n* **prepaid**\n* **deferred_debit**\n* **charged**\n* **ANY**",
"type" : "string" "type" : "string"
}, },
"paymentMethod" : { "paymentMethod" : {
@@ -23790,7 +23868,7 @@
}, },
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Springfield Shop", "reference" : "Springfield Shop",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -23834,7 +23912,7 @@
}, },
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Springfield Shop", "reference" : "Springfield Shop",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -24857,7 +24935,7 @@
}, },
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Springfield Shop", "reference" : "Springfield Shop",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -25028,7 +25106,7 @@
}, },
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+1312345678",
"reference" : "Springfield Shop", "reference" : "Springfield Shop",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -26490,7 +26568,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -26527,7 +26605,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"splitConfiguration" : { "splitConfiguration" : {
"balanceAccountId" : "BA3227C223222H5HQ2XX77VVH", "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH",
@@ -27064,7 +27142,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -28711,7 +28789,7 @@
"value" : { "value" : {
"description" : "City centre store", "description" : "City centre store",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "1813702551707653", "phoneNumber" : "13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"address" : { "address" : {
"country" : "US", "country" : "US",
@@ -28741,7 +28819,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "1813702551707653", "phoneNumber" : "13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -29161,7 +29239,7 @@
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"description" : "City centre store", "description" : "City centre store",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"address" : { "address" : {
"country" : "US", "country" : "US",
@@ -29191,7 +29269,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"status" : "active", "status" : "active",
"_links" : { "_links" : {

104
json/ManagementService-v3.json
View File

@@ -15587,6 +15587,19 @@
}, },
"type" : "object" "type" : "object"
}, },
"AffirmInfo" : {
"additionalProperties" : false,
"properties" : {
"supportEmail" : {
"description" : "Merchant support email",
"type" : "string"
}
},
"required" : [
"supportEmail"
],
"type" : "object"
},
"AfterpayTouchInfo" : { "AfterpayTouchInfo" : {
"additionalProperties" : false, "additionalProperties" : false,
"properties" : { "properties" : {
@@ -15720,6 +15733,13 @@
}, },
"status" : { "status" : {
"description" : "The status of the app. Possible values: \n* `processing`: the app is being signed and converted to a format that the terminal can handle.\n* `error`: something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n* `invalid`: there is something wrong with the APK file of the app.\n* `ready`: the app has been signed and converted.\n* `archived`: the app is no longer available.", "description" : "The status of the app. Possible values: \n* `processing`: the app is being signed and converted to a format that the terminal can handle.\n* `error`: something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n* `invalid`: there is something wrong with the APK file of the app.\n* `ready`: the app has been signed and converted.\n* `archived`: the app is no longer available.",
"enum" : [
"archived",
"error",
"invalid",
"processing",
"ready"
],
"type" : "string" "type" : "string"
}, },
"versionCode" : { "versionCode" : {
@@ -18399,6 +18419,24 @@
], ],
"type" : "object" "type" : "object"
}, },
"PayToInfo" : {
"additionalProperties" : false,
"properties" : {
"merchantName" : {
"description" : "Merchant name displayed to the shopper in the Agreements",
"type" : "string"
},
"payToPurpose" : {
"description" : "Represents the purpose of the Agreements created, it relates to the business type\n**Allowed values**: mortgage, utility, loan, gambling, retail, salary, personal, government, pension, tax, other",
"type" : "string"
}
},
"required" : [
"merchantName",
"payToPurpose"
],
"type" : "object"
},
"Payment" : { "Payment" : {
"additionalProperties" : false, "additionalProperties" : false,
"properties" : { "properties" : {
@@ -18425,6 +18463,10 @@
"description" : "ACCEL details.", "description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo" "$ref" : "#/components/schemas/AccelInfo"
}, },
"affirm" : {
"description" : "Affirm details.",
"$ref" : "#/components/schemas/AffirmInfo"
},
"afterpayTouch" : { "afterpayTouch" : {
"description" : "Afterpay Touch details.", "description" : "Afterpay Touch details.",
"$ref" : "#/components/schemas/AfterpayTouchInfo" "$ref" : "#/components/schemas/AfterpayTouchInfo"
@@ -18490,6 +18532,10 @@
"description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.", "description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}, },
"eft_directdebit_CA" : {
"description" : "EFT Direct Debit Canada details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : { "eftpos_australia" : {
"description" : "Eftpos Australia details.", "description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -18554,6 +18600,10 @@
"description" : "PayPal details.", "description" : "PayPal details.",
"$ref" : "#/components/schemas/PayPalInfo" "$ref" : "#/components/schemas/PayPalInfo"
}, },
"payto" : {
"description" : "PayTo details.",
"$ref" : "#/components/schemas/PayToInfo"
},
"pulse" : { "pulse" : {
"description" : "PULSE details.", "description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo" "$ref" : "#/components/schemas/PulseInfo"
@@ -18664,11 +18714,13 @@
"items" : { "items" : {
"enum" : [ "enum" : [
"accel", "accel",
"ach",
"affirm", "affirm",
"afterpaytouch", "afterpaytouch",
"alelo", "alelo",
"alipay", "alipay",
"alipay_hk", "alipay_hk",
"alipay_wap",
"amex", "amex",
"applepay", "applepay",
"banese_card", "banese_card",
@@ -18688,6 +18740,7 @@
"directdebit_GB", "directdebit_GB",
"discover", "discover",
"ebanking_FI", "ebanking_FI",
"eft_directdebit_CA",
"eftpos_australia", "eftpos_australia",
"elo", "elo",
"elocredit", "elocredit",
@@ -18718,6 +18771,7 @@
"paynow_pos", "paynow_pos",
"paypal", "paypal",
"payshop", "payshop",
"payto",
"pulse", "pulse",
"sodexo", "sodexo",
"star", "star",
@@ -18755,6 +18809,10 @@
"description" : "ACCEL details.", "description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo" "$ref" : "#/components/schemas/AccelInfo"
}, },
"affirm" : {
"description" : "Affirm details.",
"$ref" : "#/components/schemas/AffirmInfo"
},
"afterpayTouch" : { "afterpayTouch" : {
"description" : "Afterpay Touch details.", "description" : "Afterpay Touch details.",
"$ref" : "#/components/schemas/AfterpayTouchInfo" "$ref" : "#/components/schemas/AfterpayTouchInfo"
@@ -18816,6 +18874,10 @@
"description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.", "description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}, },
"eft_directdebit_CA" : {
"description" : "EFT Direct Debit Canada details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : { "eftpos_australia" : {
"description" : "Eftpos Australia details.", "description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -18872,6 +18934,10 @@
"description" : "PayPal details.", "description" : "PayPal details.",
"$ref" : "#/components/schemas/PayPalInfo" "$ref" : "#/components/schemas/PayPalInfo"
}, },
"payto" : {
"description" : "PayTo details.",
"$ref" : "#/components/schemas/PayToInfo"
},
"pulse" : { "pulse" : {
"description" : "PULSE details.", "description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo" "$ref" : "#/components/schemas/PulseInfo"
@@ -18927,11 +18993,13 @@
"description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).", "description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
"enum" : [ "enum" : [
"accel", "accel",
"ach",
"affirm", "affirm",
"afterpaytouch", "afterpaytouch",
"alelo", "alelo",
"alipay", "alipay",
"alipay_hk", "alipay_hk",
"alipay_wap",
"amex", "amex",
"applepay", "applepay",
"banese_card", "banese_card",
@@ -18951,6 +19019,7 @@
"directdebit_GB", "directdebit_GB",
"discover", "discover",
"ebanking_FI", "ebanking_FI",
"eft_directdebit_CA",
"eftpos_australia", "eftpos_australia",
"elo", "elo",
"elocredit", "elocredit",
@@ -18981,6 +19050,7 @@
"paynow_pos", "paynow_pos",
"paypal", "paypal",
"payshop", "payshop",
"payto",
"pulse", "pulse",
"sodexo", "sodexo",
"star", "star",
@@ -19813,7 +19883,7 @@
"type" : "string" "type" : "string"
}, },
"fundingSource" : { "fundingSource" : {
"description" : "The funding source condition of the payment method (only for cards).\n\nPossible values: **credit**, **debit**, or **ANY**.", "description" : "The funding source of the payment method. This only applies to card transactions.\n\nPossible values:\n* **credit**\n* **debit**\n* **prepaid**\n* **deferred_debit**\n* **charged**\n* **ANY**",
"enum" : [ "enum" : [
"credit", "credit",
"debit", "debit",
@@ -20165,6 +20235,10 @@
"$ref" : "#/components/schemas/Configuration" "$ref" : "#/components/schemas/Configuration"
}, },
"type" : "array" "type" : "array"
},
"excludeGratuityFromSurcharge" : {
"description" : "Exclude the tip amount from the surcharge calculation.",
"type" : "boolean"
} }
}, },
"type" : "object" "type" : "object"
@@ -21301,6 +21375,10 @@
"description" : "Discover details.", "description" : "Discover details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}, },
"eft_directdebit_CA" : {
"description" : "EFT Direct Debit Canada details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : { "eftpos_australia" : {
"description" : "Eftpos Australia details.", "description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo" "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -21535,7 +21613,7 @@
"type" : "string" "type" : "string"
}, },
"fundingSource" : { "fundingSource" : {
"description" : "The funding source condition of the payment method (only for cards).\n\nPossible values: **credit**, **debit**, or **ANY**.", "description" : "The funding source of the payment method. This only applies to card transactions.\n\nPossible values:\n* **credit**\n* **debit**\n* **prepaid**\n* **deferred_debit**\n* **charged**\n* **ANY**",
"type" : "string" "type" : "string"
}, },
"paymentMethod" : { "paymentMethod" : {
@@ -24355,7 +24433,7 @@
}, },
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Springfield Shop", "reference" : "Springfield Shop",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -24399,7 +24477,7 @@
}, },
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Springfield Shop", "reference" : "Springfield Shop",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -25420,7 +25498,7 @@
}, },
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Springfield Shop", "reference" : "Springfield Shop",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -25591,7 +25669,7 @@
}, },
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+1312345678",
"reference" : "Springfield Shop", "reference" : "Springfield Shop",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -27055,7 +27133,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -27092,7 +27170,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"splitConfiguration" : { "splitConfiguration" : {
"balanceAccountId" : "BA3227C223222H5HQ2XX77VVH", "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH",
@@ -27628,7 +27706,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -29271,7 +29349,7 @@
"value" : { "value" : {
"description" : "City centre store", "description" : "City centre store",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "1813702551707653", "phoneNumber" : "13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"address" : { "address" : {
"country" : "US", "country" : "US",
@@ -29301,7 +29379,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "1813702551707653", "phoneNumber" : "13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"status" : "active", "status" : "active",
"_links" : { "_links" : {
@@ -29719,7 +29797,7 @@
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"description" : "City centre store", "description" : "City centre store",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"address" : { "address" : {
"country" : "US", "country" : "US",
@@ -29749,7 +29827,7 @@
"description" : "City centre store", "description" : "City centre store",
"merchantId" : "YOUR_MERCHANT_ACCOUNT_ID", "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
"shopperStatement" : "Springfield Shop", "shopperStatement" : "Springfield Shop",
"phoneNumber" : "+1813702551707653", "phoneNumber" : "+13123456789",
"reference" : "Spring_store_2", "reference" : "Spring_store_2",
"status" : "active", "status" : "active",
"_links" : { "_links" : {

44
yaml/ManagementNotificationService-v3.yaml
View File

@@ -110,7 +110,7 @@ webhooks:
schema: schema:
$ref: '#/components/schemas/PaymentMethodNotificationResponse' $ref: '#/components/schemas/PaymentMethodNotificationResponse'
description: OK - the request has succeeded. description: OK - the request has succeeded.
paymentMethod.requestRemoved: paymentMethodRequest.removed:
post: post:
tags: tags:
- Payment method - Payment method
@@ -118,7 +118,7 @@ webhooks:
description: A request to add a payment method is removed. You must make another description: A request to add a payment method is removed. You must make another
request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings).
x-addedInVersion: '2' x-addedInVersion: '2'
operationId: post-paymentMethod.requestRemoved operationId: post-paymentMethodRequest.removed
x-sortIndex: 3 x-sortIndex: 3
x-methodName: paymentMethodRequestRemoved x-methodName: paymentMethodRequestRemoved
security: security:
@@ -126,9 +126,6 @@ webhooks:
requestBody: requestBody:
content: content:
application/json: application/json:
examples:
paymentMethod.requestRemoved:
$ref: '#/components/examples/post-paymentMethod.requestRemoved-paymentMethod.requestRemoved'
schema: schema:
$ref: '#/components/schemas/PaymentMethodRequestRemovedNotificationRequest' $ref: '#/components/schemas/PaymentMethodRequestRemovedNotificationRequest'
responses: responses:
@@ -138,7 +135,7 @@ webhooks:
schema: schema:
$ref: '#/components/schemas/PaymentMethodNotificationResponse' $ref: '#/components/schemas/PaymentMethodNotificationResponse'
description: OK - the request has succeeded. description: OK - the request has succeeded.
paymentMethod.requestScheduledForRemoval: paymentMethodRequest.scheduledForRemoval:
post: post:
tags: tags:
- Payment method - Payment method
@@ -147,7 +144,7 @@ webhooks:
will be removed in 30 days. To make sure the payment method is added, provide will be removed in 30 days. To make sure the payment method is added, provide
the missing [KYC information](https://docs.adyen.com/platforms/onboard-users). the missing [KYC information](https://docs.adyen.com/platforms/onboard-users).
x-addedInVersion: '2' x-addedInVersion: '2'
operationId: post-paymentMethod.requestScheduledForRemoval operationId: post-paymentMethodRequest.scheduledForRemoval
x-sortIndex: 2 x-sortIndex: 2
x-methodName: paymentMethodRequestScheduledForRemoval x-methodName: paymentMethodRequestScheduledForRemoval
security: security:
@@ -155,9 +152,6 @@ webhooks:
requestBody: requestBody:
content: content:
application/json: application/json:
examples:
paymentMethod.requestScheduledForRemoval:
$ref: '#/components/examples/post-paymentMethod.requestScheduledForRemoval-paymentMethod.requestScheduledForRemoval'
schema: schema:
$ref: '#/components/schemas/PaymentMethodScheduledForRemovalNotificationRequest' $ref: '#/components/schemas/PaymentMethodScheduledForRemovalNotificationRequest'
responses: responses:
@@ -655,7 +649,7 @@ components:
type: type:
description: Type of notification. description: Type of notification.
enum: enum:
- paymentMethod.requestRemoved - paymentMethodRequest.removed
type: string type: string
required: required:
- environment - environment
@@ -682,7 +676,7 @@ components:
type: type:
description: Type of notification. description: Type of notification.
enum: enum:
- paymentMethod.requestScheduledForRemoval - paymentMethodRequest.scheduledForRemoval
type: string type: string
required: required:
- environment - environment
@@ -1000,29 +994,3 @@ components:
type: visa type: visa
environment: test environment: test
type: paymentMethod.created type: paymentMethod.created
post-paymentMethod.requestRemoved-paymentMethod.requestRemoved:
summary: Payment method request is removed
value:
type: paymentMethod.requestRemoved
environment: devl
createdAt: '2023-06-12T18:59:17+02:00'
data:
id: PM322WP223224M5HJ6PX77BW8
storeId: TestStore
type: amex
status: dataRequired
merchantId: TestMerchant
enabled: false
post-paymentMethod.requestScheduledForRemoval-paymentMethod.requestScheduledForRemoval:
summary: Payment method request scheduled for removal
value:
type: paymentMethod.requestScheduledForRemoval
environment: devl
createdAt: '2023-06-12T19:02:42+02:00'
data:
id: PM322WP223224M5HJ6PX77BW8
storeId: TestStore
type: visa
status: updatesExpected
merchantId: TestMerchant
enabled: false

122
yaml/ManagementService-v1.yaml
View File

@@ -10028,6 +10028,15 @@ components:
description: Additional address details, if any. description: Additional address details, if any.
type: string type: string
type: object type: object
AffirmInfo:
additionalProperties: false
properties:
supportEmail:
description: Merchant support email
type: string
required:
- supportEmail
type: object
AfterpayTouchInfo: AfterpayTouchInfo:
additionalProperties: false additionalProperties: false
properties: properties:
@@ -10141,6 +10150,12 @@ components:
* `invalid`: there is something wrong with the APK file of the app.\n\ * `invalid`: there is something wrong with the APK file of the app.\n\
* `ready`: the app has been signed and converted.\n* `archived`: the app\ * `ready`: the app has been signed and converted.\n* `archived`: the app\
\ is no longer available." \ is no longer available."
enum:
- archived
- error
- invalid
- processing
- ready
type: string type: string
versionCode: versionCode:
description: The version number of the app. description: The version number of the app.
@@ -12599,6 +12614,23 @@ components:
- subject - subject
- payerId - payerId
type: object type: object
PayToInfo:
additionalProperties: false
properties:
merchantName:
description: Merchant name displayed to the shopper in the Agreements
type: string
payToPurpose:
description: 'Represents the purpose of the Agreements created, it relates
to the business type
**Allowed values**: mortgage, utility, loan, gambling, retail, salary,
personal, government, pension, tax, other'
type: string
required:
- merchantName
- payToPurpose
type: object
Payment: Payment:
additionalProperties: false additionalProperties: false
properties: properties:
@@ -12621,6 +12653,9 @@ components:
accel: accel:
description: ACCEL details. description: ACCEL details.
$ref: '#/components/schemas/AccelInfo' $ref: '#/components/schemas/AccelInfo'
affirm:
description: Affirm details.
$ref: '#/components/schemas/AffirmInfo'
afterpayTouch: afterpayTouch:
description: Afterpay Touch details. description: Afterpay Touch details.
$ref: '#/components/schemas/AfterpayTouchInfo' $ref: '#/components/schemas/AfterpayTouchInfo'
@@ -12680,6 +12715,9 @@ components:
payment method instead. Discover is automatically requested, together payment method instead. Discover is automatically requested, together
with Diners. with Diners.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
eft_directdebit_CA:
description: EFT Direct Debit Canada details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia: eftpos_australia:
description: Eftpos Australia details. description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -12735,6 +12773,9 @@ components:
paypal: paypal:
description: PayPal details. description: PayPal details.
$ref: '#/components/schemas/PayPalInfo' $ref: '#/components/schemas/PayPalInfo'
payto:
description: PayTo details.
$ref: '#/components/schemas/PayToInfo'
pulse: pulse:
description: PULSE details. description: PULSE details.
$ref: '#/components/schemas/PulseInfo' $ref: '#/components/schemas/PulseInfo'
@@ -12830,11 +12871,13 @@ components:
items: items:
enum: enum:
- accel - accel
- ach
- affirm - affirm
- afterpaytouch - afterpaytouch
- alelo - alelo
- alipay - alipay
- alipay_hk - alipay_hk
- alipay_wap
- amex - amex
- applepay - applepay
- banese_card - banese_card
@@ -12854,6 +12897,7 @@ components:
- directdebit_GB - directdebit_GB
- discover - discover
- ebanking_FI - ebanking_FI
- eft_directdebit_CA
- eftpos_australia - eftpos_australia
- elo - elo
- elocredit - elocredit
@@ -12884,6 +12928,7 @@ components:
- paynow_pos - paynow_pos
- paypal - paypal
- payshop - payshop
- payto
- pulse - pulse
- sodexo - sodexo
- star - star
@@ -12914,6 +12959,9 @@ components:
accel: accel:
description: ACCEL details. description: ACCEL details.
$ref: '#/components/schemas/AccelInfo' $ref: '#/components/schemas/AccelInfo'
affirm:
description: Affirm details.
$ref: '#/components/schemas/AffirmInfo'
afterpayTouch: afterpayTouch:
description: Afterpay Touch details. description: Afterpay Touch details.
$ref: '#/components/schemas/AfterpayTouchInfo' $ref: '#/components/schemas/AfterpayTouchInfo'
@@ -12969,6 +13017,9 @@ components:
payment method instead. Discover is automatically requested, together payment method instead. Discover is automatically requested, together
with Diners. with Diners.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
eft_directdebit_CA:
description: EFT Direct Debit Canada details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia: eftpos_australia:
description: Eftpos Australia details. description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -13017,6 +13068,9 @@ components:
paypal: paypal:
description: PayPal details. description: PayPal details.
$ref: '#/components/schemas/PayPalInfo' $ref: '#/components/schemas/PayPalInfo'
payto:
description: PayTo details.
$ref: '#/components/schemas/PayToInfo'
pulse: pulse:
description: PULSE details. description: PULSE details.
$ref: '#/components/schemas/PulseInfo' $ref: '#/components/schemas/PulseInfo'
@@ -13068,11 +13122,13 @@ components:
description: Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). description: Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).
enum: enum:
- accel - accel
- ach
- affirm - affirm
- afterpaytouch - afterpaytouch
- alelo - alelo
- alipay - alipay
- alipay_hk - alipay_hk
- alipay_wap
- amex - amex
- applepay - applepay
- banese_card - banese_card
@@ -13092,6 +13148,7 @@ components:
- directdebit_GB - directdebit_GB
- discover - discover
- ebanking_FI - ebanking_FI
- eft_directdebit_CA
- eftpos_australia - eftpos_australia
- elo - elo
- elocredit - elocredit
@@ -13122,6 +13179,7 @@ components:
- paynow_pos - paynow_pos
- paypal - paypal
- payshop - payshop
- payto
- pulse - pulse
- sodexo - sodexo
- star - star
@@ -13962,11 +14020,23 @@ components:
Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).' Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).'
type: string type: string
fundingSource: fundingSource:
description: 'The funding source condition of the payment method (only for description: 'The funding source of the payment method. This only applies
cards). to card transactions.
Possible values: **credit**, **debit**, or **ANY**.' Possible values:
* **credit**
* **debit**
* **prepaid**
* **deferred_debit**
* **charged**
* **ANY**'
enum: enum:
- credit - credit
- debit - debit
@@ -14312,6 +14382,9 @@ components:
items: items:
$ref: '#/components/schemas/Configuration' $ref: '#/components/schemas/Configuration'
type: array type: array
excludeGratuityFromSurcharge:
description: Exclude the tip amount from the surcharge calculation.
type: boolean
type: object type: object
SwishInfo: SwishInfo:
additionalProperties: false additionalProperties: false
@@ -15300,6 +15373,9 @@ components:
discover: discover:
description: Discover details. description: Discover details.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
eft_directdebit_CA:
description: EFT Direct Debit Canada details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia: eftpos_australia:
description: Eftpos Australia details. description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -15567,11 +15643,23 @@ components:
Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).' Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).'
type: string type: string
fundingSource: fundingSource:
description: 'The funding source condition of the payment method (only for description: 'The funding source of the payment method. This only applies
cards). to card transactions.
Possible values: **credit**, **debit**, or **ANY**.' Possible values:
* **credit**
* **debit**
* **prepaid**
* **deferred_debit**
* **charged**
* **ANY**'
type: string type: string
paymentMethod: paymentMethod:
description: 'The payment method condition that defines whether the split description: 'The payment method condition that defines whether the split
@@ -17674,7 +17762,7 @@ components:
stateOrProvince: NY stateOrProvince: NY
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Springfield Shop reference: Springfield Shop
status: active status: active
_links: _links:
@@ -17707,7 +17795,7 @@ components:
stateOrProvince: NY stateOrProvince: NY
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Springfield Shop reference: Springfield Shop
status: active status: active
_links: _links:
@@ -18441,7 +18529,7 @@ components:
stateOrProvince: NY stateOrProvince: NY
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Springfield Shop reference: Springfield Shop
status: active status: active
_links: _links:
@@ -18563,7 +18651,7 @@ components:
stateOrProvince: NY stateOrProvince: NY
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
phoneNumber: '+1813702551707653' phoneNumber: '+1312345678'
reference: Springfield Shop reference: Springfield Shop
status: active status: active
_links: _links:
@@ -19664,7 +19752,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
status: active status: active
_links: _links:
@@ -19693,7 +19781,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
splitConfiguration: splitConfiguration:
balanceAccountId: BA3227C223222H5HQ2XX77VVH balanceAccountId: BA3227C223222H5HQ2XX77VVH
@@ -20113,7 +20201,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
status: active status: active
_links: _links:
@@ -21352,7 +21440,7 @@ components:
value: value:
description: City centre store description: City centre store
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '1813702551707653' phoneNumber: '13123456789'
reference: Spring_store_2 reference: Spring_store_2
address: address:
country: US country: US
@@ -21378,7 +21466,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '1813702551707653' phoneNumber: '13123456789'
reference: Spring_store_2 reference: Spring_store_2
status: active status: active
_links: _links:
@@ -21712,7 +21800,7 @@ components:
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
description: City centre store description: City centre store
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
address: address:
country: US country: US
@@ -21738,7 +21826,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
status: active status: active
_links: _links:

122
yaml/ManagementService-v3.yaml
View File

@@ -10286,6 +10286,15 @@ components:
description: Additional address details, if any. description: Additional address details, if any.
type: string type: string
type: object type: object
AffirmInfo:
additionalProperties: false
properties:
supportEmail:
description: Merchant support email
type: string
required:
- supportEmail
type: object
AfterpayTouchInfo: AfterpayTouchInfo:
additionalProperties: false additionalProperties: false
properties: properties:
@@ -10408,6 +10417,12 @@ components:
* `invalid`: there is something wrong with the APK file of the app.\n\ * `invalid`: there is something wrong with the APK file of the app.\n\
* `ready`: the app has been signed and converted.\n* `archived`: the app\ * `ready`: the app has been signed and converted.\n* `archived`: the app\
\ is no longer available." \ is no longer available."
enum:
- archived
- error
- invalid
- processing
- ready
type: string type: string
versionCode: versionCode:
description: The version number of the app. description: The version number of the app.
@@ -12878,6 +12893,23 @@ components:
- subject - subject
- payerId - payerId
type: object type: object
PayToInfo:
additionalProperties: false
properties:
merchantName:
description: Merchant name displayed to the shopper in the Agreements
type: string
payToPurpose:
description: 'Represents the purpose of the Agreements created, it relates
to the business type
**Allowed values**: mortgage, utility, loan, gambling, retail, salary,
personal, government, pension, tax, other'
type: string
required:
- merchantName
- payToPurpose
type: object
Payment: Payment:
additionalProperties: false additionalProperties: false
properties: properties:
@@ -12900,6 +12932,9 @@ components:
accel: accel:
description: ACCEL details. description: ACCEL details.
$ref: '#/components/schemas/AccelInfo' $ref: '#/components/schemas/AccelInfo'
affirm:
description: Affirm details.
$ref: '#/components/schemas/AffirmInfo'
afterpayTouch: afterpayTouch:
description: Afterpay Touch details. description: Afterpay Touch details.
$ref: '#/components/schemas/AfterpayTouchInfo' $ref: '#/components/schemas/AfterpayTouchInfo'
@@ -12959,6 +12994,9 @@ components:
payment method instead. Discover is automatically requested, together payment method instead. Discover is automatically requested, together
with Diners. with Diners.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
eft_directdebit_CA:
description: EFT Direct Debit Canada details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia: eftpos_australia:
description: Eftpos Australia details. description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -13014,6 +13052,9 @@ components:
paypal: paypal:
description: PayPal details. description: PayPal details.
$ref: '#/components/schemas/PayPalInfo' $ref: '#/components/schemas/PayPalInfo'
payto:
description: PayTo details.
$ref: '#/components/schemas/PayToInfo'
pulse: pulse:
description: PULSE details. description: PULSE details.
$ref: '#/components/schemas/PulseInfo' $ref: '#/components/schemas/PulseInfo'
@@ -13112,11 +13153,13 @@ components:
items: items:
enum: enum:
- accel - accel
- ach
- affirm - affirm
- afterpaytouch - afterpaytouch
- alelo - alelo
- alipay - alipay
- alipay_hk - alipay_hk
- alipay_wap
- amex - amex
- applepay - applepay
- banese_card - banese_card
@@ -13136,6 +13179,7 @@ components:
- directdebit_GB - directdebit_GB
- discover - discover
- ebanking_FI - ebanking_FI
- eft_directdebit_CA
- eftpos_australia - eftpos_australia
- elo - elo
- elocredit - elocredit
@@ -13166,6 +13210,7 @@ components:
- paynow_pos - paynow_pos
- paypal - paypal
- payshop - payshop
- payto
- pulse - pulse
- sodexo - sodexo
- star - star
@@ -13196,6 +13241,9 @@ components:
accel: accel:
description: ACCEL details. description: ACCEL details.
$ref: '#/components/schemas/AccelInfo' $ref: '#/components/schemas/AccelInfo'
affirm:
description: Affirm details.
$ref: '#/components/schemas/AffirmInfo'
afterpayTouch: afterpayTouch:
description: Afterpay Touch details. description: Afterpay Touch details.
$ref: '#/components/schemas/AfterpayTouchInfo' $ref: '#/components/schemas/AfterpayTouchInfo'
@@ -13251,6 +13299,9 @@ components:
payment method instead. Discover is automatically requested, together payment method instead. Discover is automatically requested, together
with Diners. with Diners.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
eft_directdebit_CA:
description: EFT Direct Debit Canada details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia: eftpos_australia:
description: Eftpos Australia details. description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -13299,6 +13350,9 @@ components:
paypal: paypal:
description: PayPal details. description: PayPal details.
$ref: '#/components/schemas/PayPalInfo' $ref: '#/components/schemas/PayPalInfo'
payto:
description: PayTo details.
$ref: '#/components/schemas/PayToInfo'
pulse: pulse:
description: PULSE details. description: PULSE details.
$ref: '#/components/schemas/PulseInfo' $ref: '#/components/schemas/PulseInfo'
@@ -13353,11 +13407,13 @@ components:
description: Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). description: Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).
enum: enum:
- accel - accel
- ach
- affirm - affirm
- afterpaytouch - afterpaytouch
- alelo - alelo
- alipay - alipay
- alipay_hk - alipay_hk
- alipay_wap
- amex - amex
- applepay - applepay
- banese_card - banese_card
@@ -13377,6 +13433,7 @@ components:
- directdebit_GB - directdebit_GB
- discover - discover
- ebanking_FI - ebanking_FI
- eft_directdebit_CA
- eftpos_australia - eftpos_australia
- elo - elo
- elocredit - elocredit
@@ -13407,6 +13464,7 @@ components:
- paynow_pos - paynow_pos
- paypal - paypal
- payshop - payshop
- payto
- pulse - pulse
- sodexo - sodexo
- star - star
@@ -14241,11 +14299,23 @@ components:
Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).' Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).'
type: string type: string
fundingSource: fundingSource:
description: 'The funding source condition of the payment method (only for description: 'The funding source of the payment method. This only applies
cards). to card transactions.
Possible values: **credit**, **debit**, or **ANY**.' Possible values:
* **credit**
* **debit**
* **prepaid**
* **deferred_debit**
* **charged**
* **ANY**'
enum: enum:
- credit - credit
- debit - debit
@@ -14645,6 +14715,9 @@ components:
items: items:
$ref: '#/components/schemas/Configuration' $ref: '#/components/schemas/Configuration'
type: array type: array
excludeGratuityFromSurcharge:
description: Exclude the tip amount from the surcharge calculation.
type: boolean
type: object type: object
SwishInfo: SwishInfo:
additionalProperties: false additionalProperties: false
@@ -15737,6 +15810,9 @@ components:
discover: discover:
description: Discover details. description: Discover details.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
eft_directdebit_CA:
description: EFT Direct Debit Canada details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia: eftpos_australia:
description: Eftpos Australia details. description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo' $ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -16012,11 +16088,23 @@ components:
Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).' Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).'
type: string type: string
fundingSource: fundingSource:
description: 'The funding source condition of the payment method (only for description: 'The funding source of the payment method. This only applies
cards). to card transactions.
Possible values: **credit**, **debit**, or **ANY**.' Possible values:
* **credit**
* **debit**
* **prepaid**
* **deferred_debit**
* **charged**
* **ANY**'
type: string type: string
paymentMethod: paymentMethod:
description: 'The payment method condition that defines whether the split description: 'The payment method condition that defines whether the split
@@ -18150,7 +18238,7 @@ components:
stateOrProvince: NY stateOrProvince: NY
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Springfield Shop reference: Springfield Shop
status: active status: active
_links: _links:
@@ -18183,7 +18271,7 @@ components:
stateOrProvince: NY stateOrProvince: NY
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Springfield Shop reference: Springfield Shop
status: active status: active
_links: _links:
@@ -18915,7 +19003,7 @@ components:
stateOrProvince: NY stateOrProvince: NY
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Springfield Shop reference: Springfield Shop
status: active status: active
_links: _links:
@@ -19037,7 +19125,7 @@ components:
stateOrProvince: NY stateOrProvince: NY
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
phoneNumber: '+1813702551707653' phoneNumber: '+1312345678'
reference: Springfield Shop reference: Springfield Shop
status: active status: active
_links: _links:
@@ -20132,7 +20220,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
status: active status: active
_links: _links:
@@ -20161,7 +20249,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
splitConfiguration: splitConfiguration:
balanceAccountId: BA3227C223222H5HQ2XX77VVH balanceAccountId: BA3227C223222H5HQ2XX77VVH
@@ -20580,7 +20668,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
status: active status: active
_links: _links:
@@ -21815,7 +21903,7 @@ components:
value: value:
description: City centre store description: City centre store
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '1813702551707653' phoneNumber: '13123456789'
reference: Spring_store_2 reference: Spring_store_2
address: address:
country: US country: US
@@ -21841,7 +21929,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '1813702551707653' phoneNumber: '13123456789'
reference: Spring_store_2 reference: Spring_store_2
status: active status: active
_links: _links:
@@ -22173,7 +22261,7 @@ components:
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
description: City centre store description: City centre store
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
address: address:
country: US country: US
@@ -22199,7 +22287,7 @@ components:
description: City centre store description: City centre store
merchantId: YOUR_MERCHANT_ACCOUNT_ID merchantId: YOUR_MERCHANT_ACCOUNT_ID
shopperStatement: Springfield Shop shopperStatement: Springfield Shop
phoneNumber: '+1813702551707653' phoneNumber: '+13123456789'
reference: Spring_store_2 reference: Spring_store_2
status: active status: active
_links: _links: