spec release

This commit is contained in:
Adyen Automation
2023-03-13 10:33:06 +00:00
parent 82fd94181e
commit a6e13ff3cc
12 changed files with 390 additions and 138 deletions

View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Recurring API",
"description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring 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/Recurring/v25/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](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/Recurring/v25/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2023-02-16T11:25:28Z",
"x-timestamp" : "2023-02-20T18:23:08Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -471,7 +471,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -490,7 +491,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -532,7 +534,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -588,7 +591,8 @@
"required" : [
"expiryYear",
"holderName"
]
],
"type" : "object"
},
"DisableRequest" : {
"properties" : {
@@ -613,7 +617,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"DisableResult" : {
"properties" : {
@@ -621,7 +626,8 @@
"description" : "Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].",
"type" : "string"
}
}
},
"type" : "object"
},
"Name" : {
"properties" : {
@@ -637,7 +643,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"NotifyShopperRequest" : {
"properties" : {
@@ -683,7 +690,8 @@
"shopperReference",
"amount",
"reference"
]
],
"type" : "object"
},
"NotifyShopperResult" : {
"properties" : {
@@ -715,7 +723,8 @@
"description" : "This is the recurringDetailReference returned in the response when token was created",
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -741,7 +750,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"RecurringDetail" : {
"properties" : {
@@ -829,7 +839,8 @@
"required" : [
"recurringDetailReference",
"variant"
]
],
"type" : "object"
},
"RecurringDetailsRequest" : {
"properties" : {
@@ -849,7 +860,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"RecurringDetailsResult" : {
"properties" : {
@@ -873,7 +885,8 @@
"description" : "The reference you use to uniquely identify the shopper (e.g. user ID or account ID).",
"type" : "string"
}
}
},
"type" : "object"
},
"ScheduleAccountUpdaterRequest" : {
"properties" : {
@@ -908,7 +921,8 @@
"required" : [
"merchantAccount",
"reference"
]
],
"type" : "object"
},
"ScheduleAccountUpdaterResult" : {
"properties" : {
@@ -924,7 +938,8 @@
"required" : [
"pspReference",
"result"
]
],
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -949,7 +964,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"TokenDetails" : {
"properties" : {
@@ -962,7 +978,8 @@
"tokenDataType" : {
"type" : "string"
}
}
},
"type" : "object"
}
},
"securitySchemes" : {

View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Recurring API",
"description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring 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/Recurring/v30/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](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/Recurring/v30/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2023-02-16T11:25:28Z",
"x-timestamp" : "2023-02-20T18:23:08Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -471,7 +471,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -490,7 +491,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -532,7 +534,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -588,7 +591,8 @@
"required" : [
"expiryYear",
"holderName"
]
],
"type" : "object"
},
"DisableRequest" : {
"properties" : {
@@ -613,7 +617,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"DisableResult" : {
"properties" : {
@@ -621,7 +626,8 @@
"description" : "Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].",
"type" : "string"
}
}
},
"type" : "object"
},
"Name" : {
"properties" : {
@@ -637,7 +643,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"NotifyShopperRequest" : {
"properties" : {
@@ -683,7 +690,8 @@
"shopperReference",
"amount",
"reference"
]
],
"type" : "object"
},
"NotifyShopperResult" : {
"properties" : {
@@ -715,7 +723,8 @@
"description" : "This is the recurringDetailReference returned in the response when token was created",
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -741,7 +750,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"RecurringDetail" : {
"properties" : {
@@ -829,7 +839,8 @@
"required" : [
"recurringDetailReference",
"variant"
]
],
"type" : "object"
},
"RecurringDetailsRequest" : {
"properties" : {
@@ -849,7 +860,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"RecurringDetailsResult" : {
"properties" : {
@@ -873,7 +885,8 @@
"description" : "The reference you use to uniquely identify the shopper (e.g. user ID or account ID).",
"type" : "string"
}
}
},
"type" : "object"
},
"ScheduleAccountUpdaterRequest" : {
"properties" : {
@@ -908,7 +921,8 @@
"required" : [
"merchantAccount",
"reference"
]
],
"type" : "object"
},
"ScheduleAccountUpdaterResult" : {
"properties" : {
@@ -924,7 +938,8 @@
"required" : [
"pspReference",
"result"
]
],
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -949,7 +964,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"TokenDetails" : {
"properties" : {
@@ -962,7 +978,8 @@
"tokenDataType" : {
"type" : "string"
}
}
},
"type" : "object"
}
},
"securitySchemes" : {

View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Recurring API",
"description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring 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/Recurring/v40/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](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/Recurring/v40/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2023-02-16T11:25:28Z",
"x-timestamp" : "2023-02-20T18:23:08Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -566,7 +566,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -585,7 +586,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -627,7 +629,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -683,7 +686,8 @@
"required" : [
"expiryYear",
"holderName"
]
],
"type" : "object"
},
"CreatePermitRequest" : {
"properties" : {
@@ -712,7 +716,8 @@
"shopperReference",
"recurringDetailReference",
"permits"
]
],
"type" : "object"
},
"CreatePermitResult" : {
"properties" : {
@@ -727,7 +732,8 @@
"description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.",
"type" : "string"
}
}
},
"type" : "object"
},
"DisableRequest" : {
"properties" : {
@@ -752,7 +758,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"DisableResult" : {
"properties" : {
@@ -760,7 +767,8 @@
"description" : "Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].",
"type" : "string"
}
}
},
"type" : "object"
},
"Name" : {
"properties" : {
@@ -776,7 +784,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"NotifyShopperRequest" : {
"properties" : {
@@ -822,7 +831,8 @@
"shopperReference",
"amount",
"reference"
]
],
"type" : "object"
},
"NotifyShopperResult" : {
"properties" : {
@@ -854,7 +864,8 @@
"description" : "This is the recurringDetailReference returned in the response when token was created",
"type" : "string"
}
}
},
"type" : "object"
},
"Permit" : {
"properties" : {
@@ -879,7 +890,8 @@
"format" : "date-time",
"type" : "string"
}
}
},
"type" : "object"
},
"PermitRestriction" : {
"properties" : {
@@ -895,7 +907,8 @@
"description" : "Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"PermitResult" : {
"properties" : {
@@ -909,7 +922,8 @@
"description" : "The permit token which is used to make payments by the partner company.",
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -946,7 +960,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"RecurringDetail" : {
"properties" : {
@@ -1034,7 +1049,8 @@
"required" : [
"recurringDetailReference",
"variant"
]
],
"type" : "object"
},
"RecurringDetailsRequest" : {
"properties" : {
@@ -1054,7 +1070,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"RecurringDetailsResult" : {
"properties" : {
@@ -1078,7 +1095,8 @@
"description" : "The reference you use to uniquely identify the shopper (e.g. user ID or account ID).",
"type" : "string"
}
}
},
"type" : "object"
},
"ScheduleAccountUpdaterRequest" : {
"properties" : {
@@ -1113,7 +1131,8 @@
"required" : [
"merchantAccount",
"reference"
]
],
"type" : "object"
},
"ScheduleAccountUpdaterResult" : {
"properties" : {
@@ -1129,7 +1148,8 @@
"required" : [
"pspReference",
"result"
]
],
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1154,7 +1174,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"TokenDetails" : {
"properties" : {
@@ -1167,7 +1188,8 @@
"tokenDataType" : {
"type" : "string"
}
}
},
"type" : "object"
}
},
"securitySchemes" : {

View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Recurring API",
"description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring 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/Recurring/v49/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](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/Recurring/v49/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2023-02-16T11:25:28Z",
"x-timestamp" : "2023-02-20T18:23:08Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -566,7 +566,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -585,7 +586,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -627,7 +629,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -683,7 +686,8 @@
"required" : [
"expiryYear",
"holderName"
]
],
"type" : "object"
},
"CreatePermitRequest" : {
"properties" : {
@@ -712,7 +716,8 @@
"shopperReference",
"recurringDetailReference",
"permits"
]
],
"type" : "object"
},
"CreatePermitResult" : {
"properties" : {
@@ -727,7 +732,8 @@
"description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.",
"type" : "string"
}
}
},
"type" : "object"
},
"DisableRequest" : {
"properties" : {
@@ -752,7 +758,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"DisableResult" : {
"properties" : {
@@ -760,7 +767,8 @@
"description" : "Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].",
"type" : "string"
}
}
},
"type" : "object"
},
"Name" : {
"properties" : {
@@ -776,7 +784,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"NotifyShopperRequest" : {
"properties" : {
@@ -822,7 +831,8 @@
"shopperReference",
"amount",
"reference"
]
],
"type" : "object"
},
"NotifyShopperResult" : {
"properties" : {
@@ -854,7 +864,8 @@
"description" : "This is the recurringDetailReference returned in the response when token was created",
"type" : "string"
}
}
},
"type" : "object"
},
"Permit" : {
"properties" : {
@@ -879,7 +890,8 @@
"format" : "date-time",
"type" : "string"
}
}
},
"type" : "object"
},
"PermitRestriction" : {
"properties" : {
@@ -895,7 +907,8 @@
"description" : "Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"PermitResult" : {
"properties" : {
@@ -909,7 +922,8 @@
"description" : "The permit token which is used to make payments by the partner company.",
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -946,7 +960,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"RecurringDetail" : {
"properties" : {
@@ -1034,7 +1049,8 @@
"required" : [
"recurringDetailReference",
"variant"
]
],
"type" : "object"
},
"RecurringDetailsRequest" : {
"properties" : {
@@ -1054,7 +1070,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"RecurringDetailsResult" : {
"properties" : {
@@ -1078,7 +1095,8 @@
"description" : "The reference you use to uniquely identify the shopper (e.g. user ID or account ID).",
"type" : "string"
}
}
},
"type" : "object"
},
"ScheduleAccountUpdaterRequest" : {
"properties" : {
@@ -1113,7 +1131,8 @@
"required" : [
"merchantAccount",
"reference"
]
],
"type" : "object"
},
"ScheduleAccountUpdaterResult" : {
"properties" : {
@@ -1129,7 +1148,8 @@
"required" : [
"pspReference",
"result"
]
],
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1162,7 +1182,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"TokenDetails" : {
"properties" : {
@@ -1175,7 +1196,8 @@
"tokenDataType" : {
"type" : "string"
}
}
},
"type" : "object"
}
},
"securitySchemes" : {

View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Recurring API",
"description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring 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/Recurring/v67/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](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/Recurring/v67/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2023-02-16T11:25:28Z",
"x-timestamp" : "2023-02-20T18:23:08Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -661,7 +661,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -680,7 +681,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -722,7 +724,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -778,7 +781,8 @@
"required" : [
"expiryYear",
"holderName"
]
],
"type" : "object"
},
"CreatePermitRequest" : {
"properties" : {
@@ -807,7 +811,8 @@
"shopperReference",
"recurringDetailReference",
"permits"
]
],
"type" : "object"
},
"CreatePermitResult" : {
"properties" : {
@@ -822,7 +827,8 @@
"description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.",
"type" : "string"
}
}
},
"type" : "object"
},
"DisablePermitRequest" : {
"properties" : {
@@ -838,7 +844,8 @@
"required" : [
"merchantAccount",
"token"
]
],
"type" : "object"
},
"DisablePermitResult" : {
"properties" : {
@@ -850,7 +857,8 @@
"description" : "Status of the disable request.",
"type" : "string"
}
}
},
"type" : "object"
},
"DisableRequest" : {
"properties" : {
@@ -875,7 +883,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"DisableResult" : {
"properties" : {
@@ -883,7 +892,8 @@
"description" : "Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].",
"type" : "string"
}
}
},
"type" : "object"
},
"Name" : {
"properties" : {
@@ -899,7 +909,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"NotifyShopperRequest" : {
"properties" : {
@@ -945,7 +956,8 @@
"shopperReference",
"amount",
"reference"
]
],
"type" : "object"
},
"NotifyShopperResult" : {
"properties" : {
@@ -977,7 +989,8 @@
"description" : "This is the recurringDetailReference returned in the response when token was created",
"type" : "string"
}
}
},
"type" : "object"
},
"Permit" : {
"properties" : {
@@ -1002,7 +1015,8 @@
"format" : "date-time",
"type" : "string"
}
}
},
"type" : "object"
},
"PermitRestriction" : {
"properties" : {
@@ -1018,7 +1032,8 @@
"description" : "Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"PermitResult" : {
"properties" : {
@@ -1032,7 +1047,8 @@
"description" : "The permit token which is used to make payments by the partner company.",
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1069,7 +1085,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"RecurringDetail" : {
"properties" : {
@@ -1157,7 +1174,8 @@
"required" : [
"recurringDetailReference",
"variant"
]
],
"type" : "object"
},
"RecurringDetailsRequest" : {
"properties" : {
@@ -1177,7 +1195,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"RecurringDetailsResult" : {
"properties" : {
@@ -1201,7 +1220,8 @@
"description" : "The reference you use to uniquely identify the shopper (e.g. user ID or account ID).",
"type" : "string"
}
}
},
"type" : "object"
},
"ScheduleAccountUpdaterRequest" : {
"properties" : {
@@ -1236,7 +1256,8 @@
"required" : [
"merchantAccount",
"reference"
]
],
"type" : "object"
},
"ScheduleAccountUpdaterResult" : {
"properties" : {
@@ -1252,7 +1273,8 @@
"required" : [
"pspReference",
"result"
]
],
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1285,7 +1307,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"TokenDetails" : {
"properties" : {
@@ -1298,7 +1321,8 @@
"tokenDataType" : {
"type" : "string"
}
}
},
"type" : "object"
}
},
"securitySchemes" : {

View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Recurring API",
"description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring 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/Recurring/v68/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](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/Recurring/v68/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2023-02-16T11:25:28Z",
"x-timestamp" : "2023-02-20T18:23:08Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -661,7 +661,8 @@
"city",
"postalCode",
"country"
]
],
"type" : "object"
},
"Amount" : {
"properties" : {
@@ -680,7 +681,8 @@
"required" : [
"value",
"currency"
]
],
"type" : "object"
},
"BankAccount" : {
"properties" : {
@@ -722,7 +724,8 @@
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"type" : "object"
},
"Card" : {
"properties" : {
@@ -778,7 +781,8 @@
"required" : [
"expiryYear",
"holderName"
]
],
"type" : "object"
},
"CreatePermitRequest" : {
"properties" : {
@@ -807,7 +811,8 @@
"shopperReference",
"recurringDetailReference",
"permits"
]
],
"type" : "object"
},
"CreatePermitResult" : {
"properties" : {
@@ -822,7 +827,8 @@
"description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.",
"type" : "string"
}
}
},
"type" : "object"
},
"DisablePermitRequest" : {
"properties" : {
@@ -838,7 +844,8 @@
"required" : [
"merchantAccount",
"token"
]
],
"type" : "object"
},
"DisablePermitResult" : {
"properties" : {
@@ -850,7 +857,8 @@
"description" : "Status of the disable request.",
"type" : "string"
}
}
},
"type" : "object"
},
"DisableRequest" : {
"properties" : {
@@ -875,7 +883,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"DisableResult" : {
"properties" : {
@@ -883,7 +892,8 @@
"description" : "Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].",
"type" : "string"
}
}
},
"type" : "object"
},
"Name" : {
"properties" : {
@@ -899,7 +909,8 @@
"required" : [
"firstName",
"lastName"
]
],
"type" : "object"
},
"NotifyShopperRequest" : {
"properties" : {
@@ -945,7 +956,8 @@
"shopperReference",
"amount",
"reference"
]
],
"type" : "object"
},
"NotifyShopperResult" : {
"properties" : {
@@ -977,7 +989,8 @@
"description" : "This is the recurringDetailReference returned in the response when token was created",
"type" : "string"
}
}
},
"type" : "object"
},
"Permit" : {
"properties" : {
@@ -1002,7 +1015,8 @@
"format" : "date-time",
"type" : "string"
}
}
},
"type" : "object"
},
"PermitRestriction" : {
"properties" : {
@@ -1018,7 +1032,8 @@
"description" : "Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed.",
"type" : "boolean"
}
}
},
"type" : "object"
},
"PermitResult" : {
"properties" : {
@@ -1032,7 +1047,8 @@
"description" : "The permit token which is used to make payments by the partner company.",
"type" : "string"
}
}
},
"type" : "object"
},
"Recurring" : {
"properties" : {
@@ -1069,7 +1085,8 @@
],
"type" : "string"
}
}
},
"type" : "object"
},
"RecurringDetail" : {
"properties" : {
@@ -1162,7 +1179,8 @@
"required" : [
"recurringDetailReference",
"variant"
]
],
"type" : "object"
},
"RecurringDetailsRequest" : {
"properties" : {
@@ -1182,7 +1200,8 @@
"required" : [
"merchantAccount",
"shopperReference"
]
],
"type" : "object"
},
"RecurringDetailsResult" : {
"properties" : {
@@ -1206,7 +1225,8 @@
"description" : "The reference you use to uniquely identify the shopper (e.g. user ID or account ID).",
"type" : "string"
}
}
},
"type" : "object"
},
"ScheduleAccountUpdaterRequest" : {
"properties" : {
@@ -1241,7 +1261,8 @@
"required" : [
"merchantAccount",
"reference"
]
],
"type" : "object"
},
"ScheduleAccountUpdaterResult" : {
"properties" : {
@@ -1257,7 +1278,8 @@
"required" : [
"pspReference",
"result"
]
],
"type" : "object"
},
"ServiceError" : {
"properties" : {
@@ -1290,7 +1312,8 @@
"format" : "int32",
"type" : "integer"
}
}
},
"type" : "object"
},
"TokenDetails" : {
"properties" : {
@@ -1303,7 +1326,8 @@
"tokenDataType" : {
"type" : "string"
}
}
},
"type" : "object"
}
},
"securitySchemes" : {

View File

@@ -24,7 +24,7 @@ info:
\ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v25/disable\n\
```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\
\ **API URLs** > **Prefix**."
x-timestamp: '2023-02-16T11:25:28Z'
x-timestamp: '2023-02-20T18:23:08Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -333,6 +333,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -347,6 +348,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -395,6 +397,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -461,6 +464,7 @@ components:
required:
- expiryYear
- holderName
type: object
DisableRequest:
properties:
contract:
@@ -499,12 +503,14 @@ components:
required:
- merchantAccount
- shopperReference
type: object
DisableResult:
properties:
response:
description: Depending on whether a specific recurring detail was in the
request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].
type: string
type: object
Name:
properties:
firstName:
@@ -516,6 +522,7 @@ components:
required:
- firstName
- lastName
type: object
NotifyShopperRequest:
properties:
amount:
@@ -561,6 +568,7 @@ components:
- shopperReference
- amount
- reference
type: object
NotifyShopperResult:
properties:
displayedReference:
@@ -586,6 +594,7 @@ components:
description: This is the recurringDetailReference returned in the response
when token was created
type: string
type: object
Recurring:
properties:
contract:
@@ -612,6 +621,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
RecurringDetail:
properties:
additionalData:
@@ -694,6 +704,7 @@ components:
required:
- recurringDetailReference
- variant
type: object
RecurringDetailsRequest:
properties:
merchantAccount:
@@ -719,6 +730,7 @@ components:
required:
- merchantAccount
- shopperReference
type: object
RecurringDetailsResult:
properties:
creationDate:
@@ -737,6 +749,7 @@ components:
description: The reference you use to uniquely identify the shopper (e.g.
user ID or account ID).
type: string
type: object
ScheduleAccountUpdaterRequest:
properties:
additionalData:
@@ -773,6 +786,7 @@ components:
required:
- merchantAccount
- reference
type: object
ScheduleAccountUpdaterResult:
properties:
pspReference:
@@ -788,6 +802,7 @@ components:
required:
- pspReference
- result
type: object
ServiceError:
properties:
errorCode:
@@ -806,6 +821,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
TokenDetails:
properties:
tokenData:
@@ -814,6 +830,7 @@ components:
type: object
tokenDataType:
type: string
type: object
securitySchemes:
ApiKeyAuth:
in: header

View File

@@ -24,7 +24,7 @@ info:
\ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v30/disable\n\
```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\
\ **API URLs** > **Prefix**."
x-timestamp: '2023-02-16T11:25:28Z'
x-timestamp: '2023-02-20T18:23:08Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -333,6 +333,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -347,6 +348,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -395,6 +397,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -461,6 +464,7 @@ components:
required:
- expiryYear
- holderName
type: object
DisableRequest:
properties:
contract:
@@ -499,12 +503,14 @@ components:
required:
- merchantAccount
- shopperReference
type: object
DisableResult:
properties:
response:
description: Depending on whether a specific recurring detail was in the
request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].
type: string
type: object
Name:
properties:
firstName:
@@ -516,6 +522,7 @@ components:
required:
- firstName
- lastName
type: object
NotifyShopperRequest:
properties:
amount:
@@ -561,6 +568,7 @@ components:
- shopperReference
- amount
- reference
type: object
NotifyShopperResult:
properties:
displayedReference:
@@ -586,6 +594,7 @@ components:
description: This is the recurringDetailReference returned in the response
when token was created
type: string
type: object
Recurring:
properties:
contract:
@@ -612,6 +621,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
RecurringDetail:
properties:
additionalData:
@@ -694,6 +704,7 @@ components:
required:
- recurringDetailReference
- variant
type: object
RecurringDetailsRequest:
properties:
merchantAccount:
@@ -719,6 +730,7 @@ components:
required:
- merchantAccount
- shopperReference
type: object
RecurringDetailsResult:
properties:
creationDate:
@@ -737,6 +749,7 @@ components:
description: The reference you use to uniquely identify the shopper (e.g.
user ID or account ID).
type: string
type: object
ScheduleAccountUpdaterRequest:
properties:
additionalData:
@@ -773,6 +786,7 @@ components:
required:
- merchantAccount
- reference
type: object
ScheduleAccountUpdaterResult:
properties:
pspReference:
@@ -788,6 +802,7 @@ components:
required:
- pspReference
- result
type: object
ServiceError:
properties:
errorCode:
@@ -806,6 +821,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
TokenDetails:
properties:
tokenData:
@@ -814,6 +830,7 @@ components:
type: object
tokenDataType:
type: string
type: object
securitySchemes:
ApiKeyAuth:
in: header

