Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Mar 6, 2024
1 parent 9e23bfe commit 5951a01
Show file tree
Hide file tree
Showing 16 changed files with 464 additions and 0 deletions.
29 changes: 29 additions & 0 deletions json/PayoutService-v30.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -685,6 +685,7 @@
"components" : {
"schemas" : {
"Address" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"description" : "The name of the city. Maximum length: 3000 characters.",
Expand Down Expand Up @@ -724,6 +725,7 @@
"type" : "object"
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
Expand All @@ -744,6 +746,7 @@
"type" : "object"
},
"BankAccount" : {
"additionalProperties" : false,
"properties" : {
"bankAccountNumber" : {
"description" : "The bank account number (without separators).",
Expand Down Expand Up @@ -787,6 +790,7 @@
"type" : "object"
},
"Card" : {
"additionalProperties" : false,
"properties" : {
"cvc" : {
"description" : "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as:\n* CVV2/CVC2 – length: 3 digits\n* CID – length: 4 digits\n> If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server.\n> This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n> When this value is returned in a response, it is always empty because it is not stored.",
Expand Down Expand Up @@ -840,6 +844,7 @@
"type" : "object"
},
"FraudCheckResult" : {
"additionalProperties" : false,
"properties" : {
"accountScore" : {
"description" : "The fraud score generated by the risk check.",
Expand Down Expand Up @@ -871,6 +876,7 @@
}
},
"FraudResult" : {
"additionalProperties" : false,
"properties" : {
"accountScore" : {
"description" : "The total fraud score generated by the risk checks.",
Expand All @@ -891,6 +897,7 @@
"type" : "object"
},
"FundSource" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand Down Expand Up @@ -923,6 +930,7 @@
"type" : "object"
},
"ModifyRequest" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand All @@ -947,6 +955,7 @@
"type" : "object"
},
"ModifyResponse" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand All @@ -971,6 +980,7 @@
"type" : "object"
},
"Name" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The first name.",
Expand All @@ -990,6 +1000,7 @@
"type" : "object"
},
"PayoutRequest" : {
"additionalProperties" : false,
"properties" : {
"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).",
Expand Down Expand Up @@ -1067,6 +1078,7 @@
"type" : "object"
},
"PayoutResponse" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand Down Expand Up @@ -1165,6 +1177,7 @@
"type" : "object"
},
"Recurring" : {
"additionalProperties" : false,
"properties" : {
"contract" : {
"description" : "The type of recurring contract to be used.\nPossible values:\n* `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n* `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not.\n* `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts).",
Expand Down Expand Up @@ -1194,6 +1207,7 @@
"type" : "object"
},
"ResponseAdditionalData3DSecure" : {
"additionalProperties" : false,
"properties" : {
"cardHolderInfo" : {
"description" : "Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. ",
Expand All @@ -1219,6 +1233,7 @@
"type" : "object"
},
"ResponseAdditionalDataBillingAddress" : {
"additionalProperties" : false,
"properties" : {
"billingAddress.city" : {
"description" : "The billing address city passed in the payment request.",
Expand Down Expand Up @@ -1248,6 +1263,7 @@
"type" : "object"
},
"ResponseAdditionalDataCard" : {
"additionalProperties" : false,
"properties" : {
"cardBin" : {
"description" : "The first six digits of the card number.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with a six-digit BIN.\n\nExample: 521234",
Expand Down Expand Up @@ -1285,6 +1301,7 @@
"type" : "object"
},
"ResponseAdditionalDataCommon" : {
"additionalProperties" : false,
"properties" : {
"acquirerAccountCode" : {
"description" : "The name of the Adyen acquirer account.\n\nExample: PayPalSandbox_TestAcquirer\n\n> Only relevant for PayPal transactions.",
Expand Down Expand Up @@ -1528,6 +1545,7 @@
"type" : "object"
},
"ResponseAdditionalDataDomesticError" : {
"additionalProperties" : false,
"properties" : {
"domesticRefusalReasonRaw" : {
"description" : "The reason the transaction was declined, given by the local issuer. \nCurrently available for merchants in Japan.",
Expand All @@ -1541,6 +1559,7 @@
"type" : "object"
},
"ResponseAdditionalDataInstallments" : {
"additionalProperties" : false,
"properties" : {
"installmentPaymentData.installmentType" : {
"description" : "Type of installment. The value of `installmentType` should be **IssuerFinanced**.",
Expand Down Expand Up @@ -1594,6 +1613,7 @@
"type" : "object"
},
"ResponseAdditionalDataNetworkTokens" : {
"additionalProperties" : false,
"properties" : {
"networkToken.available" : {
"description" : "Indicates whether a network token is available for the specified card.",
Expand All @@ -1611,6 +1631,7 @@
"type" : "object"
},
"ResponseAdditionalDataOpi" : {
"additionalProperties" : false,
"properties" : {
"opi.transToken" : {
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
Expand All @@ -1620,6 +1641,7 @@
"type" : "object"
},
"ResponseAdditionalDataSepa" : {
"additionalProperties" : false,
"properties" : {
"sepadirectdebit.dateOfSignature" : {
"description" : "The transaction signature date.\n\nFormat: yyyy-MM-dd",
Expand All @@ -1637,6 +1659,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
Expand All @@ -1663,6 +1686,7 @@
"type" : "object"
},
"StoreDetailAndSubmitRequest" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand Down Expand Up @@ -1769,6 +1793,7 @@
"type" : "object"
},
"StoreDetailAndSubmitResponse" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand Down Expand Up @@ -1797,6 +1822,7 @@
"type" : "object"
},
"StoreDetailRequest" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand Down Expand Up @@ -1888,6 +1914,7 @@
"type" : "object"
},
"StoreDetailResponse" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand Down Expand Up @@ -1917,6 +1944,7 @@
"type" : "object"
},
"SubmitRequest" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand Down Expand Up @@ -2006,6 +2034,7 @@
"type" : "object"
},
"SubmitResponse" : {
"additionalProperties" : false,
"properties" : {
"additionalData" : {
"additionalProperties" : {
Expand Down
Loading

0 comments on commit 5951a01

Please sign in to comment.