diff --git a/json/AccountService-v3.json b/json/AccountService-v3.json index cb1a6ec..ec1ba3a 100644 --- a/json/AccountService-v3.json +++ b/json/AccountService-v3.json @@ -1540,7 +1540,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Each of the bank accounts associated with the account holder.\n> Each array entry should represent one bank account.\n> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -1806,7 +1806,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Each of the shareholders associated with the company.\nEach array entry should represent one shareholder.", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -2700,25 +2700,25 @@ "PersonalDocumentData" : { "properties" : { "expirationDate" : { - "description" : "The expiration date of the document.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "issuerCountry" : { - "description" : "The two-character country code of the issuer.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "issuerState" : { - "description" : "The state issued the document (if applicable)", + "description" : "The state where the document was issued (if applicable).", "type" : "string" }, "number" : { - "description" : "The number of the document. Delete the given type if the value empty.", + "description" : "The number in the document.", "type" : "string" }, "type" : { - "description" : "The type of the document. More then one item pert type does not allowed.\nValid values: ID, PASSPORT, VISA, DRIVINGLICENSE", + "description" : "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ", "enum" : [ "DRIVINGLICENSE", "ID", @@ -2756,47 +2756,47 @@ "ShareholderContact" : { "properties" : { "address" : { - "description" : "The address of the contact.", + "description" : "The address of the person.", "$ref" : "#/components/schemas/ViasAddress" }, "email" : { - "description" : "The e-mail address of the contact.", + "description" : "The e-mail address of the person.", "type" : "string" }, "fullPhoneNumber" : { - "description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, "jobTitle" : { - "description" : "Job title of the shareholder. Required when the `shareholderType` is **Control**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", + "description" : "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", "type" : "string" }, "name" : { - "description" : "The name of the contact.", + "description" : "The name of the person.", "$ref" : "#/components/schemas/ViasName" }, "personalData" : { - "description" : "Contains information about the shareholder.", + "description" : "Contains information about the person.", "$ref" : "#/components/schemas/ViasPersonalData" }, "phoneNumber" : { - "description" : "The phone number of the contact.", + "description" : "The phone number of the person.", "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shareholderCode" : { - "description" : "The unique identifier (UUID) of the shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", + "description" : "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", "type" : "string" }, "shareholderType" : { - "description" : "The type of shareholder. \n\nPossible values: \n\n* **Ownership**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Control**: Individuals who are members of senior management staff responsible for managing the company.", + "description" : "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.", "enum" : [ - "Control", - "Ownership" + "Controller", + "Owner" ], "type" : "string" }, "webAddress" : { - "description" : "The URL of the website of the contact.", + "description" : "The URL of the person's website.", "type" : "string" } } @@ -3155,12 +3155,12 @@ "ViasPersonalData" : { "properties" : { "dateOfBirth" : { - "description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "documentData" : { "x-addedInVersion" : 3, - "description" : "Key value pairs of document type and identify numbers", + "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" }, @@ -3172,7 +3172,7 @@ "type" : "string" }, "nationality" : { - "description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.\n", "maxLength" : 2, "minLength" : 2, "type" : "string" diff --git a/json/AccountService-v4.json b/json/AccountService-v4.json index 1dc8b85..2e912f9 100644 --- a/json/AccountService-v4.json +++ b/json/AccountService-v4.json @@ -1524,7 +1524,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Each of the bank accounts associated with the account holder.\n> Each array entry should represent one bank account.\n> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -1795,7 +1795,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Each of the shareholders associated with the company.\nEach array entry should represent one shareholder.", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -2742,25 +2742,25 @@ "PersonalDocumentData" : { "properties" : { "expirationDate" : { - "description" : "The expiration date of the document.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "issuerCountry" : { - "description" : "The two-character country code of the issuer.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "issuerState" : { - "description" : "The state issued the document (if applicable)", + "description" : "The state where the document was issued (if applicable).", "type" : "string" }, "number" : { - "description" : "The number of the document. Delete the given type if the value empty.", + "description" : "The number in the document.", "type" : "string" }, "type" : { - "description" : "The type of the document. More then one item pert type does not allowed.\nValid values: ID, PASSPORT, VISA, DRIVINGLICENSE", + "description" : "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ", "enum" : [ "DRIVINGLICENSE", "ID", @@ -2798,47 +2798,47 @@ "ShareholderContact" : { "properties" : { "address" : { - "description" : "The address of the contact.", + "description" : "The address of the person.", "$ref" : "#/components/schemas/ViasAddress" }, "email" : { - "description" : "The e-mail address of the contact.", + "description" : "The e-mail address of the person.", "type" : "string" }, "fullPhoneNumber" : { - "description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, "jobTitle" : { - "description" : "Job title of the shareholder. Required when the `shareholderType` is **Control**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", + "description" : "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", "type" : "string" }, "name" : { - "description" : "The name of the contact.", + "description" : "The name of the person.", "$ref" : "#/components/schemas/ViasName" }, "personalData" : { - "description" : "Contains information about the shareholder.", + "description" : "Contains information about the person.", "$ref" : "#/components/schemas/ViasPersonalData" }, "phoneNumber" : { - "description" : "The phone number of the contact.", + "description" : "The phone number of the person.", "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shareholderCode" : { - "description" : "The unique identifier (UUID) of the shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", + "description" : "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", "type" : "string" }, "shareholderType" : { - "description" : "The type of shareholder. \n\nPossible values: \n\n* **Ownership**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Control**: Individuals who are members of senior management staff responsible for managing the company.", + "description" : "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.", "enum" : [ - "Control", - "Ownership" + "Controller", + "Owner" ], "type" : "string" }, "webAddress" : { - "description" : "The URL of the website of the contact.", + "description" : "The URL of the person's website.", "type" : "string" } } @@ -3234,12 +3234,12 @@ "ViasPersonalData" : { "properties" : { "dateOfBirth" : { - "description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "documentData" : { "x-addedInVersion" : 3, - "description" : "Key value pairs of document type and identify numbers", + "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" }, @@ -3251,7 +3251,7 @@ "type" : "string" }, "nationality" : { - "description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.\n", "maxLength" : 2, "minLength" : 2, "type" : "string" diff --git a/json/AccountService-v5.json b/json/AccountService-v5.json index b2465b1..4bf3abf 100644 --- a/json/AccountService-v5.json +++ b/json/AccountService-v5.json @@ -1744,7 +1744,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Each of the bank accounts associated with the account holder.\n> Each array entry should represent one bank account.\n> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -1784,12 +1784,20 @@ }, "payoutMethods" : { "x-addedInVersion" : 5, - "description" : "Each of the card tokens associated with the account holder.\n> Each array entry should represent one card token.\n> For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, "type" : "array" }, + "storeDetails" : { + "x-addedInVersion" : 5, + "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos).", + "items" : { + "$ref" : "#/components/schemas/StoreDetail" + }, + "type" : "array" + }, "webAddress" : { "description" : "The URL of the website of the account holder.", "type" : "string" @@ -2038,7 +2046,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Each of the shareholders associated with the company.\nEach array entry should represent one shareholder.", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -3184,25 +3192,25 @@ "PersonalDocumentData" : { "properties" : { "expirationDate" : { - "description" : "The expiration date of the document.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "issuerCountry" : { - "description" : "The two-character country code of the issuer.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "issuerState" : { - "description" : "The state issued the document (if applicable)", + "description" : "The state where the document was issued (if applicable).", "type" : "string" }, "number" : { - "description" : "The number of the document. Delete the given type if the value empty.", + "description" : "The number in the document.", "type" : "string" }, "type" : { - "description" : "The type of the document. More then one item pert type does not allowed.\nValid values: ID, PASSPORT, VISA, DRIVINGLICENSE", + "description" : "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ", "enum" : [ "DRIVINGLICENSE", "ID", @@ -3240,56 +3248,135 @@ "ShareholderContact" : { "properties" : { "address" : { - "description" : "The address of the contact.", + "description" : "The address of the person.", "$ref" : "#/components/schemas/ViasAddress" }, "email" : { - "description" : "The e-mail address of the contact.", + "description" : "The e-mail address of the person.", "type" : "string" }, "fullPhoneNumber" : { - "description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, "jobTitle" : { - "description" : "Job title of the shareholder. Required when the `shareholderType` is **Control**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", + "description" : "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", "type" : "string" }, "name" : { - "description" : "The name of the contact.", + "description" : "The name of the person.", "$ref" : "#/components/schemas/ViasName" }, "personalData" : { - "description" : "Contains information about the shareholder.", + "description" : "Contains information about the person.", "$ref" : "#/components/schemas/ViasPersonalData" }, "phoneNumber" : { - "description" : "The phone number of the contact.", + "description" : "The phone number of the person.", "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shareholderCode" : { - "description" : "The unique identifier (UUID) of the shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", + "description" : "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", "type" : "string" }, "shareholderReference" : { "x-addedInVersion" : 5, - "description" : "Your reference for the shareholder.", + "description" : "Your reference for the shareholder entry.", "type" : "string" }, "shareholderType" : { - "description" : "The type of shareholder. \n\nPossible values: \n\n* **Ownership**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Control**: Individuals who are members of senior management staff responsible for managing the company.", + "description" : "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.", "enum" : [ - "Control", - "Ownership" + "Controller", + "Owner" ], "type" : "string" }, "webAddress" : { - "description" : "The URL of the website of the contact.", + "description" : "The URL of the person's website.", "type" : "string" } } }, + "StoreDetail" : { + "properties" : { + "address" : { + "description" : "The address of the physical store where the account holder will process payments from.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "fullPhoneNumber" : { + "description" : "The phone number of the store provided as a single string. It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "type" : "string" + }, + "merchantAccount" : { + "description" : "The merchant account to which the store belongs.", + "type" : "string" + }, + "merchantCategoryCode" : { + "description" : "The merchant category code (MCC) that classifies the business of the account holder.", + "type" : "string" + }, + "phoneNumber" : { + "description" : "The phone number of the store.", + "readOnly" : true, + "$ref" : "#/components/schemas/ViasPhoneNumber" + }, + "shopperInteraction" : { + "x-addedInVersion" : 5, + "description" : "The sales channel. Possible values: **Ecommerce**, **POS**.", + "enum" : [ + "Ecommerce", + "POS" + ], + "type" : "string" + }, + "splitConfigurationUUID" : { + "x-addedInVersion" : 5, + "description" : "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.", + "type" : "string" + }, + "status" : { + "description" : "The status of the store. Possible values: **Pending**, **Active**, **Inactive**, **InactiveWithModifications**, **Closed**.", + "enum" : [ + "Active", + "Closed", + "Inactive", + "InactiveWithModifications", + "Pending" + ], + "readOnly" : true, + "type" : "string" + }, + "store" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an `/updateAccountHolder` request.", + "type" : "string" + }, + "storeName" : { + "description" : "The name of the account holder's store, between 3 to 22 characters in length.\nThis value will be shown in shopper statements.", + "type" : "string" + }, + "storeReference" : { + "description" : "Your unique identifier for the store, between 3 to 128 characters in length.\nThis value will be shown as the store description in your Customer Area.", + "type" : "string" + }, + "virtualAccount" : { + "x-addedInVersion" : 5, + "description" : "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.", + "type" : "string" + }, + "webAddress" : { + "x-addedInVersion" : 5, + "description" : "URL of the ecommerce store.", + "type" : "string" + } + }, + "required" : [ + "storeReference", + "merchantCategoryCode", + "address", + "merchantAccount" + ] + }, "SuspendAccountHolderRequest" : { "properties" : { "accountHolderCode" : { @@ -3740,19 +3827,19 @@ "ViasPersonalData" : { "properties" : { "dateOfBirth" : { - "description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "documentData" : { "x-addedInVersion" : 3, - "description" : "Key value pairs of document type and identify numbers", + "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" }, "type" : "array" }, "nationality" : { - "description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.\n", "maxLength" : 2, "minLength" : 2, "type" : "string" diff --git a/json/AccountService-v6.json b/json/AccountService-v6.json index 0b4462b..dac0114 100644 --- a/json/AccountService-v6.json +++ b/json/AccountService-v6.json @@ -1744,7 +1744,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Each of the bank accounts associated with the account holder.\n> Each array entry should represent one bank account.\n> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -1784,7 +1784,7 @@ }, "payoutMethods" : { "x-addedInVersion" : 5, - "description" : "Each of the card tokens associated with the account holder.\n> Each array entry should represent one card token.\n> For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, @@ -1795,6 +1795,14 @@ "description" : "The prinicipal business address of the account holder.", "$ref" : "#/components/schemas/ViasAddress" }, + "storeDetails" : { + "x-addedInVersion" : 5, + "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos).", + "items" : { + "$ref" : "#/components/schemas/StoreDetail" + }, + "type" : "array" + }, "webAddress" : { "description" : "The URL of the website of the account holder.", "type" : "string" @@ -2043,7 +2051,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Each of the shareholders associated with the company.\nEach array entry should represent one shareholder.", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -3197,25 +3205,25 @@ "PersonalDocumentData" : { "properties" : { "expirationDate" : { - "description" : "The expiration date of the document.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "issuerCountry" : { - "description" : "The two-character country code of the issuer.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "issuerState" : { - "description" : "The state issued the document (if applicable)", + "description" : "The state where the document was issued (if applicable).", "type" : "string" }, "number" : { - "description" : "The number of the document. Delete the given type if the value empty.", + "description" : "The number in the document.", "type" : "string" }, "type" : { - "description" : "The type of the document. More then one item pert type does not allowed.\nValid values: ID, PASSPORT, VISA, DRIVINGLICENSE", + "description" : "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ", "enum" : [ "DRIVINGLICENSE", "ID", @@ -3253,56 +3261,135 @@ "ShareholderContact" : { "properties" : { "address" : { - "description" : "The address of the contact.", + "description" : "The address of the person.", "$ref" : "#/components/schemas/ViasAddress" }, "email" : { - "description" : "The e-mail address of the contact.", + "description" : "The e-mail address of the person.", "type" : "string" }, "fullPhoneNumber" : { - "description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, "jobTitle" : { - "description" : "Job title of the shareholder. Required when the `shareholderType` is **Control**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", + "description" : "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", "type" : "string" }, "name" : { - "description" : "The name of the contact.", + "description" : "The name of the person.", "$ref" : "#/components/schemas/ViasName" }, "personalData" : { - "description" : "Contains information about the shareholder.", + "description" : "Contains information about the person.", "$ref" : "#/components/schemas/ViasPersonalData" }, "phoneNumber" : { - "description" : "The phone number of the contact.", + "description" : "The phone number of the person.", "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shareholderCode" : { - "description" : "The unique identifier (UUID) of the shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", + "description" : "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", "type" : "string" }, "shareholderReference" : { "x-addedInVersion" : 5, - "description" : "Your reference for the shareholder.", + "description" : "Your reference for the shareholder entry.", "type" : "string" }, "shareholderType" : { - "description" : "The type of shareholder. \n\nPossible values: \n\n* **Ownership**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Control**: Individuals who are members of senior management staff responsible for managing the company.", + "description" : "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.", "enum" : [ - "Control", - "Ownership" + "Controller", + "Owner" ], "type" : "string" }, "webAddress" : { - "description" : "The URL of the website of the contact.", + "description" : "The URL of the person's website.", "type" : "string" } } }, + "StoreDetail" : { + "properties" : { + "address" : { + "description" : "The address of the physical store where the account holder will process payments from.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "fullPhoneNumber" : { + "description" : "The phone number of the store provided as a single string. It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "type" : "string" + }, + "merchantAccount" : { + "description" : "The merchant account to which the store belongs.", + "type" : "string" + }, + "merchantCategoryCode" : { + "description" : "The merchant category code (MCC) that classifies the business of the account holder.", + "type" : "string" + }, + "phoneNumber" : { + "description" : "The phone number of the store.", + "readOnly" : true, + "$ref" : "#/components/schemas/ViasPhoneNumber" + }, + "shopperInteraction" : { + "x-addedInVersion" : 5, + "description" : "The sales channel. Possible values: **Ecommerce**, **POS**.", + "enum" : [ + "Ecommerce", + "POS" + ], + "type" : "string" + }, + "splitConfigurationUUID" : { + "x-addedInVersion" : 5, + "description" : "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.", + "type" : "string" + }, + "status" : { + "description" : "The status of the store. Possible values: **Pending**, **Active**, **Inactive**, **InactiveWithModifications**, **Closed**.", + "enum" : [ + "Active", + "Closed", + "Inactive", + "InactiveWithModifications", + "Pending" + ], + "readOnly" : true, + "type" : "string" + }, + "store" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an `/updateAccountHolder` request.", + "type" : "string" + }, + "storeName" : { + "description" : "The name of the account holder's store, between 3 to 22 characters in length.\nThis value will be shown in shopper statements.", + "type" : "string" + }, + "storeReference" : { + "description" : "Your unique identifier for the store, between 3 to 128 characters in length.\nThis value will be shown as the store description in your Customer Area.", + "type" : "string" + }, + "virtualAccount" : { + "x-addedInVersion" : 5, + "description" : "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.", + "type" : "string" + }, + "webAddress" : { + "x-addedInVersion" : 5, + "description" : "URL of the ecommerce store.", + "type" : "string" + } + }, + "required" : [ + "storeReference", + "merchantCategoryCode", + "address", + "merchantAccount" + ] + }, "SuspendAccountHolderRequest" : { "properties" : { "accountHolderCode" : { @@ -3763,19 +3850,19 @@ "ViasPersonalData" : { "properties" : { "dateOfBirth" : { - "description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "documentData" : { "x-addedInVersion" : 3, - "description" : "Key value pairs of document type and identify numbers", + "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" }, "type" : "array" }, "nationality" : { - "description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.\n", "maxLength" : 2, "minLength" : 2, "type" : "string" diff --git a/json/BalancePlatformService-v1.json b/json/BalancePlatformService-v1.json index bcde044..844aff0 100644 --- a/json/BalancePlatformService-v1.json +++ b/json/BalancePlatformService-v1.json @@ -9,7 +9,7 @@ "version" : "1", "x-publicVersion" : true, "title" : "Issuing: Balance Platform API", - "description" : "The Balance Platform API enables you to create a platform, onboard users as account holders, create balance accounts, and issue cards.\n\nFor information about use cases, refer to [Adyen Issuing](https://docs.adyen.com/issuing).\n\n ## Authentication\nYour Adyen contact will provide your API credential. Then you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n## Versioning\nBalance Platform 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://balanceplatform-api-test.adyen.com/bcl/v1\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/bcl/v1`.\n\nFor more information, refer to our [Going live documentation](https://docs.adyen.com/issuing/integration-checklist#going-live).", + "description" : "The Balance Platform API enables you to create a platform, onboard users as account holders, create balance accounts, and issue cards.\n\nFor information about use cases, refer to [Adyen Issuing](https://docs.adyen.com/issuing).\n\n ## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, 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-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Versioning\nBalance Platform 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://balanceplatform-api-test.adyen.com/bcl/v1\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://balanceplatform-api-live.adyen.com/bcl/v1`.\n\nFor more information, refer to our [Going live documentation](https://docs.adyen.com/issuing/integration-checklist#going-live).", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -168,11 +168,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-accountHolders-id-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/AccountHolder" } @@ -183,11 +178,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -198,11 +188,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -213,11 +198,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -228,11 +208,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -243,11 +218,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -426,11 +396,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-accountHolders-id-balanceAccounts-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/PaginatedBalanceAccountsResponse" } @@ -441,11 +406,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -456,11 +416,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -471,11 +426,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -486,11 +436,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -501,11 +446,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -655,11 +595,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-balanceAccounts-id-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/BalanceAccount" } @@ -670,11 +605,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -685,11 +615,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -700,11 +625,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -715,11 +635,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -730,11 +645,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -788,11 +698,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-balanceAccounts-id-paymentInstruments-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/PaginatedPaymentInstrumentsResponse" } @@ -803,11 +708,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -818,11 +718,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -833,11 +728,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -848,11 +738,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -863,11 +748,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -901,11 +781,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-balancePlatforms-id-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/BalancePlatform" } @@ -916,11 +791,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -931,11 +801,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -946,11 +811,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -961,11 +821,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -976,11 +831,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1034,11 +884,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-balancePlatforms-id-accountHolders-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/PaginatedAccountHoldersResponse" } @@ -1049,11 +894,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1064,11 +904,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1079,11 +914,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1094,11 +924,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1109,11 +934,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1369,11 +1189,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1384,11 +1199,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1399,11 +1209,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1414,11 +1219,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1429,11 +1229,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1698,11 +1493,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1713,11 +1503,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1728,11 +1513,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1743,11 +1523,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1758,11 +1533,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2027,11 +1797,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/PaymentInstrumentGroup" } @@ -2042,11 +1807,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2057,11 +1817,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2072,11 +1827,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2087,11 +1837,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2102,11 +1847,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2140,11 +1880,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/TransactionRulesResponse" } @@ -2155,11 +1890,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2170,11 +1900,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2185,11 +1910,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2200,11 +1920,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2215,11 +1930,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2372,11 +2082,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-paymentInstruments-id-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/PaymentInstrument" } @@ -2387,11 +2092,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2402,11 +2102,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2417,11 +2112,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2432,11 +2122,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2447,11 +2132,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2616,11 +2296,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-paymentInstruments-id-transactionRules-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/TransactionRulesResponse" } @@ -2631,11 +2306,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2646,11 +2316,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2661,11 +2326,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2676,11 +2336,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2691,11 +2346,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2956,11 +2606,6 @@ "200" : { "content" : { "application/json" : { - "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-transactionRules-transactionRuleId-success-200" - } - }, "schema" : { "$ref" : "#/components/schemas/TransactionRuleResponse" } @@ -2971,11 +2616,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2986,11 +2626,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -3001,11 +2636,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -3016,11 +2646,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -3031,11 +2656,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -3416,11 +3036,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3431,11 +3046,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3446,11 +3056,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3461,11 +3066,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3476,11 +3076,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3632,11 +3227,11 @@ "type" : "string" }, "reference" : { - "description" : "Your reference to the account holder, maximum 150 characters", + "description" : "Your reference to the account holder, maximum 150 characters.", "type" : "string" }, "status" : { - "description" : "The status of the account holder.\n\nPossible values: \n\n * **Active**: The account holder is active. This the default status when creating an account holder. \n\n * **Suspended**: The account holder is temporarily suspended. You can set the account back to active or permanently close the account. \n\n* **Closed**: The account holder is permanently closed. This action cannot be undone. \n\n", + "description" : "The status of the account holder.\n\nPossible values: \n\n * **Active**: The account holder is active. This the default status when creating an account holder. \n\n * **Suspended**: The account holder is temporarily suspended. You can set the account back to active or permanently close the account. \n\n* **Closed**: The account holder is permanently closed. This action cannot be undone.", "enum" : [ "Active", "Closed", @@ -3681,7 +3276,7 @@ "type" : "string" }, "reference" : { - "description" : "Your reference to the account holder, maximum 150 characters", + "description" : "Your reference to the account holder, maximum 150 characters.", "type" : "string" }, "sweepConfigurations" : { @@ -4225,7 +3820,19 @@ "$ref" : "#/components/schemas/Entity" }, "type" : { - "description" : "The type of document. For example, **passport**.\n\nFor a list of possible values, go to our [Reference](https://docs.adyen.com/issuing/kyc-verification/required-kyc-information#reference) documentation.", + "description" : "The type of document. The possible values depend on the legal entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**, **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**, the values can be **drivingLicence**, **identityCard**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **ssn**.\n\nWhen uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner), use **bankStatement**.", + "enum" : [ + "bankStatement", + "drivingLicense", + "identityCard", + "passport", + "proofOfAddress", + "proofOfNationalIdNumber", + "proofOfResidency", + "registrationDocument", + "ssn", + "taxDocument" + ], "type" : "string" } } @@ -4261,7 +3868,19 @@ "$ref" : "#/components/schemas/Entity" }, "type" : { - "description" : "The type of document. For example, **passport**.\n\nFor a list of possible values, go to our [Reference](https://docs.adyen.com/issuing/kyc-verification/required-kyc-information#reference) documentation.", + "description" : "The type of document. The possible values depend on the legal entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**, **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**, the values can be **drivingLicence**, **identityCard**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **ssn**.\n\nWhen uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner), use **bankStatement**.", + "enum" : [ + "bankStatement", + "drivingLicense", + "identityCard", + "passport", + "proofOfAddress", + "proofOfNationalIdNumber", + "proofOfResidency", + "registrationDocument", + "ssn", + "taxDocument" + ], "type" : "string" } } @@ -4301,7 +3920,7 @@ "GenericEntityInfo" : { "properties" : { "entityAssociations" : { - "description" : "List of individual legal entities associated with the organization legal entity. \nFor example, ultimate business owners (UBOs), control officers, or signatories. ", + "description" : "List of individual legal entities associated with the organization legal entity. \nFor example, ultimate business owners through ownership or control, and signatories. ", "items" : { "$ref" : "#/components/schemas/LegalEntityAssociation" }, @@ -4336,7 +3955,19 @@ "type" : "string" }, "type" : { - "description" : "The type of document. For example, **passport**.\n\nFor a list of possible values, go to our [Reference](https://docs.adyen.com/issuing/kyc-verification/required-kyc-information#reference) documentation.", + "description" : "The type of document. The possible values depend on the legal entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**, **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**, the values can be **drivingLicence**, **identityCard**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **ssn**.\n\nWhen uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner), use **bankStatement**.", + "enum" : [ + "bankStatement", + "drivingLicense", + "identityCard", + "passport", + "proofOfAddress", + "proofOfNationalIdNumber", + "proofOfResidency", + "registrationDocument", + "ssn", + "taxDocument" + ], "type" : "string" } } @@ -4408,7 +4039,7 @@ "type" : "array" }, "entityAssociations" : { - "description" : "List of individual legal entities associated with the organization legal entity. \nFor example, ultimate business owners (UBOs), control officers, or signatories. ", + "description" : "List of individual legal entities associated with the organization legal entity. \nFor example, ultimate business owners through ownership or control, and signatories. ", "items" : { "$ref" : "#/components/schemas/LegalEntityAssociation" }, @@ -4472,7 +4103,7 @@ "LegalEntityInfo" : { "properties" : { "entityAssociations" : { - "description" : "List of individual legal entities associated with the organization legal entity. \nFor example, ultimate business owners (UBOs), control officers, or signatories. ", + "description" : "List of individual legal entities associated with the organization legal entity. \nFor example, ultimate business owners through ownership or control, and signatories. ", "items" : { "$ref" : "#/components/schemas/LegalEntityAssociation" }, @@ -4539,7 +4170,7 @@ "$ref" : "#/components/schemas/Address2" }, "description" : { - "description" : "A description of what the organization does.", + "description" : "Your description for the organization.", "type" : "string" }, "doingBusinessAs" : { @@ -4572,10 +4203,24 @@ }, "taxIdAbsenceReason" : { "description" : "The reason the organization has not provided a tax identifier.\n\nPossible values: **industryExemption**, **belowTaxThreshold**.", + "enum" : [ + "industryExemption", + "belowTaxThreshold" + ], "type" : "string" }, "type" : { - "description" : "The type of organization. Refer to [Organization types](https://docs.adyen.com/issuing/kyc-verification/required-kyc-information#organization-types) for possible values.", + "description" : "The type of organization. Possible values: **associationIncorporated**, **governmentalOrganization**, **listedPublicCompany**,**nonProfit**, **partnershipIncorporated**, **privateCompany**, **unlistedPublicCompany**, **soleProprietorship**.", + "enum" : [ + "associationIncorporated", + "governmentalOrganization", + "listedPublicCompany", + "nonProfit", + "partnershipIncorporated", + "privateCompany", + "unlistedPublicCompany", + "soleProprietorship" + ], "type" : "string" }, "webData" : { @@ -4867,7 +4512,7 @@ "$ref" : "#/components/schemas/CardInfo" }, "status" : { - "description" : "The new status of the payment instrument.\n\nPossible values: \n\n * **Active**: The payment instrument is active and can be used to make payments. \n\n * **Requested**: The payment instrument has been requested. This state is applicable when creating physical cards. \n\n* **Inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. \n\n * **Closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n* **Stolen** \n\n * **Lost**", + "description" : "The new status of the payment instrument.\n\nPossible values: \n\n * **Active**: The payment instrument is active and can be used to make payments. \n\n * **Requested**: The payment instrument has been requested. This state is applicable when creating physical cards. \n\n* **Inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. \n\n * **Closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n* **Stolen** \n\n * **Lost**\n\n ", "enum" : [ "Active", "Closed", @@ -4910,7 +4555,7 @@ "type" : "string" }, "type" : { - "description" : "The type of phone number.\nPossible values: \n **Landline**, **Mobile**.\n", + "description" : "The type of phone number.\nPossible values: \n**Landline**, **Mobile**.\n", "enum" : [ "Landline", "Mobile", @@ -5538,302 +5183,6 @@ "errorCode" : "99_500" } }, - "get-accountHolders-id-balanceAccounts-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a list of balance accounts under an account holder", - "value" : { - "balanceAccounts" : [ - { - "accountHolderId" : "AH32272223222B59K6ZKBBFNQ", - "defaultCurrencyCode" : "EUR", - "id" : "BA32272223222B59K6ZXHBFN6", - "status" : "Active" - }, - { - "accountHolderId" : "AH32272223222B59K6ZKBBFNQ", - "defaultCurrencyCode" : "EUR", - "id" : "BA32272223222B59K72CKBFNJ", - "status" : "Active" - }, - { - "accountHolderId" : "AH32272223222B59K6ZKBBFNQ", - "defaultCurrencyCode" : "EUR", - "id" : "BA32272223222B5BRR27B2M7G", - "status" : "Active" - } - ], - "hasNext" : true, - "hasPrevious" : false - } - }, - "get-accountHolders-id-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving an account holder", - "value" : { - "balancePlatform" : "YOUR_BALANCE_PLATFORM", - "contactDetails" : { - "address" : { - "city" : "Amsterdam", - "country" : "NL", - "houseNumberOrName" : "274", - "postalCode" : "1020CD", - "street" : "Brannan Street" - }, - "email" : "s.hopper@example.com", - "phone" : { - "number" : "+315551231234", - "type" : "Mobile" - } - }, - "description" : "S.Hopper - Staff 123", - "id" : "AH32272223222B5CM4MWJ892H", - "status" : "Active" - } - }, - "get-balanceAccounts-id-paymentInstruments-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a list of payment instruments under a balance account", - "value" : { - "hasNext" : "true", - "hasPrevious" : "false", - "paymentInstruments" : [ - { - "balanceAccountId" : "BA32272223222B59CZ3T52DKZ", - "issuingCountryCode" : "GB", - "status" : "Active", - "type" : "card", - "card" : { - "brandVariant" : "mc", - "cardholderName" : "name", - "formFactor" : "virtual", - "bin" : "555544", - "expiration" : { - "month" : "12", - "year" : "2022" - }, - "lastFour" : "2357", - "number" : "************2357" - }, - "id" : "PI32272223222B59M5TM658DT" - }, - { - "balanceAccountId" : "BA32272223222B59CZ3T52DKZ", - "issuingCountryCode" : "GB", - "status" : "Active", - "type" : "card", - "card" : { - "brandVariant" : "mc", - "cardholderName" : "name", - "formFactor" : "virtual", - "bin" : "555544", - "expiration" : { - "month" : "01", - "year" : "2023" - }, - "lastFour" : "8331", - "number" : "************8331" - }, - "id" : "PI32272223222B59PXDGQDLSF" - } - ] - } - }, - "get-balanceAccounts-id-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a balance account", - "value" : { - "accountHolderId" : "AH32272223222B59K6RTQBFNZ", - "defaultCurrencyCode" : "EUR", - "balances" : [ - { - "available" : 0, - "balance" : 0, - "currency" : "EUR", - "reserved" : 0 - } - ], - "id" : "BA3227C223222B5BLP6JQC3FD", - "paymentInstruments" : [ - { - "id" : "PI32272223222B5BRM4FZ7J9J" - } - ], - "status" : "Active" - } - }, - "get-balancePlatforms-id-accountHolders-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a list of account holders under a balance platform", - "value" : { - "accountHolders" : [ - { - "contactDetails" : { - "address" : { - "city" : "Amsterdam", - "country" : "NL", - "houseNumberOrName" : "6", - "postalCode" : "12336750", - "street" : "Simon Carmiggeltstraat" - } - }, - "description" : "J. Doe", - "id" : "AH32272223222B59DDWSCCMP7", - "status" : "Active" - }, - { - "contactDetails" : { - "address" : { - "city" : "Amsterdam", - "country" : "NL", - "houseNumberOrName" : "11", - "postalCode" : "12336750", - "street" : "Simon Carmiggeltstraat" - } - }, - "description" : "S. Hopper", - "id" : "AH32272223222B59DJ7QBCMPN", - "status" : "Active" - } - ], - "hasNext" : "true", - "hasPrevious" : "false" - } - }, - "get-balancePlatforms-id-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a balance platform", - "value" : { - "id" : "YOUR_BALANCE_PLATFORM", - "status" : "Active" - } - }, - "get-paymentInstrumentGroups-id-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a payment instrument group", - "value" : { - "balancePlatform" : "YOUR_BALANCE_PLATFORM", - "txVariant" : "mc", - "id" : "PG3227C223222B5CMD3FJFKGZ" - } - }, - "get-paymentInstrumentGroups-id-transactionRules-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a list of transaction rules applied to a payment instrument group", - "value" : { - "transactionRules" : [ - { - "description" : "Allow 5 transactions per month", - "interval" : { - "type" : "monthly" - }, - "maxTransactions" : 5, - "paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ", - "reference" : "myRule12345", - "startDate" : "2021-01-25T12:46:35.476629Z", - "status" : "active", - "type" : "velocity", - "id" : "TR32272223222B5CMDGMC9F4F" - }, - { - "amount" : { - "currency" : "EUR", - "value" : 10000 - }, - "description" : "Allow up to 100 EUR per month", - "interval" : { - "type" : "monthly" - }, - "paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ", - "reference" : "myRule16378", - "startDate" : "2021-01-25T12:46:35.476629Z", - "status" : "active", - "type" : "velocity", - "id" : "TR32272223222B5CMDGT89F4F" - } - ] - } - }, - "get-paymentInstruments-id-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a payment instrument", - "value" : { - "balanceAccountId" : "BA32272223222B59CZ3T52DKZ", - "description" : "S. Hopper - Main card", - "issuingCountryCode" : "GB", - "status" : "Active", - "type" : "card", - "card" : { - "brand" : "mc", - "brandVariant" : "mcdebit", - "cardholderName" : "Simon Hopper", - "formFactor" : "virtual", - "bin" : "555544", - "expiration" : { - "month" : "01", - "year" : "2024" - }, - "lastFour" : "3548", - "number" : "************3548" - }, - "id" : "PI32272223222B5CMD3MQ3HXX" - } - }, - "get-paymentInstruments-id-transactionRules-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a list of transaction rules applied to a payment instrument", - "value" : { - "transactionRules" : [ - { - "description" : "Allow 5 transactions per month", - "interval" : { - "type" : "monthly" - }, - "maxTransactions" : 5, - "paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ", - "reference" : "myRule12345", - "startDate" : "2021-01-25T12:46:35.476629Z", - "status" : "active", - "type" : "velocity", - "id" : "TR32272223222B5CMDGMC9F4F" - }, - { - "amount" : { - "currency" : "EUR", - "value" : 10000 - }, - "description" : "Allow up to 100 EUR per month", - "interval" : { - "type" : "monthly" - }, - "paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ", - "reference" : "myRule16378", - "startDate" : "2021-01-25T12:46:35.476629Z", - "status" : "active", - "type" : "velocity", - "id" : "TR32272223222B5CMDGT89F4F" - } - ] - } - }, - "get-transactionRules-transactionRuleId-success-200" : { - "summary" : "Response code - 200 OK", - "description" : "Example response when retrieving a transaction rule", - "value" : { - "transactionRule" : { - "description" : "Allow 5 transactions per month", - "interval" : { - "type" : "monthly" - }, - "maxTransactions" : 5, - "paymentInstrumentId" : "PI3227C223222B59KGTXP884R", - "reference" : "myRule12345", - "startDate" : "2021-01-25T12:46:35.476629Z", - "status" : "active", - "type" : "velocity", - "id" : "TR32272223222B5CMD3V73HXG" - } - } - }, "patch-accountHolders-id-success-200" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully updating the status of an account holder", diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index dcf2a6e..280a25b 100644 --- a/json/CheckoutService-v37.json +++ b/json/CheckoutService-v37.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1049,7 +1024,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1404,6 +1379,7 @@ "components" : { "schemas" : { "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1432,6 +1408,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2347,6 +2326,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2381,6 +2361,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2389,6 +2370,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2414,16 +2398,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2443,6 +2432,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2497,6 +2489,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -2505,6 +2498,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2553,6 +2549,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2574,6 +2571,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2585,6 +2583,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2669,6 +2670,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2702,6 +2704,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2717,6 +2726,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2728,6 +2740,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2736,6 +2749,9 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, @@ -3049,7 +3065,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3189,7 +3205,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3242,6 +3258,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3500,7 +3520,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" } }, @@ -3509,6 +3529,7 @@ ] }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -3547,6 +3568,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -3555,6 +3577,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -3564,6 +3589,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -3591,6 +3617,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -3627,6 +3654,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -3635,6 +3663,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -3761,6 +3792,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -3772,6 +3804,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -3782,6 +3817,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -3790,12 +3826,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -3815,6 +3855,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -3824,6 +3867,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -3836,6 +3880,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -3943,6 +3990,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -3981,6 +4029,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4057,7 +4106,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4073,6 +4183,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4082,6 +4195,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4094,6 +4208,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4120,16 +4237,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -4171,6 +4293,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4191,12 +4314,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -4221,6 +4348,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -4230,6 +4360,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -4242,6 +4373,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -4323,9 +4457,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -4399,7 +4537,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -4945,6 +5083,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -5291,7 +5433,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -5497,6 +5639,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -5724,7 +5870,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -5770,6 +5916,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -5778,6 +5925,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -5787,6 +5937,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5807,6 +5958,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -6311,6 +6465,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -6330,6 +6485,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -6339,6 +6497,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -6355,6 +6514,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -6516,6 +6678,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -6523,6 +6686,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -6648,6 +6814,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -6660,6 +6827,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -6669,6 +6839,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -6680,6 +6851,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -6693,16 +6867,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -6713,12 +6892,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -6731,6 +6914,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index ff772b8..c90ae34 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1546,6 +1521,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1574,6 +1550,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2489,6 +2468,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2523,6 +2503,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2531,6 +2512,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2556,16 +2540,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2585,6 +2574,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2639,6 +2631,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -2647,6 +2640,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2695,6 +2691,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2716,6 +2713,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2727,6 +2725,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2857,6 +2858,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2890,6 +2892,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2905,6 +2914,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2916,6 +2928,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2924,6 +2937,9 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, @@ -3257,7 +3273,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3397,7 +3413,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3450,6 +3466,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3708,7 +3728,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -3753,6 +3773,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -3791,6 +3812,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -3799,6 +3821,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -3808,6 +3833,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -3835,6 +3861,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -3871,6 +3898,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -3879,6 +3907,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4005,6 +4036,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4016,6 +4048,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4026,6 +4061,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -4034,12 +4070,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4059,6 +4099,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4068,6 +4111,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4080,6 +4124,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4187,6 +4234,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4225,6 +4273,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4301,7 +4350,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4317,6 +4427,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4326,6 +4439,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4338,6 +4452,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4421,16 +4538,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -4472,6 +4594,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4492,12 +4615,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -4522,6 +4649,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -4531,6 +4661,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -4543,6 +4674,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -4624,9 +4758,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -4708,7 +4846,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5264,6 +5402,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -5633,7 +5775,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -5844,6 +5986,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6067,7 +6213,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6112,6 +6258,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6120,6 +6267,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6129,6 +6279,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6149,6 +6300,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -6684,6 +6838,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -6703,6 +6858,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -6712,6 +6870,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -6728,6 +6887,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -6889,6 +7051,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -6896,6 +7059,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -7112,6 +7278,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -7124,6 +7291,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -7133,6 +7303,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7144,6 +7315,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -7157,16 +7331,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -7177,12 +7356,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -7195,6 +7378,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index c77c433..a489532 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1218,6 +1193,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1226,9 +1204,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1558,6 +1533,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1586,6 +1562,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2501,6 +2480,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2535,6 +2515,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2543,6 +2524,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2568,16 +2552,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2597,6 +2586,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2651,6 +2643,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -2659,6 +2652,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2707,6 +2703,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2728,6 +2725,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2739,6 +2737,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2869,6 +2870,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2902,6 +2904,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2917,6 +2926,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2928,6 +2940,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2936,6 +2949,9 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, @@ -3269,7 +3285,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3409,7 +3425,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3462,6 +3478,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3720,7 +3740,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -3765,6 +3785,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -3803,6 +3824,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -3811,6 +3833,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -3820,6 +3845,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -3847,6 +3873,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -3883,6 +3910,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -3891,6 +3919,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4017,6 +4048,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4028,6 +4060,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4038,6 +4073,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -4046,12 +4082,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4071,6 +4111,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4080,6 +4123,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4092,6 +4136,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4199,6 +4246,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4237,6 +4285,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4313,7 +4362,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4329,6 +4439,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4338,6 +4451,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4350,6 +4464,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4433,16 +4550,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -4484,6 +4606,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4504,12 +4627,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -4534,6 +4661,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -4543,6 +4673,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -4555,6 +4686,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -4636,9 +4770,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -4720,7 +4858,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5281,6 +5419,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -5650,7 +5792,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -5866,6 +6008,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6089,7 +6235,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6134,6 +6280,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6142,6 +6289,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6151,6 +6301,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6171,6 +6322,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -6706,6 +6860,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -6725,6 +6880,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -6734,6 +6892,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -6750,6 +6909,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -6911,6 +7073,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -6918,6 +7081,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -7166,6 +7332,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -7178,6 +7345,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -7187,6 +7357,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7198,6 +7369,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -7211,16 +7385,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -7231,12 +7410,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -7249,6 +7432,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -7708,12 +7894,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index 79bd1d5..f40d9bf 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1218,6 +1193,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1226,9 +1204,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1558,6 +1533,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1586,6 +1562,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2501,6 +2480,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2535,6 +2515,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2543,6 +2524,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2568,16 +2552,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2597,6 +2586,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2651,6 +2643,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -2659,6 +2652,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2707,6 +2703,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2728,6 +2725,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2739,6 +2737,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2869,6 +2870,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2902,6 +2904,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2917,6 +2926,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2928,6 +2940,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2936,6 +2949,9 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, @@ -3269,7 +3285,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3409,7 +3425,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3462,6 +3478,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3720,7 +3740,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -3765,6 +3785,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -3803,6 +3824,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -3811,6 +3833,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -3820,6 +3845,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -3847,6 +3873,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -3883,6 +3910,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -3891,6 +3919,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4017,6 +4048,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4028,6 +4060,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4038,6 +4073,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -4046,12 +4082,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4071,6 +4111,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4080,6 +4123,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4092,6 +4136,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4199,6 +4246,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4237,6 +4285,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4313,7 +4362,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4329,6 +4439,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4338,6 +4451,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4350,6 +4464,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4433,16 +4550,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -4484,6 +4606,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4504,12 +4627,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -4534,6 +4661,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -4543,6 +4673,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -4555,6 +4686,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -4636,9 +4770,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -4720,7 +4858,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5281,6 +5419,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -5650,7 +5792,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -5866,6 +6008,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6089,7 +6235,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6134,6 +6280,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6142,6 +6289,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6151,6 +6301,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6171,6 +6322,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -6706,6 +6860,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -6725,6 +6880,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -6734,6 +6892,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -6750,6 +6909,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -6919,6 +7081,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -6926,6 +7089,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -7174,6 +7340,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", @@ -7186,6 +7353,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -7195,6 +7365,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7206,6 +7377,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -7219,16 +7393,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -7239,12 +7418,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -7257,6 +7440,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -7717,12 +7903,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index ce8cb85..86af516 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1218,6 +1193,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1226,9 +1204,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1558,6 +1533,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1594,6 +1570,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2509,6 +2488,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2551,6 +2531,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2559,6 +2540,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2584,16 +2568,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2621,6 +2610,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2675,6 +2667,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -2691,6 +2684,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2739,6 +2735,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2760,6 +2757,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2779,6 +2777,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2909,6 +2910,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2942,6 +2944,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2965,6 +2974,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2976,6 +2988,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2984,15 +2997,19 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, "title" : "Cellulant" }, "CheckoutAwaitAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3001,6 +3018,9 @@ }, "type" : { "description" : "**await**", + "enum" : [ + "await" + ], "type" : "string" }, "url" : { @@ -3340,7 +3360,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3370,6 +3390,7 @@ ] }, "CheckoutBankTransferAction" : { + "additionalProperties" : false, "properties" : { "beneficiary" : { "description" : "The name of the account holder.", @@ -3405,6 +3426,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], "type" : "string" }, "url" : { @@ -3527,7 +3551,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3563,9 +3587,10 @@ ] }, "CheckoutDonationAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3574,6 +3599,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "donate" + ], "type" : "string" }, "url" : { @@ -3586,9 +3614,10 @@ ] }, "CheckoutOneTimePasscodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3615,6 +3644,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "oneTimePasscode" + ], "type" : "string" }, "url" : { @@ -3644,6 +3676,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3670,9 +3706,10 @@ ] }, "CheckoutQrCodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3685,6 +3722,9 @@ }, "type" : { "description" : "**qrCode**", + "enum" : [ + "qrCode" + ], "type" : "string" }, "url" : { @@ -3697,6 +3737,7 @@ ] }, "CheckoutRedirectAction" : { + "additionalProperties" : false, "properties" : { "data" : { "additionalProperties" : { @@ -3719,6 +3760,9 @@ }, "type" : { "description" : "**redirect**", + "enum" : [ + "redirect" + ], "type" : "string" }, "url" : { @@ -3731,9 +3775,10 @@ ] }, "CheckoutSDKAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3749,41 +3794,9 @@ }, "type" : { "description" : "The type of the action.", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2Action" : { - "properties" : { - "authorisationToken" : { - "description" : "A token needed to authorise a payment.", - "type" : "string" - }, - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "subtype" : { - "description" : "A subtype of the token.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the fingerprint.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2**", + "enum" : [ + "sdk" + ], "type" : "string" }, "url" : { @@ -3796,9 +3809,10 @@ ] }, "CheckoutThreeDS2ChallengeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3811,6 +3825,9 @@ }, "type" : { "description" : "**threeDS2Challenge**", + "enum" : [ + "threeDS2Challenge" + ], "type" : "string" }, "url" : { @@ -3823,9 +3840,10 @@ ] }, "CheckoutThreeDS2FingerPrintAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3838,6 +3856,9 @@ }, "type" : { "description" : "**threeDS2Fingerprint**", + "enum" : [ + "threeDS2Fingerprint" + ], "type" : "string" }, "url" : { @@ -3876,6 +3897,7 @@ } }, "CheckoutVoucherAction" : { + "additionalProperties" : false, "properties" : { "alternativeReference" : { "description" : "The voucher alternative reference code.", @@ -3922,7 +3944,7 @@ "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3951,6 +3973,9 @@ }, "type" : { "description" : "**voucher**", + "enum" : [ + "voucher" + ], "type" : "string" }, "url" : { @@ -4169,7 +4194,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4214,6 +4239,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4252,6 +4278,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -4260,6 +4287,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -4269,6 +4299,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -4296,6 +4327,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4332,6 +4364,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4340,6 +4373,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4466,6 +4502,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4485,6 +4522,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4495,6 +4535,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -4511,12 +4552,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4544,6 +4589,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4553,6 +4601,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4573,6 +4622,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4680,6 +4732,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4726,6 +4779,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4802,7 +4856,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4818,6 +4933,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4827,6 +4945,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4839,6 +4958,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4922,16 +5044,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -4973,6 +5100,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5001,12 +5129,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -5039,6 +5171,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -5048,6 +5183,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -5068,6 +5204,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -5149,9 +5288,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -5162,41 +5305,7 @@ "action" : { "x-addedInVersion" : 49, "description" : "Action to be taken for completing the payment.", - "oneOf" : [ - { - "$ref" : "#/components/schemas/CheckoutAwaitAction" - }, - { - "$ref" : "#/components/schemas/CheckoutBankTransferAction" - }, - { - "$ref" : "#/components/schemas/CheckoutDonationAction" - }, - { - "$ref" : "#/components/schemas/CheckoutOneTimePasscodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutQrCodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutRedirectAction" - }, - { - "$ref" : "#/components/schemas/CheckoutSDKAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction" - }, - { - "$ref" : "#/components/schemas/CheckoutVoucherAction" - } - ] + "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, "additionalData" : { "additionalProperties" : { @@ -5277,7 +5386,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5859,6 +5968,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6184,9 +6297,6 @@ { "$ref" : "#/components/schemas/CheckoutSDKAction" }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, { "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, @@ -6277,7 +6387,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -6498,6 +6608,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6726,7 +6840,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6771,6 +6885,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6779,6 +6894,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6788,6 +6906,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6816,6 +6935,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -7359,6 +7481,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7386,6 +7509,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -7395,6 +7521,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -7419,6 +7546,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -7635,6 +7765,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7650,6 +7781,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -7941,6 +8075,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7961,6 +8096,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -7970,6 +8108,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7981,6 +8120,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -7994,16 +8136,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -8014,12 +8161,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -8040,6 +8191,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -8500,12 +8654,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index d69df8c..4af101c 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1221,6 +1196,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1229,9 +1207,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1571,6 +1546,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1607,6 +1583,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2522,6 +2501,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2564,6 +2544,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2572,6 +2553,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2597,16 +2581,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2634,6 +2623,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2688,6 +2680,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -2704,6 +2697,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2752,6 +2748,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2773,6 +2770,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2792,6 +2790,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2922,6 +2923,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2955,6 +2957,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2978,6 +2987,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2989,6 +3001,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2997,15 +3010,19 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, "title" : "Cellulant" }, "CheckoutAwaitAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3014,6 +3031,9 @@ }, "type" : { "description" : "**await**", + "enum" : [ + "await" + ], "type" : "string" }, "url" : { @@ -3359,7 +3379,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3389,6 +3409,7 @@ ] }, "CheckoutBankTransferAction" : { + "additionalProperties" : false, "properties" : { "beneficiary" : { "description" : "The name of the account holder.", @@ -3424,6 +3445,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], "type" : "string" }, "url" : { @@ -3546,7 +3570,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3582,9 +3606,10 @@ ] }, "CheckoutDonationAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3593,6 +3618,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "donate" + ], "type" : "string" }, "url" : { @@ -3605,9 +3633,10 @@ ] }, "CheckoutOneTimePasscodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3634,6 +3663,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "oneTimePasscode" + ], "type" : "string" }, "url" : { @@ -3663,6 +3695,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3689,9 +3725,10 @@ ] }, "CheckoutQrCodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3704,6 +3741,9 @@ }, "type" : { "description" : "**qrCode**", + "enum" : [ + "qrCode" + ], "type" : "string" }, "url" : { @@ -3716,6 +3756,7 @@ ] }, "CheckoutRedirectAction" : { + "additionalProperties" : false, "properties" : { "data" : { "additionalProperties" : { @@ -3738,6 +3779,9 @@ }, "type" : { "description" : "**redirect**", + "enum" : [ + "redirect" + ], "type" : "string" }, "url" : { @@ -3750,9 +3794,10 @@ ] }, "CheckoutSDKAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3768,41 +3813,9 @@ }, "type" : { "description" : "The type of the action.", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2Action" : { - "properties" : { - "authorisationToken" : { - "description" : "A token needed to authorise a payment.", - "type" : "string" - }, - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "subtype" : { - "description" : "A subtype of the token.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the fingerprint.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2**", + "enum" : [ + "sdk" + ], "type" : "string" }, "url" : { @@ -3815,9 +3828,10 @@ ] }, "CheckoutThreeDS2ChallengeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3830,6 +3844,9 @@ }, "type" : { "description" : "**threeDS2Challenge**", + "enum" : [ + "threeDS2Challenge" + ], "type" : "string" }, "url" : { @@ -3842,9 +3859,10 @@ ] }, "CheckoutThreeDS2FingerPrintAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3857,6 +3875,9 @@ }, "type" : { "description" : "**threeDS2Fingerprint**", + "enum" : [ + "threeDS2Fingerprint" + ], "type" : "string" }, "url" : { @@ -3895,6 +3916,7 @@ } }, "CheckoutVoucherAction" : { + "additionalProperties" : false, "properties" : { "alternativeReference" : { "description" : "The voucher alternative reference code.", @@ -3941,7 +3963,7 @@ "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3970,6 +3992,9 @@ }, "type" : { "description" : "**voucher**", + "enum" : [ + "voucher" + ], "type" : "string" }, "url" : { @@ -4193,7 +4218,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4238,6 +4263,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4276,6 +4302,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -4284,6 +4311,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -4293,6 +4323,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -4320,6 +4351,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4356,6 +4388,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4364,6 +4397,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4490,6 +4526,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4509,6 +4546,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4519,6 +4559,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -4535,12 +4576,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4568,6 +4613,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4577,6 +4625,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4597,6 +4646,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4704,6 +4756,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4750,6 +4803,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4826,7 +4880,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4842,6 +4957,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4851,6 +4969,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4863,6 +4982,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4946,16 +5068,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -4997,6 +5124,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5025,12 +5153,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -5063,6 +5195,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -5072,6 +5207,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -5092,6 +5228,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -5173,9 +5312,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -5186,41 +5329,7 @@ "action" : { "x-addedInVersion" : 49, "description" : "Action to be taken for completing the payment.", - "oneOf" : [ - { - "$ref" : "#/components/schemas/CheckoutAwaitAction" - }, - { - "$ref" : "#/components/schemas/CheckoutBankTransferAction" - }, - { - "$ref" : "#/components/schemas/CheckoutDonationAction" - }, - { - "$ref" : "#/components/schemas/CheckoutOneTimePasscodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutQrCodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutRedirectAction" - }, - { - "$ref" : "#/components/schemas/CheckoutSDKAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction" - }, - { - "$ref" : "#/components/schemas/CheckoutVoucherAction" - } - ] + "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, "additionalData" : { "additionalProperties" : { @@ -5301,7 +5410,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5888,6 +5997,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6219,9 +6332,6 @@ { "$ref" : "#/components/schemas/CheckoutSDKAction" }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, { "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, @@ -6312,7 +6422,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -6533,6 +6643,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6767,7 +6881,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6812,6 +6926,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6820,6 +6935,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6829,6 +6947,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6857,6 +6976,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -7400,6 +7522,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7427,6 +7550,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -7436,6 +7562,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -7460,6 +7587,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -7676,6 +7806,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7691,6 +7822,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -8002,6 +8136,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -8022,6 +8157,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -8031,6 +8169,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -8042,6 +8181,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -8055,16 +8197,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -8075,12 +8222,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -8101,6 +8252,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -8561,12 +8715,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index bad8f57..4d2d09e 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1221,6 +1196,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1229,9 +1207,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1571,6 +1546,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1607,6 +1583,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2522,6 +2501,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2564,6 +2544,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2572,6 +2553,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2597,16 +2581,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2634,6 +2623,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2688,6 +2680,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -2704,6 +2697,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2752,6 +2748,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2773,6 +2770,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2792,6 +2790,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2922,6 +2923,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2955,6 +2957,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2978,6 +2987,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2989,6 +3001,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2997,15 +3010,19 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, "title" : "Cellulant" }, "CheckoutAwaitAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3014,6 +3031,9 @@ }, "type" : { "description" : "**await**", + "enum" : [ + "await" + ], "type" : "string" }, "url" : { @@ -3365,7 +3385,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3395,6 +3415,7 @@ ] }, "CheckoutBankTransferAction" : { + "additionalProperties" : false, "properties" : { "beneficiary" : { "description" : "The name of the account holder.", @@ -3430,6 +3451,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], "type" : "string" }, "url" : { @@ -3552,7 +3576,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3588,9 +3612,10 @@ ] }, "CheckoutDonationAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3599,6 +3624,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "donate" + ], "type" : "string" }, "url" : { @@ -3611,9 +3639,10 @@ ] }, "CheckoutOneTimePasscodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3640,6 +3669,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "oneTimePasscode" + ], "type" : "string" }, "url" : { @@ -3669,6 +3701,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3695,9 +3731,10 @@ ] }, "CheckoutQrCodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3710,6 +3747,9 @@ }, "type" : { "description" : "**qrCode**", + "enum" : [ + "qrCode" + ], "type" : "string" }, "url" : { @@ -3722,6 +3762,7 @@ ] }, "CheckoutRedirectAction" : { + "additionalProperties" : false, "properties" : { "data" : { "additionalProperties" : { @@ -3744,6 +3785,9 @@ }, "type" : { "description" : "**redirect**", + "enum" : [ + "redirect" + ], "type" : "string" }, "url" : { @@ -3756,9 +3800,10 @@ ] }, "CheckoutSDKAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3774,41 +3819,9 @@ }, "type" : { "description" : "The type of the action.", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2Action" : { - "properties" : { - "authorisationToken" : { - "description" : "A token needed to authorise a payment.", - "type" : "string" - }, - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "subtype" : { - "description" : "A subtype of the token.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the fingerprint.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2**", + "enum" : [ + "sdk" + ], "type" : "string" }, "url" : { @@ -3821,9 +3834,10 @@ ] }, "CheckoutThreeDS2ChallengeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3836,6 +3850,9 @@ }, "type" : { "description" : "**threeDS2Challenge**", + "enum" : [ + "threeDS2Challenge" + ], "type" : "string" }, "url" : { @@ -3848,9 +3865,10 @@ ] }, "CheckoutThreeDS2FingerPrintAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3863,6 +3881,9 @@ }, "type" : { "description" : "**threeDS2Fingerprint**", + "enum" : [ + "threeDS2Fingerprint" + ], "type" : "string" }, "url" : { @@ -3901,6 +3922,7 @@ } }, "CheckoutVoucherAction" : { + "additionalProperties" : false, "properties" : { "alternativeReference" : { "description" : "The voucher alternative reference code.", @@ -3947,7 +3969,7 @@ "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3976,6 +3998,9 @@ }, "type" : { "description" : "**voucher**", + "enum" : [ + "voucher" + ], "type" : "string" }, "url" : { @@ -4199,7 +4224,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4244,6 +4269,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4282,6 +4308,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -4290,6 +4317,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -4299,6 +4329,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -4326,6 +4357,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4362,6 +4394,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4370,6 +4403,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4496,6 +4532,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4515,6 +4552,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4525,6 +4565,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -4541,12 +4582,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4574,6 +4619,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4583,6 +4631,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4603,6 +4652,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4710,6 +4762,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4756,6 +4809,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4832,7 +4886,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4848,6 +4963,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4857,6 +4975,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4869,6 +4988,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4952,16 +5074,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -5003,6 +5130,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5031,12 +5159,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -5069,6 +5201,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -5078,6 +5213,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -5098,6 +5234,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -5179,9 +5318,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -5192,41 +5335,7 @@ "action" : { "x-addedInVersion" : 49, "description" : "Action to be taken for completing the payment.", - "oneOf" : [ - { - "$ref" : "#/components/schemas/CheckoutAwaitAction" - }, - { - "$ref" : "#/components/schemas/CheckoutBankTransferAction" - }, - { - "$ref" : "#/components/schemas/CheckoutDonationAction" - }, - { - "$ref" : "#/components/schemas/CheckoutOneTimePasscodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutQrCodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutRedirectAction" - }, - { - "$ref" : "#/components/schemas/CheckoutSDKAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction" - }, - { - "$ref" : "#/components/schemas/CheckoutVoucherAction" - } - ] + "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, "additionalData" : { "additionalProperties" : { @@ -5307,7 +5416,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5913,6 +6022,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6244,9 +6357,6 @@ { "$ref" : "#/components/schemas/CheckoutSDKAction" }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, { "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, @@ -6337,7 +6447,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -6564,6 +6674,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6798,7 +6912,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6843,6 +6957,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6851,6 +6966,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6860,6 +6978,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6888,6 +7007,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -7431,6 +7553,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7458,6 +7581,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -7467,6 +7593,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -7491,6 +7618,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -7707,6 +7837,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7722,6 +7853,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -8033,6 +8167,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -8053,6 +8188,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -8062,6 +8200,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -8073,6 +8212,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -8086,16 +8228,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -8106,12 +8253,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -8132,6 +8283,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -8592,12 +8746,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index ab335e8..1cc7a04 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1221,6 +1196,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1229,9 +1207,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1571,6 +1546,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1607,6 +1583,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2522,6 +2501,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2564,6 +2544,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2572,6 +2553,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2597,16 +2581,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2634,6 +2623,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2688,6 +2680,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -2704,6 +2697,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2752,6 +2748,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2773,6 +2770,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2792,6 +2790,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2922,6 +2923,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2955,6 +2957,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2978,6 +2987,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2989,6 +3001,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2997,15 +3010,19 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, "title" : "Cellulant" }, "CheckoutAwaitAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3014,6 +3031,9 @@ }, "type" : { "description" : "**await**", + "enum" : [ + "await" + ], "type" : "string" }, "url" : { @@ -3365,7 +3385,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3395,6 +3415,7 @@ ] }, "CheckoutBankTransferAction" : { + "additionalProperties" : false, "properties" : { "beneficiary" : { "description" : "The name of the account holder.", @@ -3430,6 +3451,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], "type" : "string" }, "url" : { @@ -3552,7 +3576,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3588,9 +3612,10 @@ ] }, "CheckoutDonationAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3599,6 +3624,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "donate" + ], "type" : "string" }, "url" : { @@ -3611,9 +3639,10 @@ ] }, "CheckoutOneTimePasscodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3640,6 +3669,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "oneTimePasscode" + ], "type" : "string" }, "url" : { @@ -3669,6 +3701,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3695,9 +3731,10 @@ ] }, "CheckoutQrCodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3710,6 +3747,9 @@ }, "type" : { "description" : "**qrCode**", + "enum" : [ + "qrCode" + ], "type" : "string" }, "url" : { @@ -3722,6 +3762,7 @@ ] }, "CheckoutRedirectAction" : { + "additionalProperties" : false, "properties" : { "data" : { "additionalProperties" : { @@ -3744,6 +3785,9 @@ }, "type" : { "description" : "**redirect**", + "enum" : [ + "redirect" + ], "type" : "string" }, "url" : { @@ -3756,9 +3800,10 @@ ] }, "CheckoutSDKAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3774,41 +3819,9 @@ }, "type" : { "description" : "The type of the action.", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2Action" : { - "properties" : { - "authorisationToken" : { - "description" : "A token needed to authorise a payment.", - "type" : "string" - }, - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "subtype" : { - "description" : "A subtype of the token.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the fingerprint.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2**", + "enum" : [ + "sdk" + ], "type" : "string" }, "url" : { @@ -3821,9 +3834,10 @@ ] }, "CheckoutThreeDS2ChallengeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3836,6 +3850,9 @@ }, "type" : { "description" : "**threeDS2Challenge**", + "enum" : [ + "threeDS2Challenge" + ], "type" : "string" }, "url" : { @@ -3848,9 +3865,10 @@ ] }, "CheckoutThreeDS2FingerPrintAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3863,6 +3881,9 @@ }, "type" : { "description" : "**threeDS2Fingerprint**", + "enum" : [ + "threeDS2Fingerprint" + ], "type" : "string" }, "url" : { @@ -3901,6 +3922,7 @@ } }, "CheckoutVoucherAction" : { + "additionalProperties" : false, "properties" : { "alternativeReference" : { "description" : "The voucher alternative reference code.", @@ -3947,7 +3969,7 @@ "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3976,6 +3998,9 @@ }, "type" : { "description" : "**voucher**", + "enum" : [ + "voucher" + ], "type" : "string" }, "url" : { @@ -4199,7 +4224,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4244,6 +4269,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4282,6 +4308,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -4290,6 +4317,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -4299,6 +4329,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -4326,6 +4357,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4362,6 +4394,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4370,6 +4403,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4496,6 +4532,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4515,6 +4552,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4525,6 +4565,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -4541,12 +4582,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4574,6 +4619,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4583,6 +4631,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4603,6 +4652,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4710,6 +4762,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4756,6 +4809,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4832,7 +4886,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4848,6 +4963,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4857,6 +4975,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4869,6 +4988,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4952,16 +5074,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -5003,6 +5130,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5031,12 +5159,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -5069,6 +5201,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -5078,6 +5213,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -5098,6 +5234,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -5179,9 +5318,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -5192,41 +5335,7 @@ "action" : { "x-addedInVersion" : 49, "description" : "Action to be taken for completing the payment.", - "oneOf" : [ - { - "$ref" : "#/components/schemas/CheckoutAwaitAction" - }, - { - "$ref" : "#/components/schemas/CheckoutBankTransferAction" - }, - { - "$ref" : "#/components/schemas/CheckoutDonationAction" - }, - { - "$ref" : "#/components/schemas/CheckoutOneTimePasscodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutQrCodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutRedirectAction" - }, - { - "$ref" : "#/components/schemas/CheckoutSDKAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction" - }, - { - "$ref" : "#/components/schemas/CheckoutVoucherAction" - } - ] + "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, "additionalData" : { "additionalProperties" : { @@ -5312,7 +5421,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5918,6 +6027,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6249,9 +6362,6 @@ { "$ref" : "#/components/schemas/CheckoutSDKAction" }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, { "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, @@ -6347,7 +6457,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -6574,6 +6684,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6808,7 +6922,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6853,6 +6967,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6861,6 +6976,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6870,6 +6988,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6898,6 +7017,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -7441,6 +7563,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7468,6 +7591,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -7477,6 +7603,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -7501,6 +7628,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -7717,6 +7847,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7732,6 +7863,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -8043,6 +8177,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -8063,6 +8198,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -8072,6 +8210,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -8083,6 +8222,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -8096,16 +8238,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -8116,12 +8263,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -8142,6 +8293,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -8602,12 +8756,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index 621ab07..ab4cef7 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1221,6 +1196,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1229,9 +1207,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1571,6 +1546,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1607,6 +1583,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2522,6 +2501,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2564,6 +2544,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2572,6 +2553,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2597,16 +2581,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2634,6 +2623,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2688,6 +2680,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -2704,6 +2697,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2752,6 +2748,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2773,6 +2770,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2792,6 +2790,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2922,6 +2923,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2955,6 +2957,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2978,6 +2987,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2989,6 +3001,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2997,15 +3010,19 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, "title" : "Cellulant" }, "CheckoutAwaitAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3014,6 +3031,9 @@ }, "type" : { "description" : "**await**", + "enum" : [ + "await" + ], "type" : "string" }, "url" : { @@ -3365,7 +3385,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3395,6 +3415,7 @@ ] }, "CheckoutBankTransferAction" : { + "additionalProperties" : false, "properties" : { "beneficiary" : { "description" : "The name of the account holder.", @@ -3430,6 +3451,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], "type" : "string" }, "url" : { @@ -3552,7 +3576,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3588,9 +3612,10 @@ ] }, "CheckoutDonationAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3599,6 +3624,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "donate" + ], "type" : "string" }, "url" : { @@ -3611,9 +3639,10 @@ ] }, "CheckoutOneTimePasscodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3640,6 +3669,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "oneTimePasscode" + ], "type" : "string" }, "url" : { @@ -3669,6 +3701,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3695,9 +3731,10 @@ ] }, "CheckoutQrCodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3710,6 +3747,9 @@ }, "type" : { "description" : "**qrCode**", + "enum" : [ + "qrCode" + ], "type" : "string" }, "url" : { @@ -3722,6 +3762,7 @@ ] }, "CheckoutRedirectAction" : { + "additionalProperties" : false, "properties" : { "data" : { "additionalProperties" : { @@ -3744,6 +3785,9 @@ }, "type" : { "description" : "**redirect**", + "enum" : [ + "redirect" + ], "type" : "string" }, "url" : { @@ -3756,9 +3800,10 @@ ] }, "CheckoutSDKAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3774,41 +3819,9 @@ }, "type" : { "description" : "The type of the action.", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2Action" : { - "properties" : { - "authorisationToken" : { - "description" : "A token needed to authorise a payment.", - "type" : "string" - }, - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "subtype" : { - "description" : "A subtype of the token.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the fingerprint.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2**", + "enum" : [ + "sdk" + ], "type" : "string" }, "url" : { @@ -3821,9 +3834,10 @@ ] }, "CheckoutThreeDS2ChallengeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3836,6 +3850,9 @@ }, "type" : { "description" : "**threeDS2Challenge**", + "enum" : [ + "threeDS2Challenge" + ], "type" : "string" }, "url" : { @@ -3848,9 +3865,10 @@ ] }, "CheckoutThreeDS2FingerPrintAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3863,6 +3881,9 @@ }, "type" : { "description" : "**threeDS2Fingerprint**", + "enum" : [ + "threeDS2Fingerprint" + ], "type" : "string" }, "url" : { @@ -3901,6 +3922,7 @@ } }, "CheckoutVoucherAction" : { + "additionalProperties" : false, "properties" : { "alternativeReference" : { "description" : "The voucher alternative reference code.", @@ -3947,7 +3969,7 @@ "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3976,6 +3998,9 @@ }, "type" : { "description" : "**voucher**", + "enum" : [ + "voucher" + ], "type" : "string" }, "url" : { @@ -4199,7 +4224,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4244,6 +4269,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4282,6 +4308,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -4290,6 +4317,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -4299,6 +4329,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -4326,6 +4357,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4362,6 +4394,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4370,6 +4403,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4496,6 +4532,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4515,6 +4552,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4525,6 +4565,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -4541,12 +4582,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4574,6 +4619,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4583,6 +4631,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4603,6 +4652,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4710,6 +4762,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4756,6 +4809,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4832,7 +4886,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4848,6 +4963,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4857,6 +4975,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4869,6 +4988,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4952,16 +5074,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -5003,6 +5130,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5031,12 +5159,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -5069,6 +5201,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -5078,6 +5213,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -5098,6 +5234,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -5179,9 +5318,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -5192,41 +5335,7 @@ "action" : { "x-addedInVersion" : 49, "description" : "Action to be taken for completing the payment.", - "oneOf" : [ - { - "$ref" : "#/components/schemas/CheckoutAwaitAction" - }, - { - "$ref" : "#/components/schemas/CheckoutBankTransferAction" - }, - { - "$ref" : "#/components/schemas/CheckoutDonationAction" - }, - { - "$ref" : "#/components/schemas/CheckoutOneTimePasscodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutQrCodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutRedirectAction" - }, - { - "$ref" : "#/components/schemas/CheckoutSDKAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction" - }, - { - "$ref" : "#/components/schemas/CheckoutVoucherAction" - } - ] + "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, "additionalData" : { "additionalProperties" : { @@ -5312,7 +5421,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5932,6 +6041,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6263,9 +6376,6 @@ { "$ref" : "#/components/schemas/CheckoutSDKAction" }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, { "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, @@ -6361,7 +6471,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -6588,6 +6698,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6822,7 +6936,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6867,6 +6981,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6875,6 +6990,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6884,6 +7002,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6912,6 +7031,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -7463,6 +7585,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7490,6 +7613,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -7499,6 +7625,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -7523,6 +7650,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -7739,6 +7869,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7754,6 +7885,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -8065,6 +8199,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -8085,6 +8220,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -8094,6 +8232,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -8105,6 +8244,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -8118,16 +8260,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -8138,12 +8285,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -8164,6 +8315,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -8624,12 +8778,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index e2ddc32..c6c3cdb 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1221,6 +1196,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1229,9 +1207,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1571,6 +1546,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1607,6 +1583,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2522,6 +2501,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2564,6 +2544,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2572,6 +2553,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2597,16 +2581,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2634,6 +2623,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2688,6 +2680,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -2704,6 +2697,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2752,6 +2748,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2773,6 +2770,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2792,6 +2790,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2922,6 +2923,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2955,6 +2957,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2978,6 +2987,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -2989,6 +3001,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -2997,15 +3010,19 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, "title" : "Cellulant" }, "CheckoutAwaitAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3014,6 +3031,9 @@ }, "type" : { "description" : "**await**", + "enum" : [ + "await" + ], "type" : "string" }, "url" : { @@ -3365,7 +3385,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3395,6 +3415,7 @@ ] }, "CheckoutBankTransferAction" : { + "additionalProperties" : false, "properties" : { "beneficiary" : { "description" : "The name of the account holder.", @@ -3430,6 +3451,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], "type" : "string" }, "url" : { @@ -3552,7 +3576,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3588,9 +3612,10 @@ ] }, "CheckoutDonationAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3599,6 +3624,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "donate" + ], "type" : "string" }, "url" : { @@ -3611,9 +3639,10 @@ ] }, "CheckoutOneTimePasscodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3640,6 +3669,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "oneTimePasscode" + ], "type" : "string" }, "url" : { @@ -3669,6 +3701,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3695,9 +3731,10 @@ ] }, "CheckoutQrCodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3710,6 +3747,9 @@ }, "type" : { "description" : "**qrCode**", + "enum" : [ + "qrCode" + ], "type" : "string" }, "url" : { @@ -3722,6 +3762,7 @@ ] }, "CheckoutRedirectAction" : { + "additionalProperties" : false, "properties" : { "data" : { "additionalProperties" : { @@ -3744,6 +3785,9 @@ }, "type" : { "description" : "**redirect**", + "enum" : [ + "redirect" + ], "type" : "string" }, "url" : { @@ -3756,9 +3800,10 @@ ] }, "CheckoutSDKAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3774,41 +3819,9 @@ }, "type" : { "description" : "The type of the action.", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2Action" : { - "properties" : { - "authorisationToken" : { - "description" : "A token needed to authorise a payment.", - "type" : "string" - }, - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "subtype" : { - "description" : "A subtype of the token.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the fingerprint.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2**", + "enum" : [ + "sdk" + ], "type" : "string" }, "url" : { @@ -3821,9 +3834,10 @@ ] }, "CheckoutThreeDS2ChallengeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3836,6 +3850,9 @@ }, "type" : { "description" : "**threeDS2Challenge**", + "enum" : [ + "threeDS2Challenge" + ], "type" : "string" }, "url" : { @@ -3848,9 +3865,10 @@ ] }, "CheckoutThreeDS2FingerPrintAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3863,6 +3881,9 @@ }, "type" : { "description" : "**threeDS2Fingerprint**", + "enum" : [ + "threeDS2Fingerprint" + ], "type" : "string" }, "url" : { @@ -3901,6 +3922,7 @@ } }, "CheckoutVoucherAction" : { + "additionalProperties" : false, "properties" : { "alternativeReference" : { "description" : "The voucher alternative reference code.", @@ -3947,7 +3969,7 @@ "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3976,6 +3998,9 @@ }, "type" : { "description" : "**voucher**", + "enum" : [ + "voucher" + ], "type" : "string" }, "url" : { @@ -4199,7 +4224,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4244,6 +4269,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4282,6 +4308,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -4290,6 +4317,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -4299,6 +4329,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -4326,6 +4357,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4362,6 +4394,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4370,6 +4403,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4496,6 +4532,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4515,6 +4552,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4525,6 +4565,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -4541,12 +4582,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4574,6 +4619,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4583,6 +4631,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4603,6 +4652,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4746,6 +4798,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4792,6 +4845,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4868,7 +4922,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4884,6 +4999,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4893,6 +5011,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4905,6 +5024,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -4988,16 +5110,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -5039,6 +5166,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5067,12 +5195,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -5105,6 +5237,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -5114,6 +5249,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -5134,6 +5270,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -5215,9 +5354,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -5228,41 +5371,7 @@ "action" : { "x-addedInVersion" : 49, "description" : "Action to be taken for completing the payment.", - "oneOf" : [ - { - "$ref" : "#/components/schemas/CheckoutAwaitAction" - }, - { - "$ref" : "#/components/schemas/CheckoutBankTransferAction" - }, - { - "$ref" : "#/components/schemas/CheckoutDonationAction" - }, - { - "$ref" : "#/components/schemas/CheckoutOneTimePasscodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutQrCodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutRedirectAction" - }, - { - "$ref" : "#/components/schemas/CheckoutSDKAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction" - }, - { - "$ref" : "#/components/schemas/CheckoutVoucherAction" - } - ] + "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, "additionalData" : { "additionalProperties" : { @@ -5359,7 +5468,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5987,6 +6096,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6318,9 +6431,6 @@ { "$ref" : "#/components/schemas/CheckoutSDKAction" }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, { "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, @@ -6427,7 +6537,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -6657,6 +6767,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6891,7 +7005,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6936,6 +7050,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6944,6 +7059,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6953,6 +7071,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6981,6 +7100,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -7532,6 +7654,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7559,6 +7682,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -7568,6 +7694,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -7592,6 +7719,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -7808,6 +7938,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7823,6 +7954,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -8134,6 +8268,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -8154,6 +8289,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -8163,6 +8301,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -8174,6 +8313,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -8187,16 +8329,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -8207,12 +8354,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -8233,6 +8384,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -8693,12 +8847,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index f7beb58..d6d7d64 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1221,6 +1196,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1229,9 +1207,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1571,6 +1546,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1607,6 +1583,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2522,6 +2501,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2564,6 +2544,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2572,6 +2553,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2597,16 +2581,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2634,6 +2623,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2688,6 +2680,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "x-addedInVersion" : 65, @@ -2719,6 +2712,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2767,6 +2763,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2788,6 +2785,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2807,6 +2805,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2937,6 +2938,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2970,6 +2972,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2993,6 +3002,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -3004,6 +3016,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -3012,15 +3025,19 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, "title" : "Cellulant" }, "CheckoutAwaitAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3029,6 +3046,9 @@ }, "type" : { "description" : "**await**", + "enum" : [ + "await" + ], "type" : "string" }, "url" : { @@ -3374,7 +3394,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3409,6 +3429,7 @@ ] }, "CheckoutBankTransferAction" : { + "additionalProperties" : false, "properties" : { "beneficiary" : { "description" : "The name of the account holder.", @@ -3444,6 +3465,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], "type" : "string" }, "url" : { @@ -3566,7 +3590,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3602,9 +3626,10 @@ ] }, "CheckoutDonationAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3613,6 +3638,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "donate" + ], "type" : "string" }, "url" : { @@ -3625,9 +3653,10 @@ ] }, "CheckoutOneTimePasscodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3654,6 +3683,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "oneTimePasscode" + ], "type" : "string" }, "url" : { @@ -3683,6 +3715,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3709,9 +3745,10 @@ ] }, "CheckoutQrCodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3724,6 +3761,9 @@ }, "type" : { "description" : "**qrCode**", + "enum" : [ + "qrCode" + ], "type" : "string" }, "url" : { @@ -3736,6 +3776,7 @@ ] }, "CheckoutRedirectAction" : { + "additionalProperties" : false, "properties" : { "data" : { "additionalProperties" : { @@ -3758,6 +3799,9 @@ }, "type" : { "description" : "**redirect**", + "enum" : [ + "redirect" + ], "type" : "string" }, "url" : { @@ -3770,9 +3814,10 @@ ] }, "CheckoutSDKAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3788,41 +3833,9 @@ }, "type" : { "description" : "The type of the action.", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2Action" : { - "properties" : { - "authorisationToken" : { - "description" : "A token needed to authorise a payment.", - "type" : "string" - }, - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "subtype" : { - "description" : "A subtype of the token.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the fingerprint.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2**", + "enum" : [ + "sdk" + ], "type" : "string" }, "url" : { @@ -3835,9 +3848,10 @@ ] }, "CheckoutThreeDS2ChallengeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3850,6 +3864,9 @@ }, "type" : { "description" : "**threeDS2Challenge**", + "enum" : [ + "threeDS2Challenge" + ], "type" : "string" }, "url" : { @@ -3862,9 +3879,10 @@ ] }, "CheckoutThreeDS2FingerPrintAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3877,6 +3895,9 @@ }, "type" : { "description" : "**threeDS2Fingerprint**", + "enum" : [ + "threeDS2Fingerprint" + ], "type" : "string" }, "url" : { @@ -3915,6 +3936,7 @@ } }, "CheckoutVoucherAction" : { + "additionalProperties" : false, "properties" : { "alternativeReference" : { "description" : "The voucher alternative reference code.", @@ -3961,7 +3983,7 @@ "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3990,6 +4012,9 @@ }, "type" : { "description" : "**voucher**", + "enum" : [ + "voucher" + ], "type" : "string" }, "url" : { @@ -4218,7 +4243,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4263,6 +4288,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4301,6 +4327,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -4309,6 +4336,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -4318,6 +4348,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -4345,6 +4376,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4381,6 +4413,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4389,6 +4422,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4515,6 +4551,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4534,6 +4571,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4544,6 +4584,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -4560,12 +4601,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4593,6 +4638,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4602,6 +4650,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4622,6 +4671,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4765,6 +4817,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4811,6 +4864,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4887,7 +4941,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4903,6 +5018,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4912,6 +5030,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4924,6 +5043,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -5007,16 +5129,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -5058,6 +5185,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5086,12 +5214,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -5124,6 +5256,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -5133,6 +5268,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -5153,6 +5289,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -5234,9 +5373,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -5247,41 +5390,7 @@ "action" : { "x-addedInVersion" : 49, "description" : "Action to be taken for completing the payment.", - "oneOf" : [ - { - "$ref" : "#/components/schemas/CheckoutAwaitAction" - }, - { - "$ref" : "#/components/schemas/CheckoutBankTransferAction" - }, - { - "$ref" : "#/components/schemas/CheckoutDonationAction" - }, - { - "$ref" : "#/components/schemas/CheckoutOneTimePasscodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutQrCodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutRedirectAction" - }, - { - "$ref" : "#/components/schemas/CheckoutSDKAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction" - }, - { - "$ref" : "#/components/schemas/CheckoutVoucherAction" - } - ] + "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, "additionalData" : { "additionalProperties" : { @@ -5378,7 +5487,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5967,6 +6076,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6298,9 +6411,6 @@ { "$ref" : "#/components/schemas/CheckoutSDKAction" }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, { "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, @@ -6407,7 +6517,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -6631,6 +6741,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6865,7 +6979,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6910,6 +7024,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6918,6 +7033,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6927,6 +7045,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6955,6 +7074,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -7526,6 +7648,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7553,6 +7676,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -7562,6 +7688,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -7586,6 +7713,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -7802,6 +7932,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7817,6 +7948,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -8128,6 +8262,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -8148,6 +8283,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -8157,6 +8295,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -8168,6 +8307,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -8181,16 +8323,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -8201,12 +8348,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -8227,6 +8378,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -8689,12 +8843,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index 0d80ca2..ba64f2b 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -507,11 +507,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -522,11 +517,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,11 +527,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -552,11 +537,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -567,11 +547,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1052,7 +1027,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1221,6 +1196,9 @@ "content" : { "application/json" : { "examples" : { + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" + }, "3d-secure-2-challenge" : { "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" }, @@ -1229,9 +1207,6 @@ }, "3d-secure" : { "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" } }, "schema" : { @@ -1571,6 +1546,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1607,6 +1583,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2522,6 +2501,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2564,6 +2544,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2572,6 +2553,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2597,16 +2581,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2634,6 +2623,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2688,6 +2680,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "x-addedInVersion" : 65, @@ -2719,6 +2712,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2767,6 +2763,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2788,6 +2785,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2807,6 +2805,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2937,6 +2938,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2970,6 +2972,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2993,6 +3002,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -3004,6 +3016,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -3012,15 +3025,19 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, "title" : "Cellulant" }, "CheckoutAwaitAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3029,6 +3046,9 @@ }, "type" : { "description" : "**await**", + "enum" : [ + "await" + ], "type" : "string" }, "url" : { @@ -3374,7 +3394,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3409,6 +3429,7 @@ ] }, "CheckoutBankTransferAction" : { + "additionalProperties" : false, "properties" : { "beneficiary" : { "description" : "The name of the account holder.", @@ -3444,6 +3465,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], "type" : "string" }, "url" : { @@ -3566,7 +3590,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3602,9 +3626,10 @@ ] }, "CheckoutDonationAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3613,6 +3638,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "donate" + ], "type" : "string" }, "url" : { @@ -3625,9 +3653,10 @@ ] }, "CheckoutOneTimePasscodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3654,6 +3683,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "oneTimePasscode" + ], "type" : "string" }, "url" : { @@ -3683,6 +3715,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3709,9 +3745,10 @@ ] }, "CheckoutQrCodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3724,6 +3761,9 @@ }, "type" : { "description" : "**qrCode**", + "enum" : [ + "qrCode" + ], "type" : "string" }, "url" : { @@ -3736,6 +3776,7 @@ ] }, "CheckoutRedirectAction" : { + "additionalProperties" : false, "properties" : { "data" : { "additionalProperties" : { @@ -3758,6 +3799,9 @@ }, "type" : { "description" : "**redirect**", + "enum" : [ + "redirect" + ], "type" : "string" }, "url" : { @@ -3770,9 +3814,10 @@ ] }, "CheckoutSDKAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3788,41 +3833,9 @@ }, "type" : { "description" : "The type of the action.", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2Action" : { - "properties" : { - "authorisationToken" : { - "description" : "A token needed to authorise a payment.", - "type" : "string" - }, - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "subtype" : { - "description" : "A subtype of the token.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the fingerprint.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2**", + "enum" : [ + "sdk" + ], "type" : "string" }, "url" : { @@ -3835,9 +3848,10 @@ ] }, "CheckoutThreeDS2ChallengeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3850,6 +3864,9 @@ }, "type" : { "description" : "**threeDS2Challenge**", + "enum" : [ + "threeDS2Challenge" + ], "type" : "string" }, "url" : { @@ -3862,9 +3879,10 @@ ] }, "CheckoutThreeDS2FingerPrintAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3877,6 +3895,9 @@ }, "type" : { "description" : "**threeDS2Fingerprint**", + "enum" : [ + "threeDS2Fingerprint" + ], "type" : "string" }, "url" : { @@ -3915,6 +3936,7 @@ } }, "CheckoutVoucherAction" : { + "additionalProperties" : false, "properties" : { "alternativeReference" : { "description" : "The voucher alternative reference code.", @@ -3961,7 +3983,7 @@ "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3990,6 +4012,9 @@ }, "type" : { "description" : "**voucher**", + "enum" : [ + "voucher" + ], "type" : "string" }, "url" : { @@ -4218,7 +4243,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4263,6 +4288,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4301,6 +4327,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -4309,6 +4336,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -4318,6 +4348,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -4345,6 +4376,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4381,6 +4413,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4389,6 +4422,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4515,6 +4551,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4534,6 +4571,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4544,6 +4584,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -4560,12 +4601,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4593,6 +4638,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4602,6 +4650,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4622,6 +4671,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4765,6 +4817,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4811,6 +4864,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4887,7 +4941,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4903,6 +5018,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4912,6 +5030,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4924,6 +5043,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -5007,16 +5129,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -5058,6 +5185,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5086,12 +5214,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -5124,6 +5256,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -5133,6 +5268,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -5153,6 +5289,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -5234,9 +5373,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -5247,41 +5390,7 @@ "action" : { "x-addedInVersion" : 49, "description" : "Action to be taken for completing the payment.", - "oneOf" : [ - { - "$ref" : "#/components/schemas/CheckoutAwaitAction" - }, - { - "$ref" : "#/components/schemas/CheckoutBankTransferAction" - }, - { - "$ref" : "#/components/schemas/CheckoutDonationAction" - }, - { - "$ref" : "#/components/schemas/CheckoutOneTimePasscodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutQrCodeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutRedirectAction" - }, - { - "$ref" : "#/components/schemas/CheckoutSDKAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction" - }, - { - "$ref" : "#/components/schemas/CheckoutVoucherAction" - } - ] + "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, "additionalData" : { "additionalProperties" : { @@ -5383,7 +5492,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "redirect" : { @@ -5972,6 +6081,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6303,9 +6416,6 @@ { "$ref" : "#/components/schemas/CheckoutSDKAction" }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2Action" - }, { "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" }, @@ -6417,7 +6527,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "redirect" : { @@ -6641,6 +6751,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6875,7 +6989,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6920,6 +7034,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6928,6 +7043,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6937,6 +7055,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6965,6 +7084,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -7536,6 +7658,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7563,6 +7686,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -7572,6 +7698,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -7596,6 +7723,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -7812,6 +7942,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7827,6 +7958,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -8138,6 +8272,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -8158,6 +8293,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -8167,6 +8305,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -8178,6 +8317,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -8191,16 +8333,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -8211,12 +8358,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -8237,6 +8388,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -8699,12 +8853,12 @@ "paymentData" : "YOUR_PAYMENT_DATA..." } }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { - "paymentData" : "Hee57361f99....", + "paymentData" : "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...", "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index 6cbdff6..66035f0 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -509,11 +509,6 @@ "400" : { "content" : { "application/json" : { - "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -524,11 +519,6 @@ "401" : { "content" : { "application/json" : { - "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -539,11 +529,6 @@ "403" : { "content" : { "application/json" : { - "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -554,11 +539,6 @@ "422" : { "content" : { "application/json" : { - "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -569,11 +549,6 @@ "500" : { "content" : { "application/json" : { - "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" - } - }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1054,7 +1029,7 @@ "/payments" : { "post" : { "summary" : "Starts a transaction.", - "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**).\n* For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.", + "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", "x-groupName" : "Payments", "x-sortIndex" : 2, @@ -1223,17 +1198,11 @@ "content" : { "application/json" : { "examples" : { - "3d-secure-2-challenge" : { - "$ref" : "#/components/examples/post-payments-details-3d-secure-2-challenge" + "redirect" : { + "$ref" : "#/components/examples/post-payments-details-redirect" }, - "3d-secure-2-fingerprint" : { - "$ref" : "#/components/examples/post-payments-details-3d-secure-2-fingerprint" - }, - "3d-secure" : { - "$ref" : "#/components/examples/post-payments-details-3d-secure" - }, - "app-switch" : { - "$ref" : "#/components/examples/post-payments-details-app-switch" + "3d-secure-2-native" : { + "$ref" : "#/components/examples/post-payments-details-3d-secure-2-native" } }, "schema" : { @@ -1573,6 +1542,7 @@ } }, "AchDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "description" : "The bank account number (without separators).", @@ -1609,6 +1579,9 @@ "type" : { "default" : "ach", "description" : "**ach**", + "enum" : [ + "ach" + ], "type" : "string" } }, @@ -2524,6 +2497,7 @@ ] }, "AfterpayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -2566,6 +2540,7 @@ "title" : "Afterpay" }, "AmazonPayDetails" : { + "additionalProperties" : false, "properties" : { "amazonPayToken" : { "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", @@ -2574,6 +2549,9 @@ "type" : { "default" : "amazonpay", "description" : "**amazonpay**", + "enum" : [ + "amazonpay" + ], "type" : "string" } }, @@ -2599,16 +2577,21 @@ ] }, "AndroidPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "androidpay", "description" : "**androidpay**", + "enum" : [ + "androidpay" + ], "type" : "string" } }, "title" : "Android Pay" }, "ApplePayDetails" : { + "additionalProperties" : false, "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", @@ -2636,6 +2619,9 @@ "type" : { "default" : "applepay", "description" : "**applepay**", + "enum" : [ + "applepay" + ], "type" : "string" } }, @@ -2690,6 +2676,7 @@ } }, "BacsDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "bankAccountNumber" : { "x-addedInVersion" : 65, @@ -2721,6 +2708,9 @@ "type" : { "default" : "directdebit_GB", "description" : "**directdebit_GB**", + "enum" : [ + "directdebit_GB" + ], "type" : "string" } }, @@ -2769,6 +2759,7 @@ } }, "BillDeskDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -2790,6 +2781,7 @@ "title" : "BillDesk" }, "BlikDetails" : { + "additionalProperties" : false, "properties" : { "blikCode" : { "description" : "BLIK code consisting of 6 digits.", @@ -2809,6 +2801,9 @@ }, "type" : { "description" : "**blik**", + "enum" : [ + "blik" + ], "type" : "string" } }, @@ -2939,6 +2934,7 @@ ] }, "CardDetails" : { + "additionalProperties" : false, "properties" : { "cupsecureplus.smscode" : { "deprecated" : true, @@ -2972,6 +2968,13 @@ "description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", "type" : "string" }, + "fundingSource" : { + "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", + "enum" : [ + "debit" + ], + "type" : "string" + }, "holderName" : { "description" : "The name of the card holder.", "type" : "string" @@ -2995,6 +2998,9 @@ "type" : { "default" : "scheme", "description" : "**scheme**", + "enum" : [ + "giftcard" + ], "type" : "string" } }, @@ -3006,6 +3012,7 @@ "title" : "Card" }, "CellulantDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Cellulant issuer.", @@ -3014,15 +3021,19 @@ "type" : { "default" : "cellulant", "description" : "**Cellulant**", + "enum" : [ + "cellulant" + ], "type" : "string" } }, "title" : "Cellulant" }, "CheckoutAwaitAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3031,6 +3042,9 @@ }, "type" : { "description" : "**await**", + "enum" : [ + "await" + ], "type" : "string" }, "url" : { @@ -3376,7 +3390,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3411,6 +3425,7 @@ ] }, "CheckoutBankTransferAction" : { + "additionalProperties" : false, "properties" : { "beneficiary" : { "description" : "The name of the account holder.", @@ -3446,6 +3461,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], "type" : "string" }, "url" : { @@ -3568,7 +3586,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -3604,9 +3622,10 @@ ] }, "CheckoutDonationAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3615,6 +3634,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "donate" + ], "type" : "string" }, "url" : { @@ -3627,9 +3649,10 @@ ] }, "CheckoutOneTimePasscodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3656,6 +3679,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "oneTimePasscode" + ], "type" : "string" }, "url" : { @@ -3685,6 +3711,10 @@ }, "CheckoutOrderResponse" : { "properties" : { + "amount" : { + "description" : "The initial amount of the order.", + "$ref" : "#/components/schemas/Amount" + }, "expiresAt" : { "description" : "The expiry date for the order.", "type" : "string" @@ -3711,9 +3741,10 @@ ] }, "CheckoutQrCodeAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3726,6 +3757,9 @@ }, "type" : { "description" : "**qrCode**", + "enum" : [ + "qrCode" + ], "type" : "string" }, "url" : { @@ -3738,6 +3772,7 @@ ] }, "CheckoutRedirectAction" : { + "additionalProperties" : false, "properties" : { "data" : { "additionalProperties" : { @@ -3756,6 +3791,9 @@ }, "type" : { "description" : "**redirect**", + "enum" : [ + "redirect" + ], "type" : "string" }, "url" : { @@ -3768,9 +3806,10 @@ ] }, "CheckoutSDKAction" : { + "additionalProperties" : false, "properties" : { "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3786,6 +3825,9 @@ }, "type" : { "description" : "The type of the action.", + "enum" : [ + "sdk" + ], "type" : "string" }, "url" : { @@ -3798,13 +3840,14 @@ ] }, "CheckoutThreeDS2Action" : { + "additionalProperties" : false, "properties" : { "authorisationToken" : { "description" : "A token needed to authorise a payment.", "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3821,60 +3864,9 @@ }, "type" : { "description" : "**threeDS2**", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2ChallengeAction" : { - "properties" : { - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the challenge.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2Challenge**", - "type" : "string" - }, - "url" : { - "description" : "Specifies the URL to redirect to.", - "type" : "string" - } - }, - "required" : [ - "type" - ] - }, - "CheckoutThreeDS2FingerPrintAction" : { - "properties" : { - "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", - "type" : "string" - }, - "paymentMethodType" : { - "description" : "Specifies the payment method.", - "type" : "string" - }, - "token" : { - "description" : "A token to pass to the 3DS2 Component to get the fingerprint.", - "type" : "string" - }, - "type" : { - "description" : "**threeDS2Fingerprint**", + "enum" : [ + "threeDS2" + ], "type" : "string" }, "url" : { @@ -3913,6 +3905,7 @@ } }, "CheckoutVoucherAction" : { + "additionalProperties" : false, "properties" : { "alternativeReference" : { "description" : "The voucher alternative reference code.", @@ -3959,7 +3952,7 @@ "type" : "string" }, "paymentData" : { - "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment. In v67 and later, you will always get this value from the Component.", + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", "type" : "string" }, "paymentMethodType" : { @@ -3988,6 +3981,9 @@ }, "type" : { "description" : "**voucher**", + "enum" : [ + "voucher" + ], "type" : "string" }, "url" : { @@ -4216,7 +4212,7 @@ "$ref" : "#/components/schemas/PaymentCompletionDetails" }, "paymentData" : { - "description" : "The `paymentData` value from the `/payments` response. In v67 and later, you will always get this value from the Component.", + "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4261,6 +4257,7 @@ } }, "DokuDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4299,6 +4296,7 @@ "title" : "Doku" }, "DotpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", @@ -4307,6 +4305,9 @@ "type" : { "default" : "dotpay", "description" : "**dotpay**", + "enum" : [ + "dotpay" + ], "type" : "string" } }, @@ -4316,6 +4317,7 @@ "title" : "Dotpay" }, "DragonpayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.", @@ -4343,6 +4345,7 @@ "title" : "Dragonpay" }, "EcontextVoucherDetails" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The shopper's first name.", @@ -4379,6 +4382,7 @@ "title" : "Voucher" }, "EntercashDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4387,6 +4391,9 @@ "type" : { "default" : "entercash", "description" : "**entercash**", + "enum" : [ + "entercash" + ], "type" : "string" } }, @@ -4513,6 +4520,7 @@ ] }, "GenericIssuerPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The issuer id of the shopper's selected bank.", @@ -4532,6 +4540,9 @@ }, "type" : { "description" : "**genericissuer**", + "enum" : [ + "eps" + ], "type" : "string" } }, @@ -4542,6 +4553,7 @@ "title" : "Stored Payment Method" }, "GiropayDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -4558,12 +4570,16 @@ "type" : { "default" : "giropay", "description" : "**giropay**", + "enum" : [ + "giropay" + ], "type" : "string" } }, "title" : "Giropay" }, "GooglePayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4591,6 +4607,9 @@ "type" : { "default" : "paywithgoogle", "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], "type" : "string" } }, @@ -4600,6 +4619,7 @@ "title" : "Google Pay" }, "IdealDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", @@ -4620,6 +4640,9 @@ "type" : { "default" : "ideal", "description" : "**ideal**", + "enum" : [ + "ideal" + ], "type" : "string" } }, @@ -4763,6 +4786,7 @@ } }, "KlarnaDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -4809,6 +4833,7 @@ "title" : "Klarna" }, "LianLianPayDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -4885,7 +4910,68 @@ } } }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MasterpassDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4901,6 +4987,9 @@ "type" : { "default" : "masterpass", "description" : "**masterpass**", + "enum" : [ + "masterpass" + ], "type" : "string" } }, @@ -4910,6 +4999,7 @@ "title" : "Masterpass" }, "MbwayDetails" : { + "additionalProperties" : false, "properties" : { "shopperEmail" : { "description" : "", @@ -4922,6 +5012,9 @@ "type" : { "default" : "mbway", "description" : "**mbway**", + "enum" : [ + "mbway" + ], "type" : "string" } }, @@ -5005,16 +5098,21 @@ } }, "MobilePayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "mobilepay", "description" : "**mobilepay**", + "enum" : [ + "mobilepay" + ], "type" : "string" } }, "title" : "MobilePay" }, "MolPayDetails" : { + "additionalProperties" : false, "properties" : { "issuer" : { "description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.", @@ -5056,6 +5154,7 @@ ] }, "OpenInvoiceDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -5084,12 +5183,16 @@ "type" : { "default" : "openinvoice", "description" : "**openinvoice**", + "enum" : [ + "openinvoice" + ], "type" : "string" } }, "title" : "Open Invoice" }, "PayPalDetails" : { + "additionalProperties" : false, "properties" : { "orderID" : { "description" : "The unique ID associated with the order.", @@ -5122,6 +5225,9 @@ "type" : { "default" : "paypal", "description" : "**paypal**", + "enum" : [ + "paypal" + ], "type" : "string" } }, @@ -5131,6 +5237,7 @@ "title" : "PayPal" }, "PayUUpiDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -5151,6 +5258,9 @@ "type" : { "default" : "payu_IN_upi", "description" : "**payu_IN_upi**", + "enum" : [ + "payu_IN_upi" + ], "type" : "string" }, "virtualPaymentAddress" : { @@ -5232,9 +5342,13 @@ } }, "PaymentDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "description" : "The payment method type.", + "enum" : [ + "multibanco" + ], "type" : "string" } }, @@ -5305,7 +5419,7 @@ "$ref" : "#/components/schemas/CheckoutOrderResponse" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -5887,6 +6001,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6221,12 +6339,6 @@ { "$ref" : "#/components/schemas/CheckoutThreeDS2Action" }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction" - }, - { - "$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction" - }, { "$ref" : "#/components/schemas/CheckoutVoucherAction" } @@ -6295,7 +6407,7 @@ "$ref" : "#/components/schemas/CheckoutOrderResponse" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.", "type" : "string" }, "refusalReason" : { @@ -6512,6 +6624,10 @@ }, "type" : "array" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -6746,7 +6862,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { @@ -6791,6 +6907,7 @@ ] }, "QiwiWalletDetails" : { + "additionalProperties" : false, "properties" : { "telephoneNumber" : { "description" : "", @@ -6799,6 +6916,9 @@ "type" : { "default" : "qiwiwallet", "description" : "**qiwiwallet**", + "enum" : [ + "qiwiwallet" + ], "type" : "string" } }, @@ -6808,6 +6928,7 @@ "title" : "QIWI" }, "RatepayDetails" : { + "additionalProperties" : false, "properties" : { "billingAddress" : { "description" : "The address where to send the invoice.", @@ -6836,6 +6957,9 @@ "type" : { "default" : "ratepay", "description" : "**ratepay**", + "enum" : [ + "ratepay" + ], "type" : "string" } }, @@ -7407,6 +7531,7 @@ } }, "SamsungPayDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -7434,6 +7559,9 @@ "type" : { "default" : "samsungpay", "description" : "**samsungpay**", + "enum" : [ + "samsungpay" + ], "type" : "string" } }, @@ -7443,6 +7571,7 @@ "title" : "Samsung Pay" }, "SepaDirectDebitDetails" : { + "additionalProperties" : false, "properties" : { "iban" : { "description" : "The International Bank Account Number (IBAN).", @@ -7467,6 +7596,9 @@ "type" : { "default" : "sepadirectdebit", "description" : "**sepadirectdebit**", + "enum" : [ + "sepadirectdebit" + ], "type" : "string" } }, @@ -7693,6 +7825,7 @@ } }, "StoredPaymentMethodDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -7708,6 +7841,9 @@ }, "type" : { "description" : "The payment method type.", + "enum" : [ + "grabpay_SG" + ], "type" : "string" } }, @@ -8048,6 +8184,7 @@ "title" : "UPI" }, "VippsDetails" : { + "additionalProperties" : false, "properties" : { "recurringDetailReference" : { "deprecated" : true, @@ -8068,6 +8205,9 @@ "type" : { "default" : "vipps", "description" : "**vipps**", + "enum" : [ + "vipps" + ], "type" : "string" } }, @@ -8077,6 +8217,7 @@ "title" : "Vipps" }, "VisaCheckoutDetails" : { + "additionalProperties" : false, "properties" : { "fundingSource" : { "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -8088,6 +8229,9 @@ "type" : { "default" : "visacheckout", "description" : "**visacheckout**", + "enum" : [ + "visacheckout" + ], "type" : "string" }, "visaCheckoutCallId" : { @@ -8101,16 +8245,21 @@ "title" : "Visa Checkout" }, "WeChatPayDetails" : { + "additionalProperties" : false, "properties" : { "type" : { "default" : "wechatpay", "description" : "**wechatpay**", + "enum" : [ + "wechatpay" + ], "type" : "string" } }, "title" : "WeChat Pay" }, "WeChatPayMiniProgramDetails" : { + "additionalProperties" : false, "properties" : { "appId" : { "type" : "string" @@ -8121,12 +8270,16 @@ "type" : { "default" : "wechatpayMiniProgram", "description" : "**wechatpayMiniProgram**", + "enum" : [ + "wechatpayMiniProgram" + ], "type" : "string" } }, "title" : "WeChat Pay - Mini Program" }, "ZipDetails" : { + "additionalProperties" : false, "properties" : { "clickAndCollect" : { "description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.", @@ -8147,6 +8300,9 @@ "type" : { "default" : "zip", "description" : "**zip**", + "enum" : [ + "zip" + ], "type" : "string" } }, @@ -8581,40 +8737,19 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-details-3d-secure" : { - "summary" : "Submit details for the 3D Secure payment ", + "post-payments-details-3d-secure-2-native" : { + "summary" : "Submit 3D Secure 2 authentication result", "value" : { - "paymentData" : "Hee57361f99....", "details" : { - "MD" : "Ab02b4c0!BQABAgCW5sxB4e/==...", - "PaRes" : "eNrNV0mTo7gS..." + "threeDSResult" : "eyJ0cmFuc1N0YXR1cyI6IlkifQ==" } } }, - "post-payments-details-3d-secure-2-challenge" : { - "summary" : "Submit 3D Secure 2 callenge flow result", + "post-payments-details-redirect" : { + "summary" : "Submit the redirect result", "value" : { "details" : { - "threeds2.challengeResult" : "eyJ0cmFuc1N0YXR1cyI6IlkifQ==" - }, - "paymentData" : "YOUR_PAYMENT_DATA" - } - }, - "post-payments-details-3d-secure-2-fingerprint" : { - "summary" : "Submit 3D Secure 2 device fingerprinting result", - "value" : { - "details" : { - "threeds2.fingerprint" : "eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=" - }, - "paymentData" : "YOUR_PAYMENT_DATA..." - } - }, - "post-payments-details-app-switch" : { - "summary" : "Submit details for the payment with involved app switch", - "value" : { - "paymentData" : "Hee57361f99....", - "details" : { - "returnUrlQueryString" : "ref=eNrNV0mTo7gS&id=An78i..." + "redirectResult" : "X6XtfGC3!Y..." } } }, diff --git a/json/MarketPayNotificationService-v3.json b/json/MarketPayNotificationService-v3.json index 964a5d9..afd05b6 100644 --- a/json/MarketPayNotificationService-v3.json +++ b/json/MarketPayNotificationService-v3.json @@ -779,7 +779,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Each of the bank accounts associated with the account holder.\n> Each array entry should represent one bank account.\n> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -970,13 +970,25 @@ "description" : "The code of the account holder.", "type" : "string" }, + "newStatus" : { + "x-addedInVersion" : 2, + "description" : "The new status of the account holder.", + "$ref" : "#/components/schemas/AccountHolderStatus" + }, + "oldStatus" : { + "x-addedInVersion" : 2, + "description" : "The former status of the account holder.", + "$ref" : "#/components/schemas/AccountHolderStatus" + }, "reason" : { "description" : "The reason for the status change.", "type" : "string" } }, "required" : [ - "accountHolderCode" + "accountHolderCode", + "oldStatus", + "newStatus" ] }, "AccountHolderStoreStatusChangeNotification" : { @@ -1498,7 +1510,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Each of the shareholders associated with the company.\nEach array entry should represent one shareholder.", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -2225,25 +2237,25 @@ "PersonalDocumentData" : { "properties" : { "expirationDate" : { - "description" : "The expiration date of the document.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "issuerCountry" : { - "description" : "The two-character country code of the issuer.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "issuerState" : { - "description" : "The state issued the document (if applicable)", + "description" : "The state where the document was issued (if applicable).", "type" : "string" }, "number" : { - "description" : "The number of the document. Delete the given type if the value empty.", + "description" : "The number in the document.", "type" : "string" }, "type" : { - "description" : "The type of the document. More then one item pert type does not allowed.\nValid values: ID, PASSPORT, VISA, DRIVINGLICENSE", + "description" : "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ", "enum" : [ "DRIVINGLICENSE", "ID", @@ -2452,47 +2464,47 @@ "ShareholderContact" : { "properties" : { "address" : { - "description" : "The address of the contact.", + "description" : "The address of the person.", "$ref" : "#/components/schemas/ViasAddress" }, "email" : { - "description" : "The e-mail address of the contact.", + "description" : "The e-mail address of the person.", "type" : "string" }, "fullPhoneNumber" : { - "description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, "jobTitle" : { - "description" : "Job title of the shareholder. Required when the `shareholderType` is **Control**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", + "description" : "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", "type" : "string" }, "name" : { - "description" : "The name of the contact.", + "description" : "The name of the person.", "$ref" : "#/components/schemas/ViasName" }, "personalData" : { - "description" : "Contains information about the shareholder.", + "description" : "Contains information about the person.", "$ref" : "#/components/schemas/ViasPersonalData" }, "phoneNumber" : { - "description" : "The phone number of the contact.", + "description" : "The phone number of the person.", "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shareholderCode" : { - "description" : "The unique identifier (UUID) of the shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", + "description" : "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", "type" : "string" }, "shareholderType" : { - "description" : "The type of shareholder. \n\nPossible values: \n\n* **Ownership**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Control**: Individuals who are members of senior management staff responsible for managing the company.", + "description" : "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.", "enum" : [ - "Control", - "Ownership" + "Controller", + "Owner" ], "type" : "string" }, "webAddress" : { - "description" : "The URL of the website of the contact.", + "description" : "The URL of the person's website.", "type" : "string" } } @@ -2873,12 +2885,12 @@ "ViasPersonalData" : { "properties" : { "dateOfBirth" : { - "description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "documentData" : { "x-addedInVersion" : 3, - "description" : "Key value pairs of document type and identify numbers", + "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" }, @@ -2890,7 +2902,7 @@ "type" : "string" }, "nationality" : { - "description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.\n", "maxLength" : 2, "minLength" : 2, "type" : "string" diff --git a/json/MarketPayNotificationService-v4.json b/json/MarketPayNotificationService-v4.json index 5843114..0dacad4 100644 --- a/json/MarketPayNotificationService-v4.json +++ b/json/MarketPayNotificationService-v4.json @@ -807,7 +807,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Each of the bank accounts associated with the account holder.\n> Each array entry should represent one bank account.\n> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -1012,13 +1012,25 @@ "description" : "The code of the account holder.", "type" : "string" }, + "newStatus" : { + "x-addedInVersion" : 2, + "description" : "The new status of the account holder.", + "$ref" : "#/components/schemas/AccountHolderStatus" + }, + "oldStatus" : { + "x-addedInVersion" : 2, + "description" : "The former status of the account holder.", + "$ref" : "#/components/schemas/AccountHolderStatus" + }, "reason" : { "description" : "The reason for the status change.", "type" : "string" } }, "required" : [ - "accountHolderCode" + "accountHolderCode", + "oldStatus", + "newStatus" ] }, "AccountHolderStoreStatusChangeNotification" : { @@ -1584,7 +1596,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Each of the shareholders associated with the company.\nEach array entry should represent one shareholder.", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -2342,25 +2354,25 @@ "PersonalDocumentData" : { "properties" : { "expirationDate" : { - "description" : "The expiration date of the document.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "issuerCountry" : { - "description" : "The two-character country code of the issuer.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "issuerState" : { - "description" : "The state issued the document (if applicable)", + "description" : "The state where the document was issued (if applicable).", "type" : "string" }, "number" : { - "description" : "The number of the document. Delete the given type if the value empty.", + "description" : "The number in the document.", "type" : "string" }, "type" : { - "description" : "The type of the document. More then one item pert type does not allowed.\nValid values: ID, PASSPORT, VISA, DRIVINGLICENSE", + "description" : "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ", "enum" : [ "DRIVINGLICENSE", "ID", @@ -2590,47 +2602,47 @@ "ShareholderContact" : { "properties" : { "address" : { - "description" : "The address of the contact.", + "description" : "The address of the person.", "$ref" : "#/components/schemas/ViasAddress" }, "email" : { - "description" : "The e-mail address of the contact.", + "description" : "The e-mail address of the person.", "type" : "string" }, "fullPhoneNumber" : { - "description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, "jobTitle" : { - "description" : "Job title of the shareholder. Required when the `shareholderType` is **Control**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", + "description" : "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", "type" : "string" }, "name" : { - "description" : "The name of the contact.", + "description" : "The name of the person.", "$ref" : "#/components/schemas/ViasName" }, "personalData" : { - "description" : "Contains information about the shareholder.", + "description" : "Contains information about the person.", "$ref" : "#/components/schemas/ViasPersonalData" }, "phoneNumber" : { - "description" : "The phone number of the contact.", + "description" : "The phone number of the person.", "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shareholderCode" : { - "description" : "The unique identifier (UUID) of the shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", + "description" : "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", "type" : "string" }, "shareholderType" : { - "description" : "The type of shareholder. \n\nPossible values: \n\n* **Ownership**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Control**: Individuals who are members of senior management staff responsible for managing the company.", + "description" : "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.", "enum" : [ - "Control", - "Ownership" + "Controller", + "Owner" ], "type" : "string" }, "webAddress" : { - "description" : "The URL of the website of the contact.", + "description" : "The URL of the person's website.", "type" : "string" } } @@ -3041,12 +3053,12 @@ "ViasPersonalData" : { "properties" : { "dateOfBirth" : { - "description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "documentData" : { "x-addedInVersion" : 3, - "description" : "Key value pairs of document type and identify numbers", + "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" }, @@ -3058,7 +3070,7 @@ "type" : "string" }, "nationality" : { - "description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.\n", "maxLength" : 2, "minLength" : 2, "type" : "string" diff --git a/json/MarketPayNotificationService-v5.json b/json/MarketPayNotificationService-v5.json index af3e14e..9643adb 100644 --- a/json/MarketPayNotificationService-v5.json +++ b/json/MarketPayNotificationService-v5.json @@ -827,7 +827,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Each of the bank accounts associated with the account holder.\n> Each array entry should represent one bank account.\n> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -867,12 +867,20 @@ }, "payoutMethods" : { "x-addedInVersion" : 5, - "description" : "Each of the card tokens associated with the account holder.\n> Each array entry should represent one card token.\n> For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, "type" : "array" }, + "storeDetails" : { + "x-addedInVersion" : 5, + "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos).", + "items" : { + "$ref" : "#/components/schemas/StoreDetail" + }, + "type" : "array" + }, "webAddress" : { "description" : "The URL of the website of the account holder.", "type" : "string" @@ -1091,13 +1099,25 @@ }, "type" : "array" }, + "newStatus" : { + "x-addedInVersion" : 2, + "description" : "The new status of the account holder.", + "$ref" : "#/components/schemas/AccountHolderStatus" + }, + "oldStatus" : { + "x-addedInVersion" : 2, + "description" : "The former status of the account holder.", + "$ref" : "#/components/schemas/AccountHolderStatus" + }, "reason" : { "description" : "The reason for the status change.", "type" : "string" } }, "required" : [ - "accountHolderCode" + "accountHolderCode", + "oldStatus", + "newStatus" ] }, "AccountHolderStoreStatusChangeNotification" : { @@ -1730,7 +1750,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Each of the shareholders associated with the company.\nEach array entry should represent one shareholder.", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -2606,25 +2626,25 @@ "PersonalDocumentData" : { "properties" : { "expirationDate" : { - "description" : "The expiration date of the document.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "issuerCountry" : { - "description" : "The two-character country code of the issuer.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "issuerState" : { - "description" : "The state issued the document (if applicable)", + "description" : "The state where the document was issued (if applicable).", "type" : "string" }, "number" : { - "description" : "The number of the document. Delete the given type if the value empty.", + "description" : "The number in the document.", "type" : "string" }, "type" : { - "description" : "The type of the document. More then one item pert type does not allowed.\nValid values: ID, PASSPORT, VISA, DRIVINGLICENSE", + "description" : "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ", "enum" : [ "DRIVINGLICENSE", "ID", @@ -2885,52 +2905,52 @@ "ShareholderContact" : { "properties" : { "address" : { - "description" : "The address of the contact.", + "description" : "The address of the person.", "$ref" : "#/components/schemas/ViasAddress" }, "email" : { - "description" : "The e-mail address of the contact.", + "description" : "The e-mail address of the person.", "type" : "string" }, "fullPhoneNumber" : { - "description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, "jobTitle" : { - "description" : "Job title of the shareholder. Required when the `shareholderType` is **Control**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", + "description" : "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", "type" : "string" }, "name" : { - "description" : "The name of the contact.", + "description" : "The name of the person.", "$ref" : "#/components/schemas/ViasName" }, "personalData" : { - "description" : "Contains information about the shareholder.", + "description" : "Contains information about the person.", "$ref" : "#/components/schemas/ViasPersonalData" }, "phoneNumber" : { - "description" : "The phone number of the contact.", + "description" : "The phone number of the person.", "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shareholderCode" : { - "description" : "The unique identifier (UUID) of the shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", + "description" : "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", "type" : "string" }, "shareholderReference" : { "x-addedInVersion" : 5, - "description" : "Your reference for the shareholder.", + "description" : "Your reference for the shareholder entry.", "type" : "string" }, "shareholderType" : { - "description" : "The type of shareholder. \n\nPossible values: \n\n* **Ownership**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Control**: Individuals who are members of senior management staff responsible for managing the company.", + "description" : "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.", "enum" : [ - "Control", - "Ownership" + "Controller", + "Owner" ], "type" : "string" }, "webAddress" : { - "description" : "The URL of the website of the contact.", + "description" : "The URL of the person's website.", "type" : "string" } } @@ -2990,6 +3010,85 @@ "value" ] }, + "StoreDetail" : { + "properties" : { + "address" : { + "description" : "The address of the physical store where the account holder will process payments from.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "fullPhoneNumber" : { + "description" : "The phone number of the store provided as a single string. It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "type" : "string" + }, + "merchantAccount" : { + "description" : "The merchant account to which the store belongs.", + "type" : "string" + }, + "merchantCategoryCode" : { + "description" : "The merchant category code (MCC) that classifies the business of the account holder.", + "type" : "string" + }, + "phoneNumber" : { + "description" : "The phone number of the store.", + "readOnly" : true, + "$ref" : "#/components/schemas/ViasPhoneNumber" + }, + "shopperInteraction" : { + "x-addedInVersion" : 5, + "description" : "The sales channel. Possible values: **Ecommerce**, **POS**.", + "enum" : [ + "Ecommerce", + "POS" + ], + "type" : "string" + }, + "splitConfigurationUUID" : { + "x-addedInVersion" : 5, + "description" : "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.", + "type" : "string" + }, + "status" : { + "description" : "The status of the store. Possible values: **Pending**, **Active**, **Inactive**, **InactiveWithModifications**, **Closed**.", + "enum" : [ + "Active", + "Closed", + "Inactive", + "InactiveWithModifications", + "Pending" + ], + "readOnly" : true, + "type" : "string" + }, + "store" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an `/updateAccountHolder` request.", + "type" : "string" + }, + "storeName" : { + "description" : "The name of the account holder's store, between 3 to 22 characters in length.\nThis value will be shown in shopper statements.", + "type" : "string" + }, + "storeReference" : { + "description" : "Your unique identifier for the store, between 3 to 128 characters in length.\nThis value will be shown as the store description in your Customer Area.", + "type" : "string" + }, + "virtualAccount" : { + "x-addedInVersion" : 5, + "description" : "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.", + "type" : "string" + }, + "webAddress" : { + "x-addedInVersion" : 5, + "description" : "URL of the ecommerce store.", + "type" : "string" + } + }, + "required" : [ + "storeReference", + "merchantCategoryCode", + "address", + "merchantAccount" + ] + }, "Transaction" : { "properties" : { "amount" : { @@ -3380,19 +3479,19 @@ "ViasPersonalData" : { "properties" : { "dateOfBirth" : { - "description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "documentData" : { "x-addedInVersion" : 3, - "description" : "Key value pairs of document type and identify numbers", + "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" }, "type" : "array" }, "nationality" : { - "description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.\n", "maxLength" : 2, "minLength" : 2, "type" : "string" diff --git a/json/MarketPayNotificationService-v6.json b/json/MarketPayNotificationService-v6.json index cef65c2..48fa147 100644 --- a/json/MarketPayNotificationService-v6.json +++ b/json/MarketPayNotificationService-v6.json @@ -827,7 +827,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Each of the bank accounts associated with the account holder.\n> Each array entry should represent one bank account.\n> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -867,7 +867,7 @@ }, "payoutMethods" : { "x-addedInVersion" : 5, - "description" : "Each of the card tokens associated with the account holder.\n> Each array entry should represent one card token.\n> For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/verification-checks).", + "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, @@ -878,6 +878,14 @@ "description" : "The prinicipal business address of the account holder.", "$ref" : "#/components/schemas/ViasAddress" }, + "storeDetails" : { + "x-addedInVersion" : 5, + "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos).", + "items" : { + "$ref" : "#/components/schemas/StoreDetail" + }, + "type" : "array" + }, "webAddress" : { "description" : "The URL of the website of the account holder.", "type" : "string" @@ -1118,13 +1126,25 @@ }, "type" : "array" }, + "newStatus" : { + "x-addedInVersion" : 2, + "description" : "The new status of the account holder.", + "$ref" : "#/components/schemas/AccountHolderStatus" + }, + "oldStatus" : { + "x-addedInVersion" : 2, + "description" : "The former status of the account holder.", + "$ref" : "#/components/schemas/AccountHolderStatus" + }, "reason" : { "description" : "The reason for the status change.", "type" : "string" } }, "required" : [ - "accountHolderCode" + "accountHolderCode", + "oldStatus", + "newStatus" ] }, "AccountHolderStoreStatusChangeNotification" : { @@ -1758,7 +1778,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Each of the shareholders associated with the company.\nEach array entry should represent one shareholder.", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -2632,25 +2652,25 @@ "PersonalDocumentData" : { "properties" : { "expirationDate" : { - "description" : "The expiration date of the document.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "issuerCountry" : { - "description" : "The two-character country code of the issuer.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.", "maxLength" : 2, "minLength" : 2, "type" : "string" }, "issuerState" : { - "description" : "The state issued the document (if applicable)", + "description" : "The state where the document was issued (if applicable).", "type" : "string" }, "number" : { - "description" : "The number of the document. Delete the given type if the value empty.", + "description" : "The number in the document.", "type" : "string" }, "type" : { - "description" : "The type of the document. More then one item pert type does not allowed.\nValid values: ID, PASSPORT, VISA, DRIVINGLICENSE", + "description" : "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ", "enum" : [ "DRIVINGLICENSE", "ID", @@ -2911,52 +2931,52 @@ "ShareholderContact" : { "properties" : { "address" : { - "description" : "The address of the contact.", + "description" : "The address of the person.", "$ref" : "#/components/schemas/ViasAddress" }, "email" : { - "description" : "The e-mail address of the contact.", + "description" : "The e-mail address of the person.", "type" : "string" }, "fullPhoneNumber" : { - "description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, "jobTitle" : { - "description" : "Job title of the shareholder. Required when the `shareholderType` is **Control**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", + "description" : "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.", "type" : "string" }, "name" : { - "description" : "The name of the contact.", + "description" : "The name of the person.", "$ref" : "#/components/schemas/ViasName" }, "personalData" : { - "description" : "Contains information about the shareholder.", + "description" : "Contains information about the person.", "$ref" : "#/components/schemas/ViasPersonalData" }, "phoneNumber" : { - "description" : "The phone number of the contact.", + "description" : "The phone number of the person.", "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shareholderCode" : { - "description" : "The unique identifier (UUID) of the shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", + "description" : "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n", "type" : "string" }, "shareholderReference" : { "x-addedInVersion" : 5, - "description" : "Your reference for the shareholder.", + "description" : "Your reference for the shareholder entry.", "type" : "string" }, "shareholderType" : { - "description" : "The type of shareholder. \n\nPossible values: \n\n* **Ownership**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Control**: Individuals who are members of senior management staff responsible for managing the company.", + "description" : "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.", "enum" : [ - "Control", - "Ownership" + "Controller", + "Owner" ], "type" : "string" }, "webAddress" : { - "description" : "The URL of the website of the contact.", + "description" : "The URL of the person's website.", "type" : "string" } } @@ -3016,6 +3036,85 @@ "value" ] }, + "StoreDetail" : { + "properties" : { + "address" : { + "description" : "The address of the physical store where the account holder will process payments from.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "fullPhoneNumber" : { + "description" : "The phone number of the store provided as a single string. It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "type" : "string" + }, + "merchantAccount" : { + "description" : "The merchant account to which the store belongs.", + "type" : "string" + }, + "merchantCategoryCode" : { + "description" : "The merchant category code (MCC) that classifies the business of the account holder.", + "type" : "string" + }, + "phoneNumber" : { + "description" : "The phone number of the store.", + "readOnly" : true, + "$ref" : "#/components/schemas/ViasPhoneNumber" + }, + "shopperInteraction" : { + "x-addedInVersion" : 5, + "description" : "The sales channel. Possible values: **Ecommerce**, **POS**.", + "enum" : [ + "Ecommerce", + "POS" + ], + "type" : "string" + }, + "splitConfigurationUUID" : { + "x-addedInVersion" : 5, + "description" : "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.", + "type" : "string" + }, + "status" : { + "description" : "The status of the store. Possible values: **Pending**, **Active**, **Inactive**, **InactiveWithModifications**, **Closed**.", + "enum" : [ + "Active", + "Closed", + "Inactive", + "InactiveWithModifications", + "Pending" + ], + "readOnly" : true, + "type" : "string" + }, + "store" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an `/updateAccountHolder` request.", + "type" : "string" + }, + "storeName" : { + "description" : "The name of the account holder's store, between 3 to 22 characters in length.\nThis value will be shown in shopper statements.", + "type" : "string" + }, + "storeReference" : { + "description" : "Your unique identifier for the store, between 3 to 128 characters in length.\nThis value will be shown as the store description in your Customer Area.", + "type" : "string" + }, + "virtualAccount" : { + "x-addedInVersion" : 5, + "description" : "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.", + "type" : "string" + }, + "webAddress" : { + "x-addedInVersion" : 5, + "description" : "URL of the ecommerce store.", + "type" : "string" + } + }, + "required" : [ + "storeReference", + "merchantCategoryCode", + "address", + "merchantAccount" + ] + }, "Transaction" : { "properties" : { "amount" : { @@ -3411,19 +3510,19 @@ "ViasPersonalData" : { "properties" : { "dateOfBirth" : { - "description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.", "type" : "string" }, "documentData" : { "x-addedInVersion" : 3, - "description" : "Key value pairs of document type and identify numbers", + "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" }, "type" : "array" }, "nationality" : { - "description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "description" : "The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.\n", "maxLength" : 2, "minLength" : 2, "type" : "string" diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index b95b232..26763aa 100644 --- a/json/PaymentService-v25.json +++ b/json/PaymentService-v25.json @@ -2017,6 +2017,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "ModificationResult" : { "properties" : { "additionalData" : { @@ -2201,6 +2261,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -2629,7 +2693,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index ae8d1ce..7f5aa0b 100644 --- a/json/PaymentService-v30.json +++ b/json/PaymentService-v30.json @@ -2291,6 +2291,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "ModificationResult" : { "properties" : { "additionalData" : { @@ -2475,6 +2535,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -2923,7 +2987,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index 5b93e8e..8514099 100644 --- a/json/PaymentService-v40.json +++ b/json/PaymentService-v40.json @@ -2846,6 +2846,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -3113,6 +3173,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -3895,7 +3959,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index c0967b3..9435db4 100644 --- a/json/PaymentService-v46.json +++ b/json/PaymentService-v46.json @@ -2866,6 +2866,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -3133,6 +3193,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -3915,7 +3979,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index 41f9a4b..10f03e6 100644 --- a/json/PaymentService-v49.json +++ b/json/PaymentService-v49.json @@ -2866,6 +2866,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -3133,6 +3193,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -3915,7 +3979,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index 7a0890a..231bf22 100644 --- a/json/PaymentService-v50.json +++ b/json/PaymentService-v50.json @@ -2876,6 +2876,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -3143,6 +3203,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -3943,7 +4007,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index c9f29ee..3447e07 100644 --- a/json/PaymentService-v51.json +++ b/json/PaymentService-v51.json @@ -2985,6 +2985,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -3258,6 +3318,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -4070,7 +4134,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index 313a270..12a28d0 100644 --- a/json/PaymentService-v52.json +++ b/json/PaymentService-v52.json @@ -2985,6 +2985,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -3266,6 +3326,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -4078,7 +4142,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index 1b89398..22d46f4 100644 --- a/json/PaymentService-v64.json +++ b/json/PaymentService-v64.json @@ -2994,6 +2994,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -3275,6 +3335,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -4087,7 +4151,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PayoutService-v30.json b/json/PayoutService-v30.json index ea9a256..4aca941 100644 --- a/json/PayoutService-v30.json +++ b/json/PayoutService-v30.json @@ -9,7 +9,7 @@ "version" : "30", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).", + "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -1774,6 +1774,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "ModifyRequest" : { "properties" : { "additionalData" : { @@ -1975,6 +2035,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -2178,7 +2242,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PayoutService-v40.json b/json/PayoutService-v40.json index 64fe0df..ee9d0a9 100644 --- a/json/PayoutService-v40.json +++ b/json/PayoutService-v40.json @@ -9,7 +9,7 @@ "version" : "40", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).", + "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -2025,6 +2025,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -2309,6 +2369,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -2535,7 +2599,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PayoutService-v50.json b/json/PayoutService-v50.json index 2e82a61..98c1d7f 100644 --- a/json/PayoutService-v50.json +++ b/json/PayoutService-v50.json @@ -9,7 +9,7 @@ "version" : "50", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).", + "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -2035,6 +2035,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -2319,6 +2379,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -2551,7 +2615,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PayoutService-v51.json b/json/PayoutService-v51.json index 73d1971..0f25398 100644 --- a/json/PayoutService-v51.json +++ b/json/PayoutService-v51.json @@ -9,7 +9,7 @@ "version" : "51", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).", + "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -2035,6 +2035,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -2325,6 +2385,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -2557,7 +2621,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PayoutService-v52.json b/json/PayoutService-v52.json index 58b60bb..bfa3856 100644 --- a/json/PayoutService-v52.json +++ b/json/PayoutService-v52.json @@ -9,7 +9,7 @@ "version" : "52", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).", + "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -2035,6 +2035,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -2333,6 +2393,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -2565,7 +2629,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/PayoutService-v64.json b/json/PayoutService-v64.json index f61af3c..195af63 100644 --- a/json/PayoutService-v64.json +++ b/json/PayoutService-v64.json @@ -9,7 +9,7 @@ "version" : "64", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).", + "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -2044,6 +2044,66 @@ "value" ] }, + "Mandate" : { + "properties" : { + "amount" : { + "description" : "The billing amount of the recurring transactions.", + "type" : "string" + }, + "amountRule" : { + "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", + "enum" : [ + "max", + "exact" + ], + "type" : "string" + }, + "billingAttemptsRule" : { + "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", + "enum" : [ + "on", + "before", + "after" + ], + "type" : "string" + }, + "billingDay" : { + "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", + "type" : "string" + }, + "endsAt" : { + "description" : "End date of the billing plan, in YYYY-MM-DD format.", + "type" : "string" + }, + "frequency" : { + "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", + "enum" : [ + "adhoc", + "daily", + "weekly", + "biWeekly", + "monthly", + "quarterly", + "halfYearly", + "yearly" + ], + "type" : "string" + }, + "remarks" : { + "description" : "The message shown by UPI to the shopper on the approval screen.", + "type" : "string" + }, + "startsAt" : { + "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", + "type" : "string" + } + }, + "required" : [ + "frequency", + "amount", + "endsAt" + ] + }, "MerchantDevice" : { "properties" : { "os" : { @@ -2342,6 +2402,10 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, "mcc" : { "x-addedInVersion" : 12, "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -2574,7 +2638,7 @@ "type" : "string" }, "pspReference" : { - "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> `pspReference` is returned only for non-redirect payment methods.", + "description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.", "type" : "string" }, "refusalReason" : { diff --git a/json/RecurringService-v25.json b/json/RecurringService-v25.json index 9fd5591..a4e4be2 100644 --- a/json/RecurringService-v25.json +++ b/json/RecurringService-v25.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "disableARecurringContract" : { + "$ref" : "#/components/examples/post-disable-disableARecurringContract" + } + }, "schema" : { "$ref" : "#/components/schemas/DisableRequest" } @@ -111,6 +116,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "listAllRecurringDetails" : { + "$ref" : "#/components/examples/post-listRecurringDetails-listAllRecurringDetails" + } + }, "schema" : { "$ref" : "#/components/schemas/RecurringDetailsRequest" } @@ -192,6 +202,14 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterRequest" } @@ -691,7 +709,46 @@ } }, "examples" : { - + "post-disable-disableARecurringContract" : { + "summary" : "Disable a recurring contract", + "value" : { + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "recurringDetailReference" : "8314442372419167", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-listRecurringDetails-listAllRecurringDetails" : { + "summary" : "List all recurring details", + "value" : { + "recurring" : { + "contract" : "RECURRING" + }, + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData" : { + "summary" : "Schedule AccountUpdater with card data", + "value" : { + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "reference" : "YOUR_REFERENCE", + "card" : { + "expiryMonth" : "03", + "expiryYear" : "2030", + "holderName" : "Adyen Test", + "number" : "4111111111111111" + } + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { + "summary" : "Schedule AccountUpdater with token data", + "value" : { + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "reference" : "YOUR_REFERENCE", + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "selectedRecurringDetailReference" : "8814232895168272" + } + } } } } \ No newline at end of file diff --git a/json/RecurringService-v30.json b/json/RecurringService-v30.json index ca13e8a..5c008f5 100644 --- a/json/RecurringService-v30.json +++ b/json/RecurringService-v30.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "disableARecurringContract" : { + "$ref" : "#/components/examples/post-disable-disableARecurringContract" + } + }, "schema" : { "$ref" : "#/components/schemas/DisableRequest" } @@ -111,6 +116,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "listAllRecurringDetails" : { + "$ref" : "#/components/examples/post-listRecurringDetails-listAllRecurringDetails" + } + }, "schema" : { "$ref" : "#/components/schemas/RecurringDetailsRequest" } @@ -192,6 +202,14 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterRequest" } @@ -691,7 +709,46 @@ } }, "examples" : { - + "post-disable-disableARecurringContract" : { + "summary" : "Disable a recurring contract", + "value" : { + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "recurringDetailReference" : "8314442372419167", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-listRecurringDetails-listAllRecurringDetails" : { + "summary" : "List all recurring details", + "value" : { + "recurring" : { + "contract" : "RECURRING" + }, + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData" : { + "summary" : "Schedule AccountUpdater with card data", + "value" : { + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "reference" : "YOUR_REFERENCE", + "card" : { + "expiryMonth" : "03", + "expiryYear" : "2030", + "holderName" : "Adyen Test", + "number" : "4111111111111111" + } + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { + "summary" : "Schedule AccountUpdater with token data", + "value" : { + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "reference" : "YOUR_REFERENCE", + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "selectedRecurringDetailReference" : "8814232895168272" + } + } } } } \ No newline at end of file diff --git a/json/RecurringService-v40.json b/json/RecurringService-v40.json index c3a6fbe..15be2cf 100644 --- a/json/RecurringService-v40.json +++ b/json/RecurringService-v40.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "disableARecurringContract" : { + "$ref" : "#/components/examples/post-disable-disableARecurringContract" + } + }, "schema" : { "$ref" : "#/components/schemas/DisableRequest" } @@ -111,6 +116,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "listAllRecurringDetails" : { + "$ref" : "#/components/examples/post-listRecurringDetails-listAllRecurringDetails" + } + }, "schema" : { "$ref" : "#/components/schemas/RecurringDetailsRequest" } @@ -192,6 +202,14 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterRequest" } @@ -702,7 +720,46 @@ } }, "examples" : { - + "post-disable-disableARecurringContract" : { + "summary" : "Disable a recurring contract", + "value" : { + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "recurringDetailReference" : "8314442372419167", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-listRecurringDetails-listAllRecurringDetails" : { + "summary" : "List all recurring details", + "value" : { + "recurring" : { + "contract" : "RECURRING" + }, + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData" : { + "summary" : "Schedule AccountUpdater with card data", + "value" : { + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "reference" : "YOUR_REFERENCE", + "card" : { + "expiryMonth" : "03", + "expiryYear" : "2030", + "holderName" : "Adyen Test", + "number" : "4111111111111111" + } + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { + "summary" : "Schedule AccountUpdater with token data", + "value" : { + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "reference" : "YOUR_REFERENCE", + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "selectedRecurringDetailReference" : "8814232895168272" + } + } } } } \ No newline at end of file diff --git a/json/RecurringService-v49.json b/json/RecurringService-v49.json index 8a0f899..d652435 100644 --- a/json/RecurringService-v49.json +++ b/json/RecurringService-v49.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "disableARecurringContract" : { + "$ref" : "#/components/examples/post-disable-disableARecurringContract" + } + }, "schema" : { "$ref" : "#/components/schemas/DisableRequest" } @@ -111,6 +116,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "listAllRecurringDetails" : { + "$ref" : "#/components/examples/post-listRecurringDetails-listAllRecurringDetails" + } + }, "schema" : { "$ref" : "#/components/schemas/RecurringDetailsRequest" } @@ -192,6 +202,14 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterRequest" } @@ -710,7 +728,46 @@ } }, "examples" : { - + "post-disable-disableARecurringContract" : { + "summary" : "Disable a recurring contract", + "value" : { + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "recurringDetailReference" : "8314442372419167", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-listRecurringDetails-listAllRecurringDetails" : { + "summary" : "List all recurring details", + "value" : { + "recurring" : { + "contract" : "RECURRING" + }, + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData" : { + "summary" : "Schedule AccountUpdater with card data", + "value" : { + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "reference" : "YOUR_REFERENCE", + "card" : { + "expiryMonth" : "03", + "expiryYear" : "2030", + "holderName" : "Adyen Test", + "number" : "4111111111111111" + } + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { + "summary" : "Schedule AccountUpdater with token data", + "value" : { + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "reference" : "YOUR_REFERENCE", + "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", + "selectedRecurringDetailReference" : "8814232895168272" + } + } } } } \ No newline at end of file