View File

@@ -24,7 +24,7 @@ info:
\ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v40/disable\n\
```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\
\ **API URLs** > **Prefix**."
x-timestamp: '2023-02-16T11:25:28Z'
x-timestamp: '2023-02-20T18:23:08Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -390,6 +390,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -404,6 +405,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -452,6 +454,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -518,6 +521,7 @@ components:
required:
- expiryYear
- holderName
type: object
CreatePermitRequest:
properties:
merchantAccount:
@@ -541,6 +545,7 @@ components:
- shopperReference
- recurringDetailReference
- permits
type: object
CreatePermitResult:
properties:
permitResultList:
@@ -552,6 +557,7 @@ components:
description: A unique reference associated with the request. This value
is globally unique; quote it when communicating with us about this request.
type: string
type: object
DisableRequest:
properties:
contract:
@@ -590,12 +596,14 @@ components:
required:
- merchantAccount
- shopperReference
type: object
DisableResult:
properties:
response:
description: Depending on whether a specific recurring detail was in the
request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].
type: string
type: object
Name:
properties:
firstName:
@@ -607,6 +615,7 @@ components:
required:
- firstName
- lastName
type: object
NotifyShopperRequest:
properties:
amount:
@@ -652,6 +661,7 @@ components:
- shopperReference
- amount
- reference
type: object
NotifyShopperResult:
properties:
displayedReference:
@@ -677,6 +687,7 @@ components:
description: This is the recurringDetailReference returned in the response
when token was created
type: string
type: object
Permit:
properties:
partnerId:
@@ -697,6 +708,7 @@ components:
description: The expiry date for this permit.
format: date-time
type: string
type: object
PermitRestriction:
properties:
maxAmount:
@@ -711,6 +723,7 @@ components:
description: Only a single payment can be made using this permit if set
to true, otherwise multiple payments are allowed.
type: boolean
type: object
PermitResult:
properties:
resultKey:
@@ -722,6 +735,7 @@ components:
description: The permit token which is used to make payments by the partner
company.
type: string
type: object
Recurring:
properties:
contract:
@@ -759,6 +773,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
RecurringDetail:
properties:
additionalData:
@@ -841,6 +856,7 @@ components:
required:
- recurringDetailReference
- variant
type: object
RecurringDetailsRequest:
properties:
merchantAccount:
@@ -866,6 +882,7 @@ components:
required:
- merchantAccount
- shopperReference
type: object
RecurringDetailsResult:
properties:
creationDate:
@@ -884,6 +901,7 @@ components:
description: The reference you use to uniquely identify the shopper (e.g.
user ID or account ID).
type: string
type: object
ScheduleAccountUpdaterRequest:
properties:
additionalData:
@@ -920,6 +938,7 @@ components:
required:
- merchantAccount
- reference
type: object
ScheduleAccountUpdaterResult:
properties:
pspReference:
@@ -935,6 +954,7 @@ components:
required:
- pspReference
- result
type: object
ServiceError:
properties:
errorCode:
@@ -953,6 +973,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
TokenDetails:
properties:
tokenData:
@@ -961,6 +982,7 @@ components:
type: object
tokenDataType:
type: string
type: object
securitySchemes:
ApiKeyAuth:
in: header

View File

@@ -24,7 +24,7 @@ info:
\ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v49/disable\n\
```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\
\ **API URLs** > **Prefix**."
x-timestamp: '2023-02-16T11:25:28Z'
x-timestamp: '2023-02-20T18:23:08Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -390,6 +390,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -404,6 +405,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -452,6 +454,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -518,6 +521,7 @@ components:
required:
- expiryYear
- holderName
type: object
CreatePermitRequest:
properties:
merchantAccount:
@@ -541,6 +545,7 @@ components:
- shopperReference
- recurringDetailReference
- permits
type: object
CreatePermitResult:
properties:
permitResultList:
@@ -552,6 +557,7 @@ components:
description: A unique reference associated with the request. This value
is globally unique; quote it when communicating with us about this request.
type: string
type: object
DisableRequest:
properties:
contract:
@@ -590,12 +596,14 @@ components:
required:
- merchantAccount
- shopperReference
type: object
DisableResult:
properties:
response:
description: Depending on whether a specific recurring detail was in the
request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].
type: string
type: object
Name:
properties:
firstName:
@@ -607,6 +615,7 @@ components:
required:
- firstName
- lastName
type: object
NotifyShopperRequest:
properties:
amount:
@@ -652,6 +661,7 @@ components:
- shopperReference
- amount
- reference
type: object
NotifyShopperResult:
properties:
displayedReference:
@@ -677,6 +687,7 @@ components:
description: This is the recurringDetailReference returned in the response
when token was created
type: string
type: object
Permit:
properties:
partnerId:
@@ -697,6 +708,7 @@ components:
description: The expiry date for this permit.
format: date-time
type: string
type: object
PermitRestriction:
properties:
maxAmount:
@@ -711,6 +723,7 @@ components:
description: Only a single payment can be made using this permit if set
to true, otherwise multiple payments are allowed.
type: boolean
type: object
PermitResult:
properties:
resultKey:
@@ -722,6 +735,7 @@ components:
description: The permit token which is used to make payments by the partner
company.
type: string
type: object
Recurring:
properties:
contract:
@@ -759,6 +773,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
RecurringDetail:
properties:
additionalData:
@@ -841,6 +856,7 @@ components:
required:
- recurringDetailReference
- variant
type: object
RecurringDetailsRequest:
properties:
merchantAccount:
@@ -866,6 +882,7 @@ components:
required:
- merchantAccount
- shopperReference
type: object
RecurringDetailsResult:
properties:
creationDate:
@@ -884,6 +901,7 @@ components:
description: The reference you use to uniquely identify the shopper (e.g.
user ID or account ID).
type: string
type: object
ScheduleAccountUpdaterRequest:
properties:
additionalData:
@@ -920,6 +938,7 @@ components:
required:
- merchantAccount
- reference
type: object
ScheduleAccountUpdaterResult:
properties:
pspReference:
@@ -935,6 +954,7 @@ components:
required:
- pspReference
- result
type: object
ServiceError:
properties:
additionalData:
@@ -961,6 +981,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
TokenDetails:
properties:
tokenData:
@@ -969,6 +990,7 @@ components:
type: object
tokenDataType:
type: string
type: object
securitySchemes:
ApiKeyAuth:
in: header

