mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
Updated YAML specs
This commit is contained in:
aleksei
@@ -80,7 +80,7 @@ paths:
|
||||
application/json:
|
||||
examples:
|
||||
confirmThirdParty:
|
||||
$ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty'
|
||||
$ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200'
|
||||
schema:
|
||||
$ref: '#/components/schemas/ModifyResponse'
|
||||
description: OK - the request has succeeded.
|
||||
@@ -89,7 +89,7 @@ paths:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic'
|
||||
$ref: '#/components/examples/generic-400'
|
||||
schema:
|
||||
$ref: '#/components/schemas/ServiceError'
|
||||
description: Bad Request - a problem reading or understanding the request.
|
||||
@@ -147,7 +147,7 @@ paths:
|
||||
application/json:
|
||||
examples:
|
||||
declineThirdParty:
|
||||
$ref: '#/components/examples/post-declineThirdParty-declineThirdParty'
|
||||
$ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200'
|
||||
schema:
|
||||
$ref: '#/components/schemas/ModifyResponse'
|
||||
description: OK - the request has succeeded.
|
||||
@@ -156,7 +156,7 @@ paths:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic'
|
||||
$ref: '#/components/examples/generic-400'
|
||||
schema:
|
||||
$ref: '#/components/schemas/ServiceError'
|
||||
description: Bad Request - a problem reading or understanding the request.
|
||||
@@ -222,7 +222,7 @@ paths:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic'
|
||||
$ref: '#/components/examples/generic-400'
|
||||
schema:
|
||||
$ref: '#/components/schemas/ServiceError'
|
||||
description: Bad Request - a problem reading or understanding the request.
|
||||
@@ -278,7 +278,7 @@ paths:
|
||||
application/json:
|
||||
examples:
|
||||
storeDetail:
|
||||
$ref: '#/components/examples/post-storeDetail-storeDetail'
|
||||
$ref: '#/components/examples/post-storeDetail-storeDetail-200'
|
||||
schema:
|
||||
$ref: '#/components/schemas/StoreDetailResponse'
|
||||
description: OK - the request has succeeded.
|
||||
@@ -287,7 +287,7 @@ paths:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic'
|
||||
$ref: '#/components/examples/generic-400'
|
||||
schema:
|
||||
$ref: '#/components/schemas/ServiceError'
|
||||
description: Bad Request - a problem reading or understanding the request.
|
||||
@@ -360,7 +360,7 @@ paths:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic'
|
||||
$ref: '#/components/examples/generic-400'
|
||||
schema:
|
||||
$ref: '#/components/schemas/ServiceError'
|
||||
description: Bad Request - a problem reading or understanding the request.
|
||||
@@ -426,7 +426,7 @@ paths:
|
||||
application/json:
|
||||
examples:
|
||||
generic:
|
||||
$ref: '#/components/examples/generic'
|
||||
$ref: '#/components/examples/generic-400'
|
||||
schema:
|
||||
$ref: '#/components/schemas/ServiceError'
|
||||
description: Bad Request - a problem reading or understanding the request.
|
||||
@@ -651,7 +651,9 @@ components:
|
||||
\ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\
|
||||
\ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\
|
||||
\ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\
|
||||
\ 3D Secure authentication.\n"
|
||||
\ 3D Secure authentication. Note that this setting results in refusals\
|
||||
\ if the issuer mandates 3D Secure because of the PSD2 directive or other,\
|
||||
\ national regulations. \n"
|
||||
type: string
|
||||
mpiImplementationType:
|
||||
description: In case of Secure+, this field must be set to **CUPSecurePlus**.
|
||||
@@ -2689,11 +2691,10 @@ components:
|
||||
$ref: '#/components/schemas/BankAccount'
|
||||
billingAddress:
|
||||
x-addedInVersion: '4'
|
||||
description: 'The address where to send the invoice.
|
||||
|
||||
> For 3D Secure 2 transactions, schemes require `billingAddress` for all
|
||||
browser-based and mobile implementations. Include all of the fields within
|
||||
this object.'
|
||||
description: "The address where to send the invoice.\n> For 3D Secure 2\
|
||||
\ transactions, schemes require `billingAddress` for all browser-based\
|
||||
\ and mobile implementations. Include all of the fields within this object.\
|
||||
\ \n\n> For cross-border payouts to and from Canada, this field is required."
|
||||
$ref: '#/components/schemas/Address'
|
||||
browserInfo:
|
||||
description: 'The shopper''s browser information.
|
||||
@@ -3021,7 +3022,6 @@ components:
|
||||
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
|
||||
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
|
||||
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
|
||||
- $ref: '#/components/schemas/ResponseAdditionalDataPayPal'
|
||||
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
|
||||
description: 'Contains additional information about the payment. Some data
|
||||
fields are included only if you select them first: Go to **Customer Area**
|
||||
@@ -3655,6 +3655,12 @@ components:
|
||||
|
||||
Example: AUTHORISED'
|
||||
type: string
|
||||
requestAmount:
|
||||
description: The amount of the payment request.
|
||||
type: string
|
||||
requestCurrencyCode:
|
||||
description: The currency of the payment request.
|
||||
type: string
|
||||
shopperInteraction:
|
||||
description: 'The shopper interaction type of the payment request.
|
||||
|
||||
@@ -3823,38 +3829,6 @@ components:
|
||||
tokenized ecommerce transactions. For more information and required settings,
|
||||
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
|
||||
type: string
|
||||
ResponseAdditionalDataPayPal:
|
||||
properties:
|
||||
paypalEmail:
|
||||
description: 'The buyer''s PayPal account email address.
|
||||
|
||||
|
||||
Example: paypaltest@adyen.com'
|
||||
type: string
|
||||
paypalPayerId:
|
||||
description: 'The buyer''s PayPal ID.
|
||||
|
||||
|
||||
Example: LF5HCWWBRV2KL'
|
||||
type: string
|
||||
paypalPayerResidenceCountry:
|
||||
description: 'The buyer''s country of residence.
|
||||
|
||||
|
||||
Example: NL'
|
||||
type: string
|
||||
paypalPayerStatus:
|
||||
description: 'The status of the buyer''s PayPal account.
|
||||
|
||||
|
||||
Example: unverified'
|
||||
type: string
|
||||
paypalProtectionEligibility:
|
||||
description: 'The eligibility for PayPal Seller Protection for this payment.
|
||||
|
||||
|
||||
Example: Ineligible'
|
||||
type: string
|
||||
ResponseAdditionalDataSepa:
|
||||
properties:
|
||||
sepadirectdebit.dateOfSignature:
|
||||
@@ -4015,7 +3989,10 @@ components:
|
||||
$ref: '#/components/schemas/BankAccount'
|
||||
billingAddress:
|
||||
x-addedInVersion: '18'
|
||||
description: The billing address.
|
||||
description: 'The billing address.
|
||||
|
||||
|
||||
> For cross-border payouts to and from Canada, this field is required.'
|
||||
$ref: '#/components/schemas/Address'
|
||||
card:
|
||||
description: 'A container for card data.
|
||||
@@ -4150,7 +4127,10 @@ components:
|
||||
$ref: '#/components/schemas/BankAccount'
|
||||
billingAddress:
|
||||
x-addedInVersion: '18'
|
||||
description: The billing address.
|
||||
description: 'The billing address.
|
||||
|
||||
|
||||
> For cross-border payouts to and from Canada, this field is required.'
|
||||
$ref: '#/components/schemas/Address'
|
||||
card:
|
||||
description: 'A container for card data.
|
||||
@@ -4617,7 +4597,7 @@ components:
|
||||
scheme: basic
|
||||
type: http
|
||||
examples:
|
||||
generic:
|
||||
generic-400:
|
||||
summary: Response code 400. Bad Request.
|
||||
value:
|
||||
status: 400
|
||||
@@ -4630,12 +4610,22 @@ components:
|
||||
value:
|
||||
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
||||
originalReference: '9913140798220028'
|
||||
post-confirmThirdParty-confirmThirdParty-200:
|
||||
summary: Example response for request 'confirmThirdParty'
|
||||
value:
|
||||
pspReference: 991617894325358C
|
||||
response: '[payout-confirm-received]'
|
||||
post-declineThirdParty-declineThirdParty:
|
||||
summary: Cancel a payout
|
||||
description: Cancel a previously submitted payout
|
||||
value:
|
||||
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
||||
originalReference: '9913140798220028'
|
||||
post-declineThirdParty-declineThirdParty-200:
|
||||
summary: Example response for request 'declineThirdParty'
|
||||
value:
|
||||
pspReference: 991617894325360J
|
||||
response: '[payout-decline-received]'
|
||||
post-payout-payout-b2c:
|
||||
summary: Instant card payout (B2C)
|
||||
description: Pay out to your sellers, customers, freelancers, etc
|
||||
@@ -4698,6 +4688,37 @@ components:
|
||||
dateOfBirth: '1990-01-01'
|
||||
nationality: NL
|
||||
post-storeDetail-storeDetail:
|
||||
summary: Store payout details
|
||||
description: Store payment details under the PAYOUT recurring contract
|
||||
value:
|
||||
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
||||
recurring:
|
||||
contract: PAYOUT
|
||||
bank:
|
||||
bankName: AbnAmro
|
||||
bic: ABNANL2A
|
||||
countryCode: NL
|
||||
iban: NL32ABNA0515071439
|
||||
ownerName: Adyen
|
||||
bankCity: Amsterdam
|
||||
taxId: bankTaxId
|
||||
shopperEmail: shopper@email.com
|
||||
shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
|
||||
shopperName:
|
||||
firstName: Adyen
|
||||
gender: MALE
|
||||
lastName: Test
|
||||
dateOfBirth: '1990-01-01'
|
||||
entityType: Company
|
||||
nationality: NL
|
||||
billingAddress:
|
||||
houseNumberOrName: '17'
|
||||
street: Teststreet 1
|
||||
city: Amsterdam
|
||||
stateOrProvince: NY
|
||||
country: US
|
||||
postalCode: '12345'
|
||||
post-storeDetail-storeDetail-200:
|
||||
summary: Example response for request 'storeDetail'
|
||||
value:
|
||||
pspReference: 991617894326362D
|
||||
|
||||
Reference in New Issue
Block a user