diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index d9021f9d..ef3955a0 100644 --- a/json/CheckoutService-v37.json +++ b/json/CheckoutService-v37.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4106,6 +4091,41 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4589,9 +4609,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -4864,8 +4882,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -4918,6 +4938,98 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -5467,19 +5579,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -5882,9 +5994,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6019,6 +6142,40 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6045,6 +6202,32 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -6575,6 +6758,40 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -10455,7 +10672,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index 6a78b414..6cb29f2c 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4264,6 +4249,41 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4767,9 +4787,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5088,8 +5106,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5142,6 +5162,98 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -5741,19 +5853,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6161,9 +6273,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6298,6 +6421,40 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6324,6 +6481,32 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -6912,6 +7095,40 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -11053,7 +11270,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index 23066de5..c71f653f 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4274,6 +4259,41 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4777,9 +4797,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5098,8 +5116,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5152,6 +5172,98 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -5751,19 +5863,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6171,9 +6283,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6308,6 +6431,40 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6334,6 +6491,32 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -6922,6 +7105,40 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -11106,7 +11323,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index 34280e02..fc9112c4 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4274,6 +4259,41 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4777,9 +4797,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5098,8 +5116,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5152,6 +5172,98 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -5751,19 +5863,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6171,9 +6283,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6308,6 +6431,40 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6334,6 +6491,32 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -6922,6 +7105,40 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -11114,7 +11331,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index 860c38fb..0e6ffa8e 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4301,6 +4286,50 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4813,9 +4842,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5152,8 +5179,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5206,6 +5235,107 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -6148,19 +6278,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6573,9 +6703,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6737,6 +6878,49 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6772,6 +6956,41 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -7405,6 +7624,49 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -11873,7 +12135,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index d89ff290..dbe826f9 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4317,6 +4302,50 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4835,9 +4864,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5174,8 +5201,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5228,6 +5257,107 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -6170,19 +6300,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6601,9 +6731,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6765,6 +6906,49 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6800,6 +6984,41 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -7433,6 +7652,49 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -11958,7 +12220,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index 5c993744..882c219d 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4317,6 +4302,50 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4841,9 +4870,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5180,8 +5207,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5234,6 +5263,107 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -6182,19 +6312,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6613,9 +6743,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6777,6 +6918,49 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6812,6 +6996,41 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -7445,6 +7664,49 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -11995,7 +12257,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index 1dc12471..f2035eef 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4317,6 +4302,50 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4841,9 +4870,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5180,8 +5207,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5234,6 +5263,107 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -6190,19 +6320,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6621,9 +6751,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6785,6 +6926,49 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6820,6 +7004,41 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -7453,6 +7672,49 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -12013,7 +12275,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index 90f68119..0785368f 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4317,6 +4302,50 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4841,9 +4870,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5180,8 +5207,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5234,6 +5263,107 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -6190,19 +6320,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6621,9 +6751,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6785,6 +6926,49 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6820,6 +7004,41 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -7453,6 +7672,49 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -12037,7 +12299,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index d51affbd..f4b18e7e 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4317,6 +4302,50 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4841,9 +4870,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5180,8 +5207,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5234,6 +5263,107 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -6190,19 +6320,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6621,9 +6751,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6785,6 +6926,49 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6820,6 +7004,41 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -7489,6 +7708,49 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -12106,7 +12368,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index 123311f3..1e93507c 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4317,6 +4302,50 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4855,9 +4884,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5194,8 +5221,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5248,6 +5277,107 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -6198,19 +6328,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6629,9 +6759,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6793,6 +6934,49 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6828,6 +7012,41 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -7497,6 +7716,49 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -12087,7 +12349,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index 228e5ea2..2e66ccb5 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -933,12 +933,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -946,21 +946,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4317,6 +4302,50 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4855,9 +4884,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5194,8 +5221,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5248,6 +5277,107 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -6198,19 +6328,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6629,9 +6759,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6793,6 +6934,49 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6828,6 +7012,41 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -7497,6 +7716,49 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -12097,7 +12359,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index 052543ea..c02ae9a1 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -935,12 +935,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -948,21 +948,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4309,6 +4294,50 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -4847,9 +4876,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5186,8 +5213,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5240,6 +5269,107 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -6158,19 +6288,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -6589,9 +6719,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -6753,6 +6894,49 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -6788,6 +6972,41 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "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.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -7457,6 +7676,49 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "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**.", + "enum" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -12119,7 +12381,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v68.json b/json/CheckoutService-v68.json index b57c3819..90922692 100644 --- a/json/CheckoutService-v68.json +++ b/json/CheckoutService-v68.json @@ -935,12 +935,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -948,21 +948,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4611,6 +4596,55 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -5167,9 +5201,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5516,8 +5548,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5570,6 +5604,112 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -7203,19 +7343,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -7654,9 +7794,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -7833,6 +7984,54 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -7873,6 +8072,46 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "issuer" : { + "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -8616,6 +8855,54 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -13816,7 +14103,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v69.json b/json/CheckoutService-v69.json index 8b59df12..e3d0dbd5 100644 --- a/json/CheckoutService-v69.json +++ b/json/CheckoutService-v69.json @@ -935,12 +935,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -948,21 +948,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4617,6 +4602,55 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -5201,9 +5235,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5550,8 +5582,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5604,6 +5638,112 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -7330,19 +7470,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -7777,9 +7917,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -7956,6 +8107,54 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -7996,6 +8195,46 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "issuer" : { + "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -8739,6 +8978,54 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -14089,7 +14376,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v70.json b/json/CheckoutService-v70.json index dfda7b37..8e60ba56 100644 --- a/json/CheckoutService-v70.json +++ b/json/CheckoutService-v70.json @@ -935,12 +935,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -948,21 +948,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4725,6 +4710,55 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -5309,9 +5343,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5658,8 +5690,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5712,6 +5746,112 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -7494,19 +7634,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -7941,9 +8081,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -8120,6 +8271,54 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -8160,6 +8359,46 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "issuer" : { + "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -8958,6 +9197,54 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -14508,7 +14795,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/json/CheckoutService-v71.json b/json/CheckoutService-v71.json index 70ae976c..3b741314 100644 --- a/json/CheckoutService-v71.json +++ b/json/CheckoutService-v71.json @@ -935,12 +935,12 @@ } ], "responses" : { - "200" : { + "201" : { "content" : { "application/json" : { "examples" : { "basic" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "$ref" : "#/components/examples/post-paymentLinks-basic-201" } }, "schema" : { @@ -948,21 +948,6 @@ } } }, - "description" : "OK - the request has succeeded.", - "headers" : { - "Idempotency-Key" : { - "$ref" : "#/components/headers/Idempotency-Key" - } - } - }, - "201" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentLinkResponse" - } - } - }, "description" : "Created - the request has succeeded.", "headers" : { "Idempotency-Key" : { @@ -4725,6 +4710,55 @@ "title" : "Apple Pay", "type" : "object" }, + "ApplePayDonations" : { + "additionalProperties" : false, + "properties" : { + "applePayToken" : { + "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "applepay", + "description" : "**applepay**", + "enum" : [ + "applepay" + ], + "type" : "string" + } + }, + "required" : [ + "applePayToken" + ], + "title" : "Apple Pay", + "type" : "object" + }, "ApplePaySessionRequest" : { "properties" : { "displayName" : { @@ -5309,9 +5343,7 @@ "description" : "**billdesk**", "enum" : [ "billdesk_online", - "billdesk_wallet", - "onlinebanking_IN", - "wallet_IN" + "billdesk_wallet" ], "type" : "string" } @@ -5658,8 +5690,10 @@ "default" : "scheme", "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", "enum" : [ + "bcmc", "scheme", "networkToken", + "giftcard", "card" ], "type" : "string" @@ -5712,6 +5746,112 @@ }, "type" : "object" }, + "CardDonations" : { + "additionalProperties" : false, + "properties" : { + "brand" : { + "description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.", + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "cupsecureplus.smscode" : { + "deprecated" : true, + "type" : "string" + }, + "cvc" : { + "description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "encryptedCardNumber" : { + "description" : "The encrypted card number.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryMonth" : { + "description" : "The encrypted card expiry month.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedExpiryYear" : { + "description" : "The encrypted card expiry year.", + "maxLength" : 15000, + "type" : "string" + }, + "encryptedSecurityCode" : { + "description" : "The encrypted card verification code.", + "maxLength" : 15000, + "type" : "string" + }, + "expiryMonth" : { + "description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "expiryYear" : { + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "holderName" : { + "description" : "The name of the card holder.", + "type" : "string" + }, + "networkPaymentReference" : { + "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.", + "type" : "string" + }, + "number" : { + "description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "shopperNotificationReference" : { + "description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "threeDS2SdkVersion" : { + "description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.", + "maxLength" : 12, + "type" : "string" + }, + "type" : { + "default" : "scheme", + "description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.", + "enum" : [ + "bcmc", + "scheme", + "networkToken", + "giftcard", + "card" + ], + "type" : "string" + } + }, + "title" : "Card", + "type" : "object" + }, "CellulantDetails" : { "additionalProperties" : false, "properties" : { @@ -7369,19 +7509,19 @@ "description" : "The type and required details of a payment method to use.", "oneOf" : [ { - "$ref" : "#/components/schemas/ApplePayDetails" + "$ref" : "#/components/schemas/ApplePayDonations" }, { - "$ref" : "#/components/schemas/CardDetails" + "$ref" : "#/components/schemas/CardDonations" }, { - "$ref" : "#/components/schemas/GooglePayDetails" + "$ref" : "#/components/schemas/GooglePayDonations" }, { - "$ref" : "#/components/schemas/IdealDetails" + "$ref" : "#/components/schemas/IdealDonations" }, { - "$ref" : "#/components/schemas/PayWithGoogleDetails" + "$ref" : "#/components/schemas/PayWithGoogleDonations" } ] }, @@ -7767,9 +7907,20 @@ "description" : "The address where to send the invoice.", "$ref" : "#/components/schemas/Address" }, + "shopperEmail" : { + "description" : "Email address of the person.", + "type" : "string" + }, "shopperName" : { "description" : "The name of the person", "$ref" : "#/components/schemas/Name" + }, + "telephoneNumber" : { + "description" : "Phone number of the person", + "type" : "string" + }, + "walletIdentifier" : { + "type" : "string" } }, "type" : "object" @@ -7946,6 +8097,54 @@ "title" : "Google Pay", "type" : "object" }, + "GooglePayDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "googlepay", + "description" : "**googlepay**, **paywithgoogle**", + "enum" : [ + "googlepay" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "IdealDetails" : { "additionalProperties" : false, "properties" : { @@ -7986,6 +8185,46 @@ "title" : "iDEAL", "type" : "object" }, + "IdealDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "issuer" : { + "description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "ideal", + "description" : "**ideal**", + "enum" : [ + "ideal" + ], + "type" : "string" + } + }, + "required" : [ + "issuer" + ], + "title" : "iDEAL", + "type" : "object" + }, "InputDetail" : { "properties" : { "configuration" : { @@ -8784,6 +9023,54 @@ "title" : "Google Pay", "type" : "object" }, + "PayWithGoogleDonations" : { + "additionalProperties" : false, + "properties" : { + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "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" : [ + "credit", + "debit" + ], + "type" : "string" + }, + "googlePayToken" : { + "description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.", + "type" : "string" + }, + "recurringDetailReference" : { + "deprecated" : true, + "x-deprecatedInVersion" : "49", + "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "storedPaymentMethodId" : { + "x-addedInVersion" : "49", + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "maxLength" : 64, + "type" : "string" + }, + "type" : { + "default" : "paywithgoogle", + "description" : "**paywithgoogle**", + "enum" : [ + "paywithgoogle" + ], + "type" : "string" + } + }, + "required" : [ + "googlePayToken" + ], + "title" : "Google Pay", + "type" : "object" + }, "PaymentAmountUpdateRequest" : { "properties" : { "amount" : { @@ -14346,7 +14633,7 @@ } } }, - "post-paymentLinks-basic-200" : { + "post-paymentLinks-basic-201" : { "summary" : "Payment link created", "value" : { "amount" : { diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index cf1d91dd..1157076c 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3737,6 +3728,36 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4275,8 +4296,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4530,8 +4549,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4579,6 +4600,89 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5095,11 +5199,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -5516,9 +5620,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -5631,6 +5743,35 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5652,6 +5793,27 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6079,6 +6241,35 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -10130,7 +10321,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index b8887af8..90b85fdb 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3920,6 +3911,36 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4483,8 +4504,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4784,8 +4803,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4833,6 +4854,89 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5419,11 +5523,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -5846,9 +5950,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -5961,6 +6073,35 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5982,6 +6123,27 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6487,6 +6649,35 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -10821,7 +11012,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index 2bdcbeb7..b1f02d05 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3927,6 +3918,36 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4490,8 +4511,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4791,8 +4810,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4840,6 +4861,89 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5426,11 +5530,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -5853,9 +5957,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -5968,6 +6080,35 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5989,6 +6130,27 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6494,6 +6656,35 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -10863,7 +11054,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 687fdadb..93e56d74 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3927,6 +3918,36 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4490,8 +4511,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4791,8 +4810,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4840,6 +4861,89 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5426,11 +5530,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -5853,9 +5957,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -5968,6 +6080,35 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5989,6 +6130,27 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6494,6 +6656,35 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -10871,7 +11062,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index 1dc4a979..9a1f8324 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3954,6 +3945,45 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4526,8 +4556,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4845,8 +4873,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4894,6 +4924,98 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5743,11 +5865,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -6175,9 +6297,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -6317,6 +6447,44 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6347,6 +6515,36 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6897,6 +7095,44 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -11536,7 +11772,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index 3f00fffa..9d816075 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3975,6 +3966,45 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4553,8 +4583,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4872,8 +4900,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4921,6 +4951,98 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5770,11 +5892,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -6208,9 +6330,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -6350,6 +6480,44 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6380,6 +6548,36 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6930,6 +7128,44 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -11622,7 +11858,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index 4b2848aa..05b7c236 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3975,6 +3966,45 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4559,8 +4589,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4878,8 +4906,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4927,6 +4957,98 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5782,11 +5904,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -6220,9 +6342,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -6362,6 +6492,44 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6392,6 +6560,36 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6942,6 +7140,44 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -11658,7 +11894,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 014269d8..786443b9 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3975,6 +3966,45 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4559,8 +4589,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4878,8 +4906,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4927,6 +4957,98 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5790,11 +5912,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -6228,9 +6350,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -6370,6 +6500,44 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6400,6 +6568,36 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6950,6 +7148,44 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -11674,7 +11910,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index be572fdf..96b6b014 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3975,6 +3966,45 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4559,8 +4589,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4878,8 +4906,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4927,6 +4957,98 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5790,11 +5912,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -6228,9 +6350,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -6370,6 +6500,44 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6400,6 +6568,36 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6950,6 +7148,44 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -11694,7 +11930,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index c7933e51..bcb371e5 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3975,6 +3966,45 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4559,8 +4589,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4878,8 +4906,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4927,6 +4957,98 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5790,11 +5912,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -6228,9 +6350,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -6370,6 +6500,44 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6400,6 +6568,36 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6996,6 +7194,44 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -11772,7 +12008,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 1f5e2a19..865de5cf 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3975,6 +3966,45 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4570,8 +4600,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4889,8 +4917,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4938,6 +4968,98 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5795,11 +5917,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -6233,9 +6355,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -6375,6 +6505,44 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6405,6 +6573,36 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -7001,6 +7199,44 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -11756,7 +11992,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index fab004eb..1bafca20 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -661,21 +661,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3975,6 +3966,45 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4570,8 +4600,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4889,8 +4917,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4938,6 +4968,98 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5795,11 +5917,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -6233,9 +6355,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -6375,6 +6505,44 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6405,6 +6573,36 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -7001,6 +7199,44 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -11764,7 +12000,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index babbe5c9..4101e667 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -663,21 +663,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -3970,6 +3961,45 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4565,8 +4595,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -4884,8 +4912,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -4933,6 +4963,98 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -5759,11 +5881,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -6197,9 +6319,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -6339,6 +6469,44 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6369,6 +6537,36 @@ components: - issuer title: iDEAL type: object + IdealDonations: + 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. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -6965,6 +7163,44 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + 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**. + enum: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -11811,7 +12047,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v68.yaml b/yaml/CheckoutService-v68.yaml index ba22fadb..200eef14 100644 --- a/yaml/CheckoutService-v68.yaml +++ b/yaml/CheckoutService-v68.yaml @@ -663,21 +663,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -4234,6 +4225,49 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4849,8 +4883,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -5176,8 +5208,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -5225,6 +5259,102 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -6867,11 +6997,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' platformChargebackLogic: x-addedInVersion: '68' description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). @@ -7321,9 +7451,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -7475,6 +7613,48 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -7509,6 +7689,40 @@ components: - issuer title: iDEAL type: object + IdealDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + issuer: + description: The iDEAL issuer value of the shopper's selected bank. Set + this to an **id** of an iDEAL issuer to preselect it. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -8170,6 +8384,48 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -13577,7 +13833,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v69.yaml b/yaml/CheckoutService-v69.yaml index 6785e16f..e2e45521 100644 --- a/yaml/CheckoutService-v69.yaml +++ b/yaml/CheckoutService-v69.yaml @@ -663,21 +663,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -4242,6 +4233,49 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4893,8 +4927,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -5220,8 +5252,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -5269,6 +5303,102 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -6993,11 +7123,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' platformChargebackLogic: x-addedInVersion: '68' description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). @@ -7446,9 +7576,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -7600,6 +7738,48 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -7634,6 +7814,40 @@ components: - issuer title: iDEAL type: object + IdealDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + issuer: + description: The iDEAL issuer value of the shopper's selected bank. Set + this to an **id** of an iDEAL issuer to preselect it. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -8295,6 +8509,48 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -13862,7 +14118,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v70.yaml b/yaml/CheckoutService-v70.yaml index 21b202b4..3ae7c844 100644 --- a/yaml/CheckoutService-v70.yaml +++ b/yaml/CheckoutService-v70.yaml @@ -663,21 +663,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -4322,6 +4313,49 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4973,8 +5007,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -5300,8 +5332,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -5349,6 +5383,102 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -7141,11 +7271,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' platformChargebackLogic: x-addedInVersion: '68' description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). @@ -7594,9 +7724,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -7748,6 +7886,48 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -7782,6 +7962,40 @@ components: - issuer title: iDEAL type: object + IdealDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + issuer: + description: The iDEAL issuer value of the shopper's selected bank. Set + this to an **id** of an iDEAL issuer to preselect it. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -8490,6 +8704,48 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -14243,7 +14499,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: diff --git a/yaml/CheckoutService-v71.yaml b/yaml/CheckoutService-v71.yaml index 3e1b27ae..f8875abb 100644 --- a/yaml/CheckoutService-v71.yaml +++ b/yaml/CheckoutService-v71.yaml @@ -663,21 +663,12 @@ paths: parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: - '200': + '201': content: application/json: examples: basic: - $ref: '#/components/examples/post-paymentLinks-basic-200' - schema: - $ref: '#/components/schemas/PaymentLinkResponse' - description: OK - the request has succeeded. - headers: - Idempotency-Key: - $ref: '#/components/headers/Idempotency-Key' - '201': - content: - application/json: + $ref: '#/components/examples/post-paymentLinks-basic-201' schema: $ref: '#/components/schemas/PaymentLinkResponse' description: Created - the request has succeeded. @@ -4322,6 +4313,49 @@ components: - applePayToken title: Apple Pay type: object + ApplePayDonations: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + type: object ApplePaySessionRequest: properties: displayName: @@ -4973,8 +5007,6 @@ components: enum: - billdesk_online - billdesk_wallet - - onlinebanking_IN - - wallet_IN type: string required: - type @@ -5300,8 +5332,10 @@ components: description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: + - bcmc - scheme - networkToken + - giftcard - card type: string title: Card @@ -5349,6 +5383,102 @@ components: $ref: '#/components/schemas/CardBrandDetails' type: array type: object + CardDonations: + additionalProperties: false + properties: + brand: + description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 15000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 15000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 15000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 15000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + 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: + - credit + - debit + type: string + holderName: + description: The name of the card holder. + type: string + networkPaymentReference: + description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) + from the response to the first payment. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + threeDS2SdkVersion: + description: Required for mobile integrations. Version of the 3D Secure + 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - bcmc + - scheme + - networkToken + - giftcard + - card + type: string + title: Card + type: object CellulantDetails: additionalProperties: false properties: @@ -6995,11 +7125,11 @@ components: paymentMethod: description: The type and required details of a payment method to use. oneOf: - - $ref: '#/components/schemas/ApplePayDetails' - - $ref: '#/components/schemas/CardDetails' - - $ref: '#/components/schemas/GooglePayDetails' - - $ref: '#/components/schemas/IdealDetails' - - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/ApplePayDonations' + - $ref: '#/components/schemas/CardDonations' + - $ref: '#/components/schemas/GooglePayDonations' + - $ref: '#/components/schemas/IdealDonations' + - $ref: '#/components/schemas/PayWithGoogleDonations' recurringProcessingModel: x-addedInVersion: '30' description: "Defines a recurring payment type. Required when creating a\ @@ -7390,9 +7520,17 @@ components: billingAddress: description: The address where to send the invoice. $ref: '#/components/schemas/Address' + shopperEmail: + description: Email address of the person. + type: string shopperName: description: The name of the person $ref: '#/components/schemas/Name' + telephoneNumber: + description: Phone number of the person + type: string + walletIdentifier: + type: string type: object FundRecipient: properties: @@ -7544,6 +7682,48 @@ components: - googlePayToken title: Google Pay type: object + GooglePayDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -7578,6 +7758,40 @@ components: - issuer title: iDEAL type: object + IdealDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + issuer: + description: The iDEAL issuer value of the shopper's selected bank. Set + this to an **id** of an iDEAL issuer to preselect it. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + type: object InputDetail: properties: configuration: @@ -8286,6 +8500,48 @@ components: - googlePayToken title: Google Pay type: object + PayWithGoogleDonations: + additionalProperties: false + properties: + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + 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: + - credit + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + maxLength: 64 + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + type: object PaymentAmountUpdateRequest: properties: amount: @@ -14053,7 +14309,7 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP - post-paymentLinks-basic-200: + post-paymentLinks-basic-201: summary: Payment link created value: amount: