mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
Update JSON & YAML specs
This commit is contained in:
Wouter Boereboom
@@ -9,7 +9,7 @@
|
||||
"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/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```",
|
||||
"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](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```",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Developer Experience team",
|
||||
@@ -20,6 +20,11 @@
|
||||
"x-groups" : [
|
||||
"General"
|
||||
],
|
||||
"tags" : [
|
||||
{
|
||||
"name" : "General"
|
||||
}
|
||||
],
|
||||
"paths" : {
|
||||
"/disable" : {
|
||||
"post" : {
|
||||
@@ -217,6 +222,99 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/notifyShopper" : {
|
||||
"post" : {
|
||||
"tags" : [
|
||||
"General"
|
||||
],
|
||||
"summary" : "Ask the issuer to inform shopper of upcoming payment",
|
||||
"description" : "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).",
|
||||
"operationId" : "post-notifyShopper",
|
||||
"x-groupName" : "General",
|
||||
"x-sortIndex" : 4,
|
||||
"security" : [
|
||||
{
|
||||
"BasicAuth" : [
|
||||
]
|
||||
},
|
||||
{
|
||||
"ApiKeyAuth" : [
|
||||
]
|
||||
}
|
||||
],
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotifyShopperRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotifyShopperResult"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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."
|
||||
},
|
||||
"401" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/ServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Unauthorized - authentication required."
|
||||
},
|
||||
"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."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/scheduleAccountUpdater" : {
|
||||
"post" : {
|
||||
"tags" : [
|
||||
@@ -326,14 +424,16 @@
|
||||
"properties" : {
|
||||
"city" : {
|
||||
"description" : "The name of the city. Maximum length: 3000 characters.",
|
||||
"maxLength" : 3000,
|
||||
"type" : "string"
|
||||
},
|
||||
"country" : {
|
||||
"description" : "The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
|
||||
"description" : "The two-character ISO-3166-1 alpha-2 country code. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
|
||||
"type" : "string"
|
||||
},
|
||||
"houseNumberOrName" : {
|
||||
"description" : "The number or name of the house. Maximum length: 3000 characters.",
|
||||
"maxLength" : 3000,
|
||||
"type" : "string"
|
||||
},
|
||||
"postalCode" : {
|
||||
@@ -341,11 +441,12 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"stateOrProvince" : {
|
||||
"description" : "State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.",
|
||||
"description" : "The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.",
|
||||
"type" : "string"
|
||||
},
|
||||
"street" : {
|
||||
"description" : "The name of the street. Maximum length: 3000 characters.\n> The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.",
|
||||
"maxLength" : 3000,
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
@@ -525,6 +626,84 @@
|
||||
"lastName"
|
||||
]
|
||||
},
|
||||
"NotifyShopperRequest" : {
|
||||
"properties" : {
|
||||
"amount" : {
|
||||
"description" : "The amount of the upcoming payment.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"billingDate" : {
|
||||
"description" : "Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format",
|
||||
"type" : "string"
|
||||
},
|
||||
"billingSequenceNumber" : {
|
||||
"description" : "Sequence of the debit. Depends on Frequency and Billing Attempts Rule.",
|
||||
"type" : "string"
|
||||
},
|
||||
"displayedReference" : {
|
||||
"description" : "Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing",
|
||||
"type" : "string"
|
||||
},
|
||||
"merchantAccount" : {
|
||||
"description" : "The merchant account identifier with which you want to process the transaction.",
|
||||
"type" : "string"
|
||||
},
|
||||
"recurringDetailReference" : {
|
||||
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
|
||||
"type" : "string"
|
||||
},
|
||||
"reference" : {
|
||||
"description" : "Pre-debit notification reference sent by the merchant. This is a mandatory field",
|
||||
"type" : "string"
|
||||
},
|
||||
"shopperReference" : {
|
||||
"description" : "The ID that uniquely identifies the shopper.\n\nThis `shopperReference` must be the same as the `shopperReference` used in the initial payment.",
|
||||
"type" : "string"
|
||||
},
|
||||
"storedPaymentMethodId" : {
|
||||
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"merchantAccount",
|
||||
"shopperReference",
|
||||
"amount",
|
||||
"reference"
|
||||
]
|
||||
},
|
||||
"NotifyShopperResult" : {
|
||||
"properties" : {
|
||||
"displayedReference" : {
|
||||
"description" : "Reference of Pre-debit notification that is displayed to the shopper",
|
||||
"type" : "string"
|
||||
},
|
||||
"message" : {
|
||||
"description" : "A simple description of the `resultCode`.",
|
||||
"type" : "string"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The unique reference that is associated with the request.",
|
||||
"type" : "string"
|
||||
},
|
||||
"reference" : {
|
||||
"description" : "Reference of Pre-debit notification sent in my the merchant",
|
||||
"type" : "string"
|
||||
},
|
||||
"resultCode" : {
|
||||
"description" : "The code indicating the status of notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"shopperNotificationReference" : {
|
||||
"description" : "The unique reference for the request sent downstream.",
|
||||
"type" : "string"
|
||||
},
|
||||
"storedPaymentMethodId" : {
|
||||
"description" : "This is the recurringDetailReference returned in the response when token was created",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Recurring" : {
|
||||
"properties" : {
|
||||
"contract" : {
|
||||
@@ -625,6 +804,10 @@
|
||||
"description" : "A shopper's social security number (only in countries where it is legal to collect).",
|
||||
"type" : "string"
|
||||
},
|
||||
"tokenDetails" : {
|
||||
"x-addedInVersion" : "2",
|
||||
"$ref" : "#/components/schemas/TokenDetails"
|
||||
},
|
||||
"variant" : {
|
||||
"description" : "The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".",
|
||||
"type" : "string"
|
||||
@@ -689,7 +872,7 @@
|
||||
"type" : "object"
|
||||
},
|
||||
"card" : {
|
||||
"description" : "A container for credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided.",
|
||||
"description" : "Credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided.",
|
||||
"$ref" : "#/components/schemas/Card"
|
||||
},
|
||||
"merchantAccount" : {
|
||||
@@ -754,6 +937,19 @@
|
||||
"type" : "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"TokenDetails" : {
|
||||
"properties" : {
|
||||
"tokenData" : {
|
||||
"additionalProperties" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"tokenDataType" : {
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"securitySchemes" : {
|
||||
|
||||
Reference in New Issue
Block a user