mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
Update JSON & YAML specs
This commit is contained in:
Wouter Boereboom
@@ -22,6 +22,17 @@
|
||||
"Reviewing",
|
||||
"Instant payouts"
|
||||
],
|
||||
"tags" : [
|
||||
{
|
||||
"name" : "Initialization"
|
||||
},
|
||||
{
|
||||
"name" : "Instant payouts"
|
||||
},
|
||||
{
|
||||
"name" : "Reviewing"
|
||||
}
|
||||
],
|
||||
"paths" : {
|
||||
"/confirmThirdParty" : {
|
||||
"post" : {
|
||||
@@ -1212,6 +1223,57 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"AdditionalDataPayout" : {
|
||||
"properties" : {
|
||||
"fundingNetwork" : {
|
||||
"description" : "",
|
||||
"type" : "string"
|
||||
},
|
||||
"fundingSource" : {
|
||||
"description" : "",
|
||||
"enum" : [
|
||||
"CREDIT",
|
||||
"DEBIT",
|
||||
"PREPAID",
|
||||
"DEPOSIT_ACCOUNT"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"fundingTransactionId" : {
|
||||
"description" : "",
|
||||
"type" : "string"
|
||||
},
|
||||
"payoutAccountCode" : {
|
||||
"description" : "",
|
||||
"type" : "string"
|
||||
},
|
||||
"payoutAccountHolderCode" : {
|
||||
"description" : "",
|
||||
"type" : "string"
|
||||
},
|
||||
"payoutMarketPayUser" : {
|
||||
"description" : "",
|
||||
"type" : "string"
|
||||
},
|
||||
"processOver" : {
|
||||
"description" : "",
|
||||
"enum" : [
|
||||
"MC_P2P",
|
||||
"Visa_OCT",
|
||||
"UnlinkedRefund"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"verifyOver" : {
|
||||
"description" : "",
|
||||
"type" : "string"
|
||||
},
|
||||
"walletIdentifier" : {
|
||||
"description" : "",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AdditionalDataRatepay" : {
|
||||
"properties" : {
|
||||
"ratepay.installmentAmount" : {
|
||||
@@ -1532,14 +1594,16 @@
|
||||
"properties" : {
|
||||
"city" : {
|
||||
"description" : "The name of the city. Maximum length: 3000 characters.",
|
||||
"maxLength" : 3000,
|
||||
"type" : "string"
|
||||
},
|
||||
"country" : {
|
||||
"description" : "The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
|
||||
"description" : "The two-character ISO-3166-1 alpha-2 country code. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
|
||||
"type" : "string"
|
||||
},
|
||||
"houseNumberOrName" : {
|
||||
"description" : "The number or name of the house. Maximum length: 3000 characters.",
|
||||
"maxLength" : 3000,
|
||||
"type" : "string"
|
||||
},
|
||||
"postalCode" : {
|
||||
@@ -1547,11 +1611,12 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"stateOrProvince" : {
|
||||
"description" : "State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.",
|
||||
"description" : "The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.",
|
||||
"type" : "string"
|
||||
},
|
||||
"street" : {
|
||||
"description" : "The name of the street. Maximum length: 3000 characters.\n> The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.",
|
||||
"maxLength" : 3000,
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
@@ -1808,27 +1873,27 @@
|
||||
"additionalProperties" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"description" : "a map of name/value pairs for passing in additional/industry-specific data",
|
||||
"description" : "A map of name-value pairs for passing additional or industry-specific data.",
|
||||
"type" : "object"
|
||||
},
|
||||
"billingAddress" : {
|
||||
"description" : "the address where to send the invoice",
|
||||
"description" : "The address where to send the invoice.",
|
||||
"$ref" : "#/components/schemas/Address"
|
||||
},
|
||||
"card" : {
|
||||
"description" : "a representation of a (credit or debit) card",
|
||||
"description" : "Credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided.",
|
||||
"$ref" : "#/components/schemas/Card"
|
||||
},
|
||||
"shopperEmail" : {
|
||||
"description" : "the email address of the person",
|
||||
"description" : "Email address of the person.",
|
||||
"type" : "string"
|
||||
},
|
||||
"shopperName" : {
|
||||
"description" : "the name of the person",
|
||||
"description" : "Name of the person.",
|
||||
"$ref" : "#/components/schemas/Name"
|
||||
},
|
||||
"telephoneNumber" : {
|
||||
"description" : "the telephone number of the person",
|
||||
"description" : "Phone number of the person",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
@@ -1969,126 +2034,19 @@
|
||||
},
|
||||
"PayoutRequest" : {
|
||||
"properties" : {
|
||||
"additionalAmount" : {
|
||||
"description" : "If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while the amount must be still set to 0 to trigger BIN or card verification).\nRequired to be in the same currency as the `amount`. ",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"additionalData" : {
|
||||
"additionalProperties" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"x-anyOf" : [
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalData3DSecure"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataAirline"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataCarRental"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataCommon"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataLevel23"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataLodging"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataOpi"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataRatepay"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataRetry"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataRisk"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataRiskStandalone"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataSubMerchant"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataTemporaryServices"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/AdditionalDataWallets"
|
||||
}
|
||||
],
|
||||
"description" : "This field contains additional data, which may be required for a particular payment request.\n\nThe `additionalData` object consists of entries, each of which includes the key and value.",
|
||||
"type" : "object"
|
||||
},
|
||||
"amount" : {
|
||||
"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/BankAccount"
|
||||
},
|
||||
"billingAddress" : {
|
||||
"x-addedInVersion" : "4",
|
||||
"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/Address"
|
||||
},
|
||||
"browserInfo" : {
|
||||
"description" : "The shopper's browser information.\n> For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the `userAgent` and `acceptHeader` fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 1.",
|
||||
"$ref" : "#/components/schemas/BrowserInfo"
|
||||
},
|
||||
"captureDelayHours" : {
|
||||
"x-addedInVersion" : "2",
|
||||
"description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.",
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
},
|
||||
"card" : {
|
||||
"description" : "A container for card data.\n> Either `bankAccount` or `card` field must be provided in a payment request.",
|
||||
"$ref" : "#/components/schemas/Card"
|
||||
},
|
||||
"dateOfBirth" : {
|
||||
"x-addedInVersion" : "7",
|
||||
"description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"dccQuote" : {
|
||||
"description" : "The forex quote as returned in the response of the forex service.",
|
||||
"$ref" : "#/components/schemas/ForexQuote"
|
||||
},
|
||||
"deliveryAddress" : {
|
||||
"description" : "The address where the purchased goods should be delivered.",
|
||||
"$ref" : "#/components/schemas/Address"
|
||||
},
|
||||
"deliveryDate" : {
|
||||
"x-addedInVersion" : "8",
|
||||
"description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"deviceFingerprint" : {
|
||||
"x-addedInVersion" : "2",
|
||||
"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"
|
||||
},
|
||||
"entityType" : {
|
||||
"x-addedInVersion" : "24",
|
||||
"description" : "The type of the entity the payment is processed for.",
|
||||
"enum" : [
|
||||
"NaturalPerson",
|
||||
"CompanyName"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"fraudOffset" : {
|
||||
"description" : "An integer value that is added to the normal fraud score. The value can be either positive or negative.",
|
||||
"format" : "int32",
|
||||
@@ -2098,89 +2056,26 @@
|
||||
"description" : "The person or entity funding the money.",
|
||||
"$ref" : "#/components/schemas/FundSource"
|
||||
},
|
||||
"installments" : {
|
||||
"x-addedInVersion" : "4",
|
||||
"description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).",
|
||||
"$ref" : "#/components/schemas/Installments"
|
||||
},
|
||||
"mandate" : {
|
||||
"description" : "The mandate details to initiate recurring transaction.",
|
||||
"$ref" : "#/components/schemas/Mandate"
|
||||
},
|
||||
"mcc" : {
|
||||
"x-addedInVersion" : "12",
|
||||
"description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.",
|
||||
"type" : "string"
|
||||
},
|
||||
"merchantAccount" : {
|
||||
"description" : "The merchant account identifier, with which you want to process the transaction.",
|
||||
"type" : "string"
|
||||
},
|
||||
"merchantOrderReference" : {
|
||||
"x-addedInVersion" : "9",
|
||||
"description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.",
|
||||
"type" : "string"
|
||||
},
|
||||
"metadata" : {
|
||||
"x-addedInVersion" : "17",
|
||||
"additionalProperties" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"description" : "Metadata consists of entries, each of which includes a key and a value.\nLimits:\n* Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\".\n* Maximum 20 characters per key.\n* Maximum 80 characters per value. ",
|
||||
"type" : "object"
|
||||
},
|
||||
"mpiData" : {
|
||||
"description" : "Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).",
|
||||
"$ref" : "#/components/schemas/ThreeDSecureData"
|
||||
},
|
||||
"nationality" : {
|
||||
"x-addedInVersion" : "24",
|
||||
"description" : "The two-character country code of the shopper's nationality.",
|
||||
"maxLength" : 2,
|
||||
"type" : "string"
|
||||
},
|
||||
"orderReference" : {
|
||||
"description" : "When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.",
|
||||
"type" : "string"
|
||||
},
|
||||
"recurring" : {
|
||||
"description" : "The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments).",
|
||||
"$ref" : "#/components/schemas/Recurring"
|
||||
},
|
||||
"recurringProcessingModel" : {
|
||||
"x-addedInVersion" : "30",
|
||||
"description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n",
|
||||
"enum" : [
|
||||
"CardOnFile",
|
||||
"Subscription",
|
||||
"UnscheduledCardOnFile"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"reference" : {
|
||||
"description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.",
|
||||
"type" : "string"
|
||||
},
|
||||
"selectedBrand" : {
|
||||
"description" : "Some payment methods require defining a value for this field to specify how to process the transaction.\n\nFor the Bancontact payment method, it can be set to:\n* `maestro` (default), to be processed like a Maestro card, or\n* `bcmc`, to be processed like a Bancontact card.",
|
||||
"type" : "string"
|
||||
},
|
||||
"selectedRecurringDetailReference" : {
|
||||
"description" : "The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.",
|
||||
"type" : "string"
|
||||
},
|
||||
"sessionId" : {
|
||||
"description" : "A session ID used to identify a payment session.",
|
||||
"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"
|
||||
},
|
||||
"shopperIP" : {
|
||||
"description" : "The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).\n> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.\nThis field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).",
|
||||
"type" : "string"
|
||||
},
|
||||
"shopperInteraction" : {
|
||||
"description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.",
|
||||
"enum" : [
|
||||
@@ -2191,11 +2086,6 @@
|
||||
],
|
||||
"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.",
|
||||
"type" : "string"
|
||||
},
|
||||
"shopperName" : {
|
||||
"x-addedInVersion" : "7",
|
||||
"description" : "The shopper's full name.",
|
||||
@@ -2205,33 +2095,10 @@
|
||||
"description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address.",
|
||||
"type" : "string"
|
||||
},
|
||||
"shopperStatement" : {
|
||||
"description" : "The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.",
|
||||
"type" : "string"
|
||||
},
|
||||
"socialSecurityNumber" : {
|
||||
"x-addedInVersion" : "4",
|
||||
"description" : "The shopper's social security number.",
|
||||
"type" : "string"
|
||||
},
|
||||
"store" : {
|
||||
"x-addedInVersion" : "23",
|
||||
"description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.",
|
||||
"maxLength" : 16,
|
||||
"minLength" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"telephoneNumber" : {
|
||||
"x-addedInVersion" : "7",
|
||||
"description" : "The shopper's telephone number.",
|
||||
"type" : "string"
|
||||
},
|
||||
"totalsGroup" : {
|
||||
"x-addedInVersion" : "23",
|
||||
"description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).",
|
||||
"maxLength" : 16,
|
||||
"minLength" : 1,
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
@@ -3318,7 +3185,7 @@
|
||||
},
|
||||
"billingAddress" : {
|
||||
"houseNumberOrName" : "121",
|
||||
"street" : "Populierenlaan",
|
||||
"street" : "Brannan Street",
|
||||
"city" : "Beverly Hills",
|
||||
"postalCode" : "90210",
|
||||
"stateOrProvince" : "CA",
|
||||
@@ -3348,14 +3215,25 @@
|
||||
"expiryYear" : "2030",
|
||||
"holderName" : "John Smith"
|
||||
},
|
||||
"billingAddress" : {
|
||||
"houseNumberOrName" : "121",
|
||||
"street" : "Brannan Street",
|
||||
"city" : "Beverly Hills",
|
||||
"postalCode" : "90210",
|
||||
"stateOrProvince" : "CA",
|
||||
"country" : "US"
|
||||
},
|
||||
"fundSource" : {
|
||||
"additionalData" : {
|
||||
"fundingSource" : "DEBIT"
|
||||
},
|
||||
"billingAddress" : {
|
||||
"country" : "US",
|
||||
"houseNumberOrName" : "121",
|
||||
"street" : "Brannan Street",
|
||||
"city" : "Beverly Hills",
|
||||
"postalCode" : "90210",
|
||||
"city" : "Beverly Hills"
|
||||
"stateOrProvince" : "CA",
|
||||
"country" : "US"
|
||||
},
|
||||
"card" : {
|
||||
"expiryMonth" : "03",
|
||||
|
||||
Reference in New Issue
Block a user