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

Updated json specs

Browse Source
This commit is contained in:
aleksei
2021-03-05 11:58:55 +01:00
parent f868bea36b
commit 40ba4fe635
52 changed files with 59197 additions and 9083 deletions
Download Patch File Download Diff File Expand all files Collapse all files

203
json/RecurringService-v30.json
View File

@@ -7,13 +7,14 @@
],
"info" : {
"version" : "30",
"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/checkout/tokenization).\n## Authentication\nTo connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nRecurring API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Recurring/v30/disable\n```",
"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\nTo connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nRecurring API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Recurring/v30/disable\n```",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Support",
"url" : "https://support.adyen.com/",
"email" : "support@adyen.com"
"name" : "Adyen Developer Experience team",
"url" : "https://www.adyen.help/hc/en-us/community/topics",
"email" : "developer-experience@adyen.com"
}
},
"x-groups" : [
@@ -48,19 +49,54 @@
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"422" : {
"description" : "Unprocessable Entity - a request validation error."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"500" : {
"description" : "Internal Server Error - the server could not process the request."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
@@ -93,19 +129,54 @@
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"422" : {
"description" : "Unprocessable Entity - a request validation error."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"500" : {
"description" : "Internal Server Error - the server could not process the request."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
@@ -114,6 +185,7 @@
"post" : {
"summary" : "Schedules running of the Account Updater.",
"description" : "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference:\n* If the card information is provided, all the sub-fields for `card` are mandatory.\n* If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.",
"x-addedInVersion" : 4,
"operationId" : "post-scheduleAccountUpdater",
"x-groupName" : "General",
"x-sortIndex" : 3,
@@ -138,19 +210,54 @@
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"422" : {
"description" : "Unprocessable Entity - a request validation error."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"500" : {
"description" : "Internal Server Error - the server could not process the request."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
@@ -200,6 +307,7 @@
"type" : "string"
},
"bankCity" : {
"x-addedInVersion" : 18,
"description" : "The bank city.",
"type" : "string"
},
@@ -228,6 +336,7 @@
"type" : "string"
},
"taxId" : {
"x-addedInVersion" : 18,
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
@@ -294,6 +403,7 @@
"DisableRequest" : {
"properties" : {
"contract" : {
"x-addedInVersion" : 3,
"description" : "Specify the contract if you only want to disable a specific use.\n\nThis field can be set to one of the following values, or to their combination (comma-separated):\n* ONECLICK\n* RECURRING\n* PAYOUT",
"type" : "string"
},
@@ -329,17 +439,6 @@
"description" : "The first name.",
"type" : "string"
},
"gender" : {
"description" : "The gender.\n>The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`.",
"enum" : [
"MALE",
"FEMALE",
"UNKNOWN"
],
"maxLength" : 1,
"minLength" : 1,
"type" : "string"
},
"infix" : {
"description" : "The name's infix, if applicable.\n>A maximum length of twenty (20) characters is imposed.",
"type" : "string"
@@ -351,14 +450,13 @@
},
"required" : [
"firstName",
"lastName",
"gender"
"lastName"
]
},
"Recurring" : {
"properties" : {
"contract" : {
"description" : "The type of recurring contract to be used.\nPossible values:\n* `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n* `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not.\n* `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/checkout/online-payouts).",
"description" : "The type of recurring contract to be used.\nPossible values:\n* `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n* `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not.\n* `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts).",
"enum" : [
"ONECLICK",
"RECURRING",
@@ -371,6 +469,7 @@
"type" : "string"
},
"tokenService" : {
"x-addedInVersion" : 25,
"description" : "The name of the token service.",
"enum" : [
"VISATOKENSERVICE",
@@ -383,6 +482,7 @@
"RecurringDetail" : {
"properties" : {
"additionalData" : {
"x-addedInVersion" : 5,
"additionalProperties" : {
"type" : "string"
},
@@ -390,10 +490,12 @@
"type" : "object"
},
"alias" : {
"x-addedInVersion" : 4,
"description" : "The alias of the credit card number.\n\nApplies only to recurring contracts storing credit card details",
"type" : "string"
},
"aliasType" : {
"x-addedInVersion" : 4,
"description" : "The alias type of the credit card number.\n\nApplies only to recurring contracts storing credit card details.",
"type" : "string"
},
@@ -402,6 +504,7 @@
"$ref" : "#/components/schemas/BankAccount"
},
"billingAddress" : {
"x-addedInVersion" : 4,
"description" : "The billing address.",
"$ref" : "#/components/schemas/Address"
},
@@ -410,6 +513,7 @@
"$ref" : "#/components/schemas/Card"
},
"contractTypes" : {
"x-addedInVersion" : 12,
"description" : "Types of recurring contracts.",
"items" : {
"type" : "string"
@@ -422,6 +526,7 @@
"type" : "string"
},
"firstPspReference" : {
"x-addedInVersion" : 4,
"description" : "The `pspReference` of the first recurring payment that created the recurring detail.",
"type" : "string"
},
@@ -430,6 +535,7 @@
"type" : "string"
},
"paymentMethodVariant" : {
"x-addedInVersion" : 2,
"description" : "The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).",
"type" : "string"
},
@@ -438,10 +544,12 @@
"type" : "string"
},
"shopperName" : {
"x-addedInVersion" : 4,
"description" : "The name of the shopper.",
"$ref" : "#/components/schemas/Name"
},
"socialSecurityNumber" : {
"x-addedInVersion" : 4,
"description" : "A shopper's social security number (only in countries where it is legal to collect).",
"type" : "string"
},
@@ -549,6 +657,26 @@
"pspReference",
"result"
]
},
"ServiceError" : {
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
"type" : "string"
},
"errorType" : {
"description" : "The category of the error.",
"type" : "string"
},
"message" : {
"description" : "A short explanation of the issue.",
"type" : "string"
},
"pspReference" : {
"description" : "The PSP reference of the payment.",
"type" : "string"
}
}
}
},
"securitySchemes" : {
@@ -561,6 +689,9 @@
"scheme" : "basic",
"type" : "http"
}
},
"examples" : {
}
}
}