jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated specs for Classic Payout API

Browse Source
This commit is contained in:
aleksei
2020-09-23 15:53:51 +02:00
parent dadbdd3a74
commit f868bea36b
16 changed files with 6988 additions and 199 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
json/PayoutService-v30.json
View File

@@ -445,7 +445,7 @@
"type" : "string"
},
"carRental.daysRented" : {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19",
"type" : "string"
},
"carRental.fuelCharges" : {
@@ -457,19 +457,19 @@
"type" : "string"
},
"carRental.locationCity" : {
"description" : "The location from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.locationCountry" : {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.locationStateProvince" : {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.noShowIndicator" : {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* 0 - Not applicable.\n* 1 - Customer was a no show.",
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.",
"type" : "string"
},
"carRental.oneWayDropOffCharges" : {
@@ -485,7 +485,7 @@
"type" : "string"
},
"carRental.rentalAgreementNumber" : {
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 14",
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9",
"type" : "string"
},
"carRental.rentalClassId" : {
@@ -517,7 +517,7 @@
"type" : "string"
},
"carRental.taxExemptIndicator" : {
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* 0 - Tax was not collected\n* 1 - Goods or services were tax exempt",
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected",
"type" : "string"
},
"travelEntertainmentAuthData.duration" : {
@@ -774,6 +774,14 @@
}
}
},
"AdditionalDataOpi" : {
"properties" : {
"opi.includeTransToken" : {
"description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nMake sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"AdditionalDataRatepay" : {
"properties" : {
"ratepay.installmentAmount" : {
@@ -1082,7 +1090,7 @@
"type" : "string"
},
"value" : {
"description" : "The payable amount that can be charged for the transaction.\n\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1460,6 +1468,9 @@
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
@@ -1693,6 +1704,9 @@
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
@@ -2114,6 +2128,14 @@
}
}
},
"ResponseAdditionalDataOpi" : {
"properties" : {
"opi.transToken" : {
"description" : "Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"ResponseAdditionalDataPayPal" : {
"properties" : {
"paypalEmail" : {

46
json/PayoutService-v40.json
View File

@@ -563,7 +563,7 @@
"type" : "string"
},
"carRental.daysRented" : {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19",
"type" : "string"
},
"carRental.fuelCharges" : {
@@ -575,19 +575,19 @@
"type" : "string"
},
"carRental.locationCity" : {
"description" : "The location from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.locationCountry" : {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.locationStateProvince" : {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.noShowIndicator" : {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* 0 - Not applicable.\n* 1 - Customer was a no show.",
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.",
"type" : "string"
},
"carRental.oneWayDropOffCharges" : {
@@ -603,7 +603,7 @@
"type" : "string"
},
"carRental.rentalAgreementNumber" : {
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 14",
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9",
"type" : "string"
},
"carRental.rentalClassId" : {
@@ -635,7 +635,7 @@
"type" : "string"
},
"carRental.taxExemptIndicator" : {
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* 0 - Tax was not collected\n* 1 - Goods or services were tax exempt",
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected",
"type" : "string"
},
"travelEntertainmentAuthData.duration" : {
@@ -892,6 +892,14 @@
}
}
},
"AdditionalDataOpi" : {
"properties" : {
"opi.includeTransToken" : {
"description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nMake sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"AdditionalDataRatepay" : {
"properties" : {
"ratepay.installmentAmount" : {
@@ -1200,7 +1208,7 @@
"type" : "string"
},
"value" : {
"description" : "The payable amount that can be charged for the transaction.\n\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1645,11 +1653,11 @@
"type" : "string"
},
"giftCardAmount" : {
"description" : "The amount of prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).",
"$ref" : "#/components/schemas/Amount"
},
"giftCardCount" : {
"description" : "Number of individual prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.",
"format" : "int32",
"type" : "integer"
},
@@ -1779,6 +1787,9 @@
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
@@ -2035,6 +2046,9 @@
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
@@ -2465,6 +2479,14 @@
}
}
},
"ResponseAdditionalDataOpi" : {
"properties" : {
"opi.transToken" : {
"description" : "Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"ResponseAdditionalDataPayPal" : {
"properties" : {
"paypalEmail" : {
@@ -3056,6 +3078,10 @@
],
"type" : "string"
},
"dsTransID" : {
"description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.",
"type" : "string"
},
"eci" : {
"description" : "The electronic commerce indicator.",
"type" : "string"

42
json/PayoutService-v46.json
View File

@@ -563,7 +563,7 @@
"type" : "string"
},
"carRental.daysRented" : {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19",
"type" : "string"
},
"carRental.fuelCharges" : {
@@ -575,19 +575,19 @@
"type" : "string"
},
"carRental.locationCity" : {
"description" : "The location from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.locationCountry" : {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.locationStateProvince" : {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.noShowIndicator" : {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* 0 - Not applicable.\n* 1 - Customer was a no show.",
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.",
"type" : "string"
},
"carRental.oneWayDropOffCharges" : {
@@ -603,7 +603,7 @@
"type" : "string"
},
"carRental.rentalAgreementNumber" : {
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 14",
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9",
"type" : "string"
},
"carRental.rentalClassId" : {
@@ -635,7 +635,7 @@
"type" : "string"
},
"carRental.taxExemptIndicator" : {
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* 0 - Tax was not collected\n* 1 - Goods or services were tax exempt",
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected",
"type" : "string"
},
"travelEntertainmentAuthData.duration" : {
@@ -892,6 +892,14 @@
}
}
},
"AdditionalDataOpi" : {
"properties" : {
"opi.includeTransToken" : {
"description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nMake sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"AdditionalDataRatepay" : {
"properties" : {
"ratepay.installmentAmount" : {
@@ -1200,7 +1208,7 @@
"type" : "string"
},
"value" : {
"description" : "The payable amount that can be charged for the transaction.\n\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1645,11 +1653,11 @@
"type" : "string"
},
"giftCardAmount" : {
"description" : "The amount of prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).",
"$ref" : "#/components/schemas/Amount"
},
"giftCardCount" : {
"description" : "Number of individual prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.",
"format" : "int32",
"type" : "integer"
},
@@ -1779,6 +1787,9 @@
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
@@ -2035,6 +2046,9 @@
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
@@ -2465,6 +2479,14 @@
}
}
},
"ResponseAdditionalDataOpi" : {
"properties" : {
"opi.transToken" : {
"description" : "Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"ResponseAdditionalDataPayPal" : {
"properties" : {
"paypalEmail" : {

42
json/PayoutService-v49.json
View File

@@ -563,7 +563,7 @@
"type" : "string"
},
"carRental.daysRented" : {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19",
"type" : "string"
},
"carRental.fuelCharges" : {
@@ -575,19 +575,19 @@
"type" : "string"
},
"carRental.locationCity" : {
"description" : "The location from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.locationCountry" : {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.locationStateProvince" : {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.noShowIndicator" : {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* 0 - Not applicable.\n* 1 - Customer was a no show.",
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.",
"type" : "string"
},
"carRental.oneWayDropOffCharges" : {
@@ -603,7 +603,7 @@
"type" : "string"
},
"carRental.rentalAgreementNumber" : {
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 14",
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9",
"type" : "string"
},
"carRental.rentalClassId" : {
@@ -635,7 +635,7 @@
"type" : "string"
},
"carRental.taxExemptIndicator" : {
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* 0 - Tax was not collected\n* 1 - Goods or services were tax exempt",
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected",
"type" : "string"
},
"travelEntertainmentAuthData.duration" : {
@@ -892,6 +892,14 @@
}
}
},
"AdditionalDataOpi" : {
"properties" : {
"opi.includeTransToken" : {
"description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nMake sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"AdditionalDataRatepay" : {
"properties" : {
"ratepay.installmentAmount" : {
@@ -1200,7 +1208,7 @@
"type" : "string"
},
"value" : {
"description" : "The payable amount that can be charged for the transaction.\n\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1645,11 +1653,11 @@
"type" : "string"
},
"giftCardAmount" : {
"description" : "The amount of prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).",
"$ref" : "#/components/schemas/Amount"
},
"giftCardCount" : {
"description" : "Number of individual prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.",
"format" : "int32",
"type" : "integer"
},
@@ -1779,6 +1787,9 @@
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
@@ -2035,6 +2046,9 @@
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
@@ -2465,6 +2479,14 @@
}
}
},
"ResponseAdditionalDataOpi" : {
"properties" : {
"opi.transToken" : {
"description" : "Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"ResponseAdditionalDataPayPal" : {
"properties" : {
"paypalEmail" : {

45
json/PayoutService-v50.json
View File

@@ -572,7 +572,7 @@
"type" : "string"
},
"carRental.daysRented" : {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19",
"type" : "string"
},
"carRental.fuelCharges" : {
@@ -584,19 +584,19 @@
"type" : "string"
},
"carRental.locationCity" : {
"description" : "The location from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.locationCountry" : {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.locationStateProvince" : {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.noShowIndicator" : {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* 0 - Not applicable.\n* 1 - Customer was a no show.",
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.",
"type" : "string"
},
"carRental.oneWayDropOffCharges" : {
@@ -612,7 +612,7 @@
"type" : "string"
},
"carRental.rentalAgreementNumber" : {
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 14",
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9",
"type" : "string"
},
"carRental.rentalClassId" : {
@@ -644,7 +644,7 @@
"type" : "string"
},
"carRental.taxExemptIndicator" : {
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* 0 - Tax was not collected\n* 1 - Goods or services were tax exempt",
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected",
"type" : "string"
},
"travelEntertainmentAuthData.duration" : {
@@ -901,6 +901,14 @@
}
}
},
"AdditionalDataOpi" : {
"properties" : {
"opi.includeTransToken" : {
"description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nMake sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"AdditionalDataRatepay" : {
"properties" : {
"ratepay.installmentAmount" : {
@@ -1209,7 +1217,7 @@
"type" : "string"
},
"value" : {
"description" : "The payable amount that can be charged for the transaction.\n\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1654,11 +1662,11 @@
"type" : "string"
},
"giftCardAmount" : {
"description" : "The amount of prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).",
"$ref" : "#/components/schemas/Amount"
},
"giftCardCount" : {
"description" : "Number of individual prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.",
"format" : "int32",
"type" : "integer"
},
@@ -1788,6 +1796,9 @@
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
@@ -2049,6 +2060,9 @@
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
@@ -2479,6 +2493,14 @@
}
}
},
"ResponseAdditionalDataOpi" : {
"properties" : {
"opi.transToken" : {
"description" : "Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"ResponseAdditionalDataPayPal" : {
"properties" : {
"paypalEmail" : {
@@ -2966,6 +2988,9 @@
},
"authenticationOnly" : {
"default" : "false",
"deprecated" : true,
"x-deprecatedInVersion" : 50,
"x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.",
"description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.",
"type" : "boolean"
},

45
json/PayoutService-v51.json
View File

@@ -572,7 +572,7 @@
"type" : "string"
},
"carRental.daysRented" : {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19",
"type" : "string"
},
"carRental.fuelCharges" : {
@@ -584,19 +584,19 @@
"type" : "string"
},
"carRental.locationCity" : {
"description" : "The location from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.locationCountry" : {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.locationStateProvince" : {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.noShowIndicator" : {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* 0 - Not applicable.\n* 1 - Customer was a no show.",
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.",
"type" : "string"
},
"carRental.oneWayDropOffCharges" : {
@@ -612,7 +612,7 @@
"type" : "string"
},
"carRental.rentalAgreementNumber" : {
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 14",
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9",
"type" : "string"
},
"carRental.rentalClassId" : {
@@ -644,7 +644,7 @@
"type" : "string"
},
"carRental.taxExemptIndicator" : {
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* 0 - Tax was not collected\n* 1 - Goods or services were tax exempt",
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected",
"type" : "string"
},
"travelEntertainmentAuthData.duration" : {
@@ -901,6 +901,14 @@
}
}
},
"AdditionalDataOpi" : {
"properties" : {
"opi.includeTransToken" : {
"description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nMake sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"AdditionalDataRatepay" : {
"properties" : {
"ratepay.installmentAmount" : {
@@ -1209,7 +1217,7 @@
"type" : "string"
},
"value" : {
"description" : "The payable amount that can be charged for the transaction.\n\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1654,11 +1662,11 @@
"type" : "string"
},
"giftCardAmount" : {
"description" : "The amount of prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).",
"$ref" : "#/components/schemas/Amount"
},
"giftCardCount" : {
"description" : "Number of individual prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.",
"format" : "int32",
"type" : "integer"
},
@@ -1788,6 +1796,9 @@
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
@@ -2054,6 +2065,9 @@
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
@@ -2484,6 +2498,14 @@
}
}
},
"ResponseAdditionalDataOpi" : {
"properties" : {
"opi.transToken" : {
"description" : "Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"ResponseAdditionalDataPayPal" : {
"properties" : {
"paypalEmail" : {
@@ -2971,6 +2993,9 @@
},
"authenticationOnly" : {
"default" : "false",
"deprecated" : true,
"x-deprecatedInVersion" : 50,
"x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.",
"description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.",
"type" : "boolean"
},

45
json/PayoutService-v52.json
View File

@@ -572,7 +572,7 @@
"type" : "string"
},
"carRental.daysRented" : {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19",
"type" : "string"
},
"carRental.fuelCharges" : {
@@ -584,19 +584,19 @@
"type" : "string"
},
"carRental.locationCity" : {
"description" : "The location from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.locationCountry" : {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.locationStateProvince" : {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.noShowIndicator" : {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* 0 - Not applicable.\n* 1 - Customer was a no show.",
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.",
"type" : "string"
},
"carRental.oneWayDropOffCharges" : {
@@ -612,7 +612,7 @@
"type" : "string"
},
"carRental.rentalAgreementNumber" : {
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 14",
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9",
"type" : "string"
},
"carRental.rentalClassId" : {
@@ -644,7 +644,7 @@
"type" : "string"
},
"carRental.taxExemptIndicator" : {
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* 0 - Tax was not collected\n* 1 - Goods or services were tax exempt",
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected",
"type" : "string"
},
"travelEntertainmentAuthData.duration" : {
@@ -901,6 +901,14 @@
}
}
},
"AdditionalDataOpi" : {
"properties" : {
"opi.includeTransToken" : {
"description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nMake sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"AdditionalDataRatepay" : {
"properties" : {
"ratepay.installmentAmount" : {
@@ -1209,7 +1217,7 @@
"type" : "string"
},
"value" : {
"description" : "The payable amount that can be charged for the transaction.\n\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1654,11 +1662,11 @@
"type" : "string"
},
"giftCardAmount" : {
"description" : "The amount of prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).",
"$ref" : "#/components/schemas/Amount"
},
"giftCardCount" : {
"description" : "Number of individual prepaid or gift cards used for this purchase.",
"description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.",
"format" : "int32",
"type" : "integer"
},
@@ -1788,6 +1796,9 @@
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
@@ -2062,6 +2073,9 @@
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
@@ -2492,6 +2506,14 @@
}
}
},
"ResponseAdditionalDataOpi" : {
"properties" : {
"opi.transToken" : {
"description" : "Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.",
"type" : "string"
}
}
},
"ResponseAdditionalDataPayPal" : {
"properties" : {
"paypalEmail" : {
@@ -2987,6 +3009,9 @@
},
"authenticationOnly" : {
"default" : "false",
"deprecated" : true,
"x-deprecatedInVersion" : 50,
"x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.",
"description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.",
"type" : "boolean"
},

3190
json/PayoutService-v64.json Normal file
View File

File diff suppressed because it is too large Load Diff

47
yaml/PayoutService-v30.yaml
View File

@@ -450,9 +450,9 @@ components:
type: string
carRental.daysRented:
description: |-
Specifies whether the given rate is applied daily or weekly.
* D - Daily rate.
* W - Weekly rate.
Number of days for which the car is being rented.
* Format: Numeric
* maxLength: 19
type: string
carRental.fuelCharges:
description: |-
@@ -468,26 +468,27 @@ components:
type: string
carRental.locationCity:
description: |-
The location from which the car is rented.
The city from which the car is rented.
* Format: Alphanumeric
* maxLength: 18
type: string
carRental.locationCountry:
description: |-
The customer service phone number of the car rental company.
The country from which the car is rented.
* Format: Alphanumeric
* maxLength: 17
* maxLength: 2
type: string
carRental.locationStateProvince:
description: |-
Pick-up date.
* Date format: `yyyyMMdd`
The state or province from where the car is rented.
* Format: Alphanumeric
* maxLength: 3
type: string
carRental.noShowIndicator:
description: |-
Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
* 0 - Not applicable.
* 1 - Customer was a no show.
* Y - Customer was a no show.
* N - Not applicable.
type: string
carRental.oneWayDropOffCharges:
description: Charge associated with not returning a vehicle to the original rental location.
@@ -508,7 +509,7 @@ components:
description: |-
The rental agreement number associated with this car rental.
* Format: Alphanumeric
* maxLength: 14
* maxLength: 9
type: string
carRental.rentalClassId:
description: |-
@@ -556,8 +557,8 @@ components:
Indicates whether the goods or services were tax-exempt, or tax was not collected.
Values:
* 0 - Tax was not collected
* 1 - Goods or services were tax exempt
* Y - Goods or services were tax exempt
* N - Tax was not collected
type: string
travelEntertainmentAuthData.duration:
description: |-
@@ -964,6 +965,14 @@ components:
* Low
* None.
type: string
AdditionalDataOpi:
properties:
opi.includeTransToken:
description: |-
Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.
Make sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
AdditionalDataRatepay:
properties:
ratepay.installmentAmount:
@@ -1235,10 +1244,7 @@ components:
minLength: 3
type: string
value:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
description: 'The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).'
format: int64
type: integer
required:
@@ -1548,6 +1554,7 @@ components:
- $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'
@@ -1762,6 +1769,7 @@ components:
- $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress'
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
- $ref: '#/components/schemas/ResponseAdditionalDataPayPal'
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
description: 'This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.'
@@ -2308,6 +2316,11 @@ components:
networkToken.tokenSummary:
description: The last four digits of a card number.
type: string
ResponseAdditionalDataOpi:
properties:
opi.transToken:
description: Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
ResponseAdditionalDataPayPal:
properties:
paypalEmail:

54
yaml/PayoutService-v40.yaml
View File

@@ -576,9 +576,9 @@ components:
type: string
carRental.daysRented:
description: |-
Specifies whether the given rate is applied daily or weekly.
* D - Daily rate.
* W - Weekly rate.
Number of days for which the car is being rented.
* Format: Numeric
* maxLength: 19
type: string
carRental.fuelCharges:
description: |-
@@ -594,26 +594,27 @@ components:
type: string
carRental.locationCity:
description: |-
The location from which the car is rented.
The city from which the car is rented.
* Format: Alphanumeric
* maxLength: 18
type: string
carRental.locationCountry:
description: |-
The customer service phone number of the car rental company.
The country from which the car is rented.
* Format: Alphanumeric
* maxLength: 17
* maxLength: 2
type: string
carRental.locationStateProvince:
description: |-
Pick-up date.
* Date format: `yyyyMMdd`
The state or province from where the car is rented.
* Format: Alphanumeric
* maxLength: 3
type: string
carRental.noShowIndicator:
description: |-
Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
* 0 - Not applicable.
* 1 - Customer was a no show.
* Y - Customer was a no show.
* N - Not applicable.
type: string
carRental.oneWayDropOffCharges:
description: Charge associated with not returning a vehicle to the original rental location.
@@ -634,7 +635,7 @@ components:
description: |-
The rental agreement number associated with this car rental.
* Format: Alphanumeric
* maxLength: 14
* maxLength: 9
type: string
carRental.rentalClassId:
description: |-
@@ -682,8 +683,8 @@ components:
Indicates whether the goods or services were tax-exempt, or tax was not collected.
Values:
* 0 - Tax was not collected
* 1 - Goods or services were tax exempt
* Y - Goods or services were tax exempt
* N - Tax was not collected
type: string
travelEntertainmentAuthData.duration:
description: |-
@@ -1090,6 +1091,14 @@ components:
* Low
* None.
type: string
AdditionalDataOpi:
properties:
opi.includeTransToken:
description: |-
Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.
Make sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
AdditionalDataRatepay:
properties:
ratepay.installmentAmount:
@@ -1361,10 +1370,7 @@ components:
minLength: 3
type: string
value:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
description: 'The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).'
format: int64
type: integer
required:
@@ -1754,10 +1760,10 @@ components:
- twoOrMoreDaysShipping
type: string
giftCardAmount:
description: The amount of prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).'
$ref: '#/components/schemas/Amount'
giftCardCount:
description: Number of individual prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.'
format: int32
type: integer
preOrderDate:
@@ -1854,6 +1860,7 @@ components:
- $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'
@@ -2087,6 +2094,7 @@ components:
- $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress'
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
- $ref: '#/components/schemas/ResponseAdditionalDataPayPal'
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
description: 'This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.'
@@ -2640,6 +2648,11 @@ components:
networkToken.tokenSummary:
description: The last four digits of a card number.
type: string
ResponseAdditionalDataOpi:
properties:
opi.transToken:
description: Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
ResponseAdditionalDataPayPal:
properties:
paypalEmail:
@@ -3228,6 +3241,9 @@ components:
- U
- 'Y'
type: string
dsTransID:
description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
type: string
eci:
description: The electronic commerce indicator.
type: string

51
yaml/PayoutService-v46.yaml
View File

@@ -576,9 +576,9 @@ components:
type: string
carRental.daysRented:
description: |-
Specifies whether the given rate is applied daily or weekly.
* D - Daily rate.
* W - Weekly rate.
Number of days for which the car is being rented.
* Format: Numeric
* maxLength: 19
type: string
carRental.fuelCharges:
description: |-
@@ -594,26 +594,27 @@ components:
type: string
carRental.locationCity:
description: |-
The location from which the car is rented.
The city from which the car is rented.
* Format: Alphanumeric
* maxLength: 18
type: string
carRental.locationCountry:
description: |-
The customer service phone number of the car rental company.
The country from which the car is rented.
* Format: Alphanumeric
* maxLength: 17
* maxLength: 2
type: string
carRental.locationStateProvince:
description: |-
Pick-up date.
* Date format: `yyyyMMdd`
The state or province from where the car is rented.
* Format: Alphanumeric
* maxLength: 3
type: string
carRental.noShowIndicator:
description: |-
Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
* 0 - Not applicable.
* 1 - Customer was a no show.
* Y - Customer was a no show.
* N - Not applicable.
type: string
carRental.oneWayDropOffCharges:
description: Charge associated with not returning a vehicle to the original rental location.
@@ -634,7 +635,7 @@ components:
description: |-
The rental agreement number associated with this car rental.
* Format: Alphanumeric
* maxLength: 14
* maxLength: 9
type: string
carRental.rentalClassId:
description: |-
@@ -682,8 +683,8 @@ components:
Indicates whether the goods or services were tax-exempt, or tax was not collected.
Values:
* 0 - Tax was not collected
* 1 - Goods or services were tax exempt
* Y - Goods or services were tax exempt
* N - Tax was not collected
type: string
travelEntertainmentAuthData.duration:
description: |-
@@ -1090,6 +1091,14 @@ components:
* Low
* None.
type: string
AdditionalDataOpi:
properties:
opi.includeTransToken:
description: |-
Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.
Make sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
AdditionalDataRatepay:
properties:
ratepay.installmentAmount:
@@ -1361,10 +1370,7 @@ components:
minLength: 3
type: string
value:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
description: 'The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).'
format: int64
type: integer
required:
@@ -1754,10 +1760,10 @@ components:
- twoOrMoreDaysShipping
type: string
giftCardAmount:
description: The amount of prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).'
$ref: '#/components/schemas/Amount'
giftCardCount:
description: Number of individual prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.'
format: int32
type: integer
preOrderDate:
@@ -1854,6 +1860,7 @@ components:
- $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'
@@ -2087,6 +2094,7 @@ components:
- $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress'
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
- $ref: '#/components/schemas/ResponseAdditionalDataPayPal'
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
description: 'This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.'
@@ -2640,6 +2648,11 @@ components:
networkToken.tokenSummary:
description: The last four digits of a card number.
type: string
ResponseAdditionalDataOpi:
properties:
opi.transToken:
description: Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
ResponseAdditionalDataPayPal:
properties:
paypalEmail:

51
yaml/PayoutService-v49.yaml
View File

@@ -576,9 +576,9 @@ components:
type: string
carRental.daysRented:
description: |-
Specifies whether the given rate is applied daily or weekly.
* D - Daily rate.
* W - Weekly rate.
Number of days for which the car is being rented.
* Format: Numeric
* maxLength: 19
type: string
carRental.fuelCharges:
description: |-
@@ -594,26 +594,27 @@ components:
type: string
carRental.locationCity:
description: |-
The location from which the car is rented.
The city from which the car is rented.
* Format: Alphanumeric
* maxLength: 18
type: string
carRental.locationCountry:
description: |-
The customer service phone number of the car rental company.
The country from which the car is rented.
* Format: Alphanumeric
* maxLength: 17
* maxLength: 2
type: string
carRental.locationStateProvince:
description: |-
Pick-up date.
* Date format: `yyyyMMdd`
The state or province from where the car is rented.
* Format: Alphanumeric
* maxLength: 3
type: string
carRental.noShowIndicator:
description: |-
Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
* 0 - Not applicable.
* 1 - Customer was a no show.
* Y - Customer was a no show.
* N - Not applicable.
type: string
carRental.oneWayDropOffCharges:
description: Charge associated with not returning a vehicle to the original rental location.
@@ -634,7 +635,7 @@ components:
description: |-
The rental agreement number associated with this car rental.
* Format: Alphanumeric
* maxLength: 14
* maxLength: 9
type: string
carRental.rentalClassId:
description: |-
@@ -682,8 +683,8 @@ components:
Indicates whether the goods or services were tax-exempt, or tax was not collected.
Values:
* 0 - Tax was not collected
* 1 - Goods or services were tax exempt
* Y - Goods or services were tax exempt
* N - Tax was not collected
type: string
travelEntertainmentAuthData.duration:
description: |-
@@ -1090,6 +1091,14 @@ components:
* Low
* None.
type: string
AdditionalDataOpi:
properties:
opi.includeTransToken:
description: |-
Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.
Make sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
AdditionalDataRatepay:
properties:
ratepay.installmentAmount:
@@ -1361,10 +1370,7 @@ components:
minLength: 3
type: string
value:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
description: 'The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).'
format: int64
type: integer
required:
@@ -1754,10 +1760,10 @@ components:
- twoOrMoreDaysShipping
type: string
giftCardAmount:
description: The amount of prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).'
$ref: '#/components/schemas/Amount'
giftCardCount:
description: Number of individual prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.'
format: int32
type: integer
preOrderDate:
@@ -1854,6 +1860,7 @@ components:
- $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'
@@ -2087,6 +2094,7 @@ components:
- $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress'
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
- $ref: '#/components/schemas/ResponseAdditionalDataPayPal'
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
description: 'This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.'
@@ -2640,6 +2648,11 @@ components:
networkToken.tokenSummary:
description: The last four digits of a card number.
type: string
ResponseAdditionalDataOpi:
properties:
opi.transToken:
description: Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
ResponseAdditionalDataPayPal:
properties:
paypalEmail:

54
yaml/PayoutService-v50.yaml
View File

@@ -588,9 +588,9 @@ components:
type: string
carRental.daysRented:
description: |-
Specifies whether the given rate is applied daily or weekly.
* D - Daily rate.
* W - Weekly rate.
Number of days for which the car is being rented.
* Format: Numeric
* maxLength: 19
type: string
carRental.fuelCharges:
description: |-
@@ -606,26 +606,27 @@ components:
type: string
carRental.locationCity:
description: |-
The location from which the car is rented.
The city from which the car is rented.
* Format: Alphanumeric
* maxLength: 18
type: string
carRental.locationCountry:
description: |-
The customer service phone number of the car rental company.
The country from which the car is rented.
* Format: Alphanumeric
* maxLength: 17
* maxLength: 2
type: string
carRental.locationStateProvince:
description: |-
Pick-up date.
* Date format: `yyyyMMdd`
The state or province from where the car is rented.
* Format: Alphanumeric
* maxLength: 3
type: string
carRental.noShowIndicator:
description: |-
Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
* 0 - Not applicable.
* 1 - Customer was a no show.
* Y - Customer was a no show.
* N - Not applicable.
type: string
carRental.oneWayDropOffCharges:
description: Charge associated with not returning a vehicle to the original rental location.
@@ -646,7 +647,7 @@ components:
description: |-
The rental agreement number associated with this car rental.
* Format: Alphanumeric
* maxLength: 14
* maxLength: 9
type: string
carRental.rentalClassId:
description: |-
@@ -694,8 +695,8 @@ components:
Indicates whether the goods or services were tax-exempt, or tax was not collected.
Values:
* 0 - Tax was not collected
* 1 - Goods or services were tax exempt
* Y - Goods or services were tax exempt
* N - Tax was not collected
type: string
travelEntertainmentAuthData.duration:
description: |-
@@ -1102,6 +1103,14 @@ components:
* Low
* None.
type: string
AdditionalDataOpi:
properties:
opi.includeTransToken:
description: |-
Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.
Make sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
AdditionalDataRatepay:
properties:
ratepay.installmentAmount:
@@ -1373,10 +1382,7 @@ components:
minLength: 3
type: string
value:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
description: 'The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).'
format: int64
type: integer
required:
@@ -1766,10 +1772,10 @@ components:
- twoOrMoreDaysShipping
type: string
giftCardAmount:
description: The amount of prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).'
$ref: '#/components/schemas/Amount'
giftCardCount:
description: Number of individual prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.'
format: int32
type: integer
preOrderDate:
@@ -1866,6 +1872,7 @@ components:
- $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'
@@ -2103,6 +2110,7 @@ components:
- $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress'
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
- $ref: '#/components/schemas/ResponseAdditionalDataPayPal'
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
description: 'This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.'
@@ -2656,6 +2664,11 @@ components:
networkToken.tokenSummary:
description: The last four digits of a card number.
type: string
ResponseAdditionalDataOpi:
properties:
opi.transToken:
description: Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
ResponseAdditionalDataPayPal:
properties:
paypalEmail:
@@ -3134,6 +3147,9 @@ components:
type: string
authenticationOnly:
default: 'false'
deprecated: true
x-deprecatedInVersion: 50
x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead.
description: 'If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.'
type: boolean
challengeIndicator:

54
yaml/PayoutService-v51.yaml
View File

@@ -588,9 +588,9 @@ components:
type: string
carRental.daysRented:
description: |-
Specifies whether the given rate is applied daily or weekly.
* D - Daily rate.
* W - Weekly rate.
Number of days for which the car is being rented.
* Format: Numeric
* maxLength: 19
type: string
carRental.fuelCharges:
description: |-
@@ -606,26 +606,27 @@ components:
type: string
carRental.locationCity:
description: |-
The location from which the car is rented.
The city from which the car is rented.
* Format: Alphanumeric
* maxLength: 18
type: string
carRental.locationCountry:
description: |-
The customer service phone number of the car rental company.
The country from which the car is rented.
* Format: Alphanumeric
* maxLength: 17
* maxLength: 2
type: string
carRental.locationStateProvince:
description: |-
Pick-up date.
* Date format: `yyyyMMdd`
The state or province from where the car is rented.
* Format: Alphanumeric
* maxLength: 3
type: string
carRental.noShowIndicator:
description: |-
Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
* 0 - Not applicable.
* 1 - Customer was a no show.
* Y - Customer was a no show.
* N - Not applicable.
type: string
carRental.oneWayDropOffCharges:
description: Charge associated with not returning a vehicle to the original rental location.
@@ -646,7 +647,7 @@ components:
description: |-
The rental agreement number associated with this car rental.
* Format: Alphanumeric
* maxLength: 14
* maxLength: 9
type: string
carRental.rentalClassId:
description: |-
@@ -694,8 +695,8 @@ components:
Indicates whether the goods or services were tax-exempt, or tax was not collected.
Values:
* 0 - Tax was not collected
* 1 - Goods or services were tax exempt
* Y - Goods or services were tax exempt
* N - Tax was not collected
type: string
travelEntertainmentAuthData.duration:
description: |-
@@ -1102,6 +1103,14 @@ components:
* Low
* None.
type: string
AdditionalDataOpi:
properties:
opi.includeTransToken:
description: |-
Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.
Make sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
AdditionalDataRatepay:
properties:
ratepay.installmentAmount:
@@ -1373,10 +1382,7 @@ components:
minLength: 3
type: string
value:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
description: 'The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).'
format: int64
type: integer
required:
@@ -1766,10 +1772,10 @@ components:
- twoOrMoreDaysShipping
type: string
giftCardAmount:
description: The amount of prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).'
$ref: '#/components/schemas/Amount'
giftCardCount:
description: Number of individual prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.'
format: int32
type: integer
preOrderDate:
@@ -1866,6 +1872,7 @@ components:
- $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'
@@ -2107,6 +2114,7 @@ components:
- $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress'
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
- $ref: '#/components/schemas/ResponseAdditionalDataPayPal'
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
description: 'This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.'
@@ -2660,6 +2668,11 @@ components:
networkToken.tokenSummary:
description: The last four digits of a card number.
type: string
ResponseAdditionalDataOpi:
properties:
opi.transToken:
description: Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
ResponseAdditionalDataPayPal:
properties:
paypalEmail:
@@ -3138,6 +3151,9 @@ components:
type: string
authenticationOnly:
default: 'false'
deprecated: true
x-deprecatedInVersion: 50
x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead.
description: 'If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.'
type: boolean
challengeIndicator:

54
yaml/PayoutService-v52.yaml
View File

@@ -588,9 +588,9 @@ components:
type: string
carRental.daysRented:
description: |-
Specifies whether the given rate is applied daily or weekly.
* D - Daily rate.
* W - Weekly rate.
Number of days for which the car is being rented.
* Format: Numeric
* maxLength: 19
type: string
carRental.fuelCharges:
description: |-
@@ -606,26 +606,27 @@ components:
type: string
carRental.locationCity:
description: |-
The location from which the car is rented.
The city from which the car is rented.
* Format: Alphanumeric
* maxLength: 18
type: string
carRental.locationCountry:
description: |-
The customer service phone number of the car rental company.
The country from which the car is rented.
* Format: Alphanumeric
* maxLength: 17
* maxLength: 2
type: string
carRental.locationStateProvince:
description: |-
Pick-up date.
* Date format: `yyyyMMdd`
The state or province from where the car is rented.
* Format: Alphanumeric
* maxLength: 3
type: string
carRental.noShowIndicator:
description: |-
Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
* 0 - Not applicable.
* 1 - Customer was a no show.
* Y - Customer was a no show.
* N - Not applicable.
type: string
carRental.oneWayDropOffCharges:
description: Charge associated with not returning a vehicle to the original rental location.
@@ -646,7 +647,7 @@ components:
description: |-
The rental agreement number associated with this car rental.
* Format: Alphanumeric
* maxLength: 14
* maxLength: 9
type: string
carRental.rentalClassId:
description: |-
@@ -694,8 +695,8 @@ components:
Indicates whether the goods or services were tax-exempt, or tax was not collected.
Values:
* 0 - Tax was not collected
* 1 - Goods or services were tax exempt
* Y - Goods or services were tax exempt
* N - Tax was not collected
type: string
travelEntertainmentAuthData.duration:
description: |-
@@ -1102,6 +1103,14 @@ components:
* Low
* None.
type: string
AdditionalDataOpi:
properties:
opi.includeTransToken:
description: |-
Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.
Make sure that you set `shopperInteraction` to **Ecommerce** and leave the `shopperReference` blank. You can use this token to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
AdditionalDataRatepay:
properties:
ratepay.installmentAmount:
@@ -1373,10 +1382,7 @@ components:
minLength: 3
type: string
value:
description: |-
The payable amount that can be charged for the transaction.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
description: 'The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).'
format: int64
type: integer
required:
@@ -1766,10 +1772,10 @@ components:
- twoOrMoreDaysShipping
type: string
giftCardAmount:
description: The amount of prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).'
$ref: '#/components/schemas/Amount'
giftCardCount:
description: Number of individual prepaid or gift cards used for this purchase.
description: 'For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.'
format: int32
type: integer
preOrderDate:
@@ -1866,6 +1872,7 @@ components:
- $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'
@@ -2117,6 +2124,7 @@ components:
- $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress'
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
- $ref: '#/components/schemas/ResponseAdditionalDataPayPal'
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
description: 'This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.'
@@ -2670,6 +2678,11 @@ components:
networkToken.tokenSummary:
description: The last four digits of a card number.
type: string
ResponseAdditionalDataOpi:
properties:
opi.transToken:
description: Returned in the response if you included `opi.returnTransToken` in an ecommerce request. This contains an OPI token that you can use to identify an ecommerce transaction in your Oracle system integrations such as Opera.
type: string
ResponseAdditionalDataPayPal:
properties:
paypalEmail:
@@ -3154,6 +3167,9 @@ components:
type: string
authenticationOnly:
default: 'false'
deprecated: true
x-deprecatedInVersion: 50
x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead.
description: 'If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.'
type: boolean
challengeIndicator:

3329
yaml/PayoutService-v64.yaml Normal file
View File

File diff suppressed because it is too large Load Diff