Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Nov 18, 2024
1 parent de8a360 commit 559673a
Show file tree
Hide file tree
Showing 34 changed files with 4,756 additions and 253 deletions.
135 changes: 130 additions & 5 deletions json/CheckoutService-v37.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,8 +251,8 @@
"tags" : [
"Payments"
],
"summary" : "Get the list of brands on the card",
"description" : "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details).\n\nIf you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands.\n\n",
"summary" : "Get the brands and other details of a card",
"description" : "Use this endpoint to get information about the card or network token that enables you to decideon the routing of the transaction and the eligibility of the card for the type of transaction.\n\nIf you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified on the card](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details).\n\nIf you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands.\n\n",
"operationId" : "post-cardDetails",
"x-sortIndex" : 6,
"x-methodName" : "cardDetails",
Expand Down Expand Up @@ -4106,6 +4106,7 @@
"properties" : {
"displayName" : {
"description" : "This is the name that your shoppers will see in the Apple Pay interface.\n\nThe value returned as `configuration.merchantName` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response.",
"maxLength" : 64,
"type" : "string"
},
"domainName" : {
Expand Down Expand Up @@ -4889,7 +4890,7 @@
"additionalProperties" : false,
"properties" : {
"cardNumber" : {
"description" : "A minimum of the first 8 digits of the card number and a maximum of the full card number. 11 digits gives the best result. \n\nYou must be [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide) to collect raw card data.",
"description" : "A minimum of the first eight digits of the card number. The full card number gives the best result. \n\nYou must be [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide) to collect raw card data.",
"type" : "string"
},
"countryCode" : {
Expand Down Expand Up @@ -5115,6 +5116,61 @@
"title" : "Cellulant",
"type" : "object"
},
"CheckoutBankAccount" : {
"additionalProperties" : false,
"properties" : {
"accountType" : {
"description" : "The type of the bank account.",
"enum" : [
"balance",
"checking",
"deposit",
"general",
"other",
"payment",
"savings"
],
"type" : "string"
},
"bankAccountNumber" : {
"description" : "The bank account number (without separators).",
"type" : "string"
},
"bankCity" : {
"description" : "The bank city.",
"type" : "string"
},
"bankLocationId" : {
"description" : "The location id of the bank. The field value is `nil` in most cases.",
"type" : "string"
},
"bankName" : {
"description" : "The name of the bank.",
"type" : "string"
},
"bic" : {
"description" : "The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases.",
"type" : "string"
},
"countryCode" : {
"description" : "Country code where the bank is located.\n\nA valid value is an ISO two-character country code (e.g. 'NL').",
"type" : "string"
},
"iban" : {
"description" : "The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN).",
"type" : "string"
},
"ownerName" : {
"description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.",
"type" : "string"
},
"taxId" : {
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
},
"type" : "object"
},
"CheckoutOrderResponse" : {
"additionalProperties" : false,
"properties" : {
Expand Down Expand Up @@ -8279,6 +8335,11 @@
"description" : "The merchant account identifier, with which you want to process the transaction.",
"type" : "string"
},
"shopperConversionId" : {
"description" : "A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.",
"maxLength" : 256,
"type" : "string"
},
"shopperLocale" : {
"x-addedInVersion" : "7",
"description" : "The combination of a language code and a country code to specify the language to be used in the payment.",
Expand Down Expand Up @@ -8528,6 +8589,10 @@
"description" : "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).",
"$ref" : "#/components/schemas/Amount"
},
"bankAccount" : {
"description" : "The details of the bank account, from which the payment should be made.\n> Either `bankAccount` or `card` field must be provided in a payment request.",
"$ref" : "#/components/schemas/CheckoutBankAccount"
},
"billingAddress" : {
"description" : "The address where to send the invoice.\n> The `billingAddress` object is required in the following scenarios. Include all of the fields within this object.\n>* For 3D Secure 2 transactions in all browser-based and mobile implementations.\n>* For cross-border payouts to and from Canada.",
"$ref" : "#/components/schemas/BillingAddress"
Expand Down Expand Up @@ -8778,6 +8843,9 @@
{
"$ref" : "#/components/schemas/RatepayDetails"
},
{
"$ref" : "#/components/schemas/RivertyDetails"
},
{
"$ref" : "#/components/schemas/SamsungPayDetails"
},
Expand Down Expand Up @@ -8857,6 +8925,11 @@
"description" : "The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.\n\nFor example: 2020-07-18T15:42:40.428+01:00",
"type" : "string"
},
"shopperConversionId" : {
"description" : "A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.",
"maxLength" : 256,
"type" : "string"
},
"shopperEmail" : {
"description" : "The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.\n> For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.",
"type" : "string"
Expand Down Expand Up @@ -9824,6 +9897,52 @@
},
"type" : "object"
},
"RivertyDetails" : {
"additionalProperties" : false,
"properties" : {
"billingAddress" : {
"description" : "The address where to send the invoice.",
"type" : "string"
},
"deliveryAddress" : {
"description" : "The address where the goods should be delivered.",
"type" : "string"
},
"deviceFingerprint" : {
"description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).",
"maxLength" : 5000,
"type" : "string"
},
"iban" : {
"description" : "The iban number of the customer ",
"maxLength" : 34,
"type" : "string"
},
"personalDetails" : {
"description" : "Shopper name, date of birth, phone number, and email address.",
"type" : "string"
},
"recurringDetailReference" : {
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "riverty",
"description" : "**riverty**",
"enum" : [
"riverty",
"riverty_account",
"sepadirectdebit_riverty"
],
"type" : "string"
}
},
"required" : [
"type"
],
"title" : "Riverty",
"type" : "object"
},
"SamsungPayDetails" : {
"additionalProperties" : false,
"properties" : {
Expand Down Expand Up @@ -10814,7 +10933,10 @@
"type" : "cartebancaire",
"supported" : true
}
]
],
"fundingSource" : "CREDIT",
"isCardCommercial" : false,
"issuingCountryCode" : "FR"
}
},
"post-cardDetails-supported-brands" : {
Expand Down Expand Up @@ -10843,7 +10965,10 @@
"type" : "cartebancaire",
"supported" : false
}
]
],
"fundingSource" : "CREDIT",
"isCardCommercial" : false,
"issuingCountryCode" : "FR"
}
},
"post-donations-donations" : {
Expand Down
Loading

0 comments on commit 559673a

Please sign in to comment.