View File

@@ -24,7 +24,7 @@ info:
\ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v67/disable\n\
```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\
\ **API URLs** > **Prefix**."
x-timestamp: '2023-02-16T11:25:28Z'
x-timestamp: '2023-02-20T18:23:08Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -446,6 +446,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -460,6 +461,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -508,6 +510,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -574,6 +577,7 @@ components:
required:
- expiryYear
- holderName
type: object
CreatePermitRequest:
properties:
merchantAccount:
@@ -597,6 +601,7 @@ components:
- shopperReference
- recurringDetailReference
- permits
type: object
CreatePermitResult:
properties:
permitResultList:
@@ -608,6 +613,7 @@ components:
description: A unique reference associated with the request. This value
is globally unique; quote it when communicating with us about this request.
type: string
type: object
DisablePermitRequest:
properties:
merchantAccount:
@@ -620,6 +626,7 @@ components:
required:
- merchantAccount
- token
type: object
DisablePermitResult:
properties:
pspReference:
@@ -629,6 +636,7 @@ components:
status:
description: Status of the disable request.
type: string
type: object
DisableRequest:
properties:
contract:
@@ -667,12 +675,14 @@ components:
required:
- merchantAccount
- shopperReference
type: object
DisableResult:
properties:
response:
description: Depending on whether a specific recurring detail was in the
request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].
type: string
type: object
Name:
properties:
firstName:
@@ -684,6 +694,7 @@ components:
required:
- firstName
- lastName
type: object
NotifyShopperRequest:
properties:
amount:
@@ -729,6 +740,7 @@ components:
- shopperReference
- amount
- reference
type: object
NotifyShopperResult:
properties:
displayedReference:
@@ -754,6 +766,7 @@ components:
description: This is the recurringDetailReference returned in the response
when token was created
type: string
type: object
Permit:
properties:
partnerId:
@@ -774,6 +787,7 @@ components:
description: The expiry date for this permit.
format: date-time
type: string
type: object
PermitRestriction:
properties:
maxAmount:
@@ -788,6 +802,7 @@ components:
description: Only a single payment can be made using this permit if set
to true, otherwise multiple payments are allowed.
type: boolean
type: object
PermitResult:
properties:
resultKey:
@@ -799,6 +814,7 @@ components:
description: The permit token which is used to make payments by the partner
company.
type: string
type: object
Recurring:
properties:
contract:
@@ -836,6 +852,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
RecurringDetail:
properties:
additionalData:
@@ -918,6 +935,7 @@ components:
required:
- recurringDetailReference
- variant
type: object
RecurringDetailsRequest:
properties:
merchantAccount:
@@ -943,6 +961,7 @@ components:
required:
- merchantAccount
- shopperReference
type: object
RecurringDetailsResult:
properties:
creationDate:
@@ -961,6 +980,7 @@ components:
description: The reference you use to uniquely identify the shopper (e.g.
user ID or account ID).
type: string
type: object
ScheduleAccountUpdaterRequest:
properties:
additionalData:
@@ -997,6 +1017,7 @@ components:
required:
- merchantAccount
- reference
type: object
ScheduleAccountUpdaterResult:
properties:
pspReference:
@@ -1012,6 +1033,7 @@ components:
required:
- pspReference
- result
type: object
ServiceError:
properties:
additionalData:
@@ -1038,6 +1060,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
TokenDetails:
properties:
tokenData:
@@ -1046,6 +1069,7 @@ components:
type: object
tokenDataType:
type: string
type: object
securitySchemes:
ApiKeyAuth:
in: header

View File

@@ -24,7 +24,7 @@ info:
\ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable\n\
```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\
\ **API URLs** > **Prefix**."
x-timestamp: '2023-02-16T11:25:28Z'
x-timestamp: '2023-02-20T18:23:08Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -446,6 +446,7 @@ components:
- city
- postalCode
- country
type: object
Amount:
properties:
currency:
@@ -460,6 +461,7 @@ components:
required:
- value
- currency
type: object
BankAccount:
properties:
bankAccountNumber:
@@ -508,6 +510,7 @@ components:
x-addedInVersion: '18'
description: The bank account holder's tax ID.
type: string
type: object
Card:
properties:
cvc:
@@ -574,6 +577,7 @@ components:
required:
- expiryYear
- holderName
type: object
CreatePermitRequest:
properties:
merchantAccount:
@@ -597,6 +601,7 @@ components:
- shopperReference
- recurringDetailReference
- permits
type: object
CreatePermitResult:
properties:
permitResultList:
@@ -608,6 +613,7 @@ components:
description: A unique reference associated with the request. This value
is globally unique; quote it when communicating with us about this request.
type: string
type: object
DisablePermitRequest:
properties:
merchantAccount:
@@ -620,6 +626,7 @@ components:
required:
- merchantAccount
- token
type: object
DisablePermitResult:
properties:
pspReference:
@@ -629,6 +636,7 @@ components:
status:
description: Status of the disable request.
type: string
type: object
DisableRequest:
properties:
contract:
@@ -667,12 +675,14 @@ components:
required:
- merchantAccount
- shopperReference
type: object
DisableResult:
properties:
response:
description: Depending on whether a specific recurring detail was in the
request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].
type: string
type: object
Name:
properties:
firstName:
@@ -684,6 +694,7 @@ components:
required:
- firstName
- lastName
type: object
NotifyShopperRequest:
properties:
amount:
@@ -729,6 +740,7 @@ components:
- shopperReference
- amount
- reference
type: object
NotifyShopperResult:
properties:
displayedReference:
@@ -754,6 +766,7 @@ components:
description: This is the recurringDetailReference returned in the response
when token was created
type: string
type: object
Permit:
properties:
partnerId:
@@ -774,6 +787,7 @@ components:
description: The expiry date for this permit.
format: date-time
type: string
type: object
PermitRestriction:
properties:
maxAmount:
@@ -788,6 +802,7 @@ components:
description: Only a single payment can be made using this permit if set
to true, otherwise multiple payments are allowed.
type: boolean
type: object
PermitResult:
properties:
resultKey:
@@ -799,6 +814,7 @@ components:
description: The permit token which is used to make payments by the partner
company.
type: string
type: object
Recurring:
properties:
contract:
@@ -836,6 +852,7 @@ components:
- VISATOKENSERVICE
- MCTOKENSERVICE
type: string
type: object
RecurringDetail:
properties:
additionalData:
@@ -927,6 +944,7 @@ components:
required:
- recurringDetailReference
- variant
type: object
RecurringDetailsRequest:
properties:
merchantAccount:
@@ -952,6 +970,7 @@ components:
required:
- merchantAccount
- shopperReference
type: object
RecurringDetailsResult:
properties:
creationDate:
@@ -970,6 +989,7 @@ components:
description: The reference you use to uniquely identify the shopper (e.g.
user ID or account ID).
type: string
type: object
ScheduleAccountUpdaterRequest:
properties:
additionalData:
@@ -1006,6 +1026,7 @@ components:
required:
- merchantAccount
- reference
type: object
ScheduleAccountUpdaterResult:
properties:
pspReference:
@@ -1021,6 +1042,7 @@ components:
required:
- pspReference
- result
type: object
ServiceError:
properties:
additionalData:
@@ -1047,6 +1069,7 @@ components:
description: The HTTP response status.
format: int32
type: integer
type: object
TokenDetails:
properties:
tokenData:
@@ -1055,6 +1078,7 @@ components:
type: object
tokenDataType:
type: string
type: object
securitySchemes:
ApiKeyAuth:
in: header