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

spec release

Browse Source
This commit is contained in:
Adyen Automation
2025-05-21 13:52:46 +02:00
parent fa60910663
commit f2d6771406
8 changed files with 1132 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
yaml/BalancePlatformBalanceNotification-v1.yaml
View File

@@ -20,9 +20,8 @@ info:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
version: '1'
x-timestamp: '2025-03-20T15:36:19Z'
x-timestamp: '2025-05-15T18:31:46Z'
tags:
- name: balancePlatform.balanceAccount.balance.updated
- name: Balances
webhooks:
balanceAccount.balance.updated:
@@ -44,9 +43,12 @@ webhooks:
description: Balance changed
value:
data:
settingIds: BWHS00000000000000000000000001
settingIds:
- BWHS00000000000000000000000001
- BWHS00000000000000000000000002
creationDate: '2025-01-19T13:37:38+02:00'
balancePlatform: YOUR_BALANCE_PLATFORM
balanceAccountId: BA00000000000000000000000001
currency: USD
balances:
available: 499900

248
yaml/BalancePlatformConfigurationNotification-v1.yaml
View File

@@ -19,6 +19,7 @@ tags:
- name: Balance account
- name: Payment instrument
- name: Card order
- name: Network token
webhooks:
balancePlatform.accountHolder.created:
post:
@@ -259,6 +260,54 @@ webhooks:
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.networkToken.created:
post:
tags:
- Network token
summary: Network token created
description: Adyen sends this webhook when you initiate a request for provisioning
a network token.
operationId: post-balancePlatform.networkToken.created
x-sortIndex: 1
x-methodName: networkTokenCreated
security:
- BasicAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkTokenNotificationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.networkToken.updated:
post:
tags:
- Network token
summary: Network token updated
description: Adyen sends this webhook when there is an internal status update
for the network token during the provisioning process.
operationId: post-balancePlatform.networkToken.updated
x-sortIndex: 2
x-methodName: networkTokenUpdated
security:
- BasicAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkTokenNotificationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.paymentInstrument.created:
post:
tags:
@@ -1098,7 +1147,8 @@ components:
description: 'Allocates a specific product range for either a physical or
a virtual card. Possible values: **fullySupported**, **secureCorporate**.
>Reach out to your Adyen contact to get the values relevant for your integration.'
> Reach out to your Adyen contact to get the values relevant for your
integration.'
type: string
required:
- formFactor
@@ -1312,6 +1362,21 @@ components:
- phone
- address
type: object
Device:
additionalProperties: false
properties:
formFactor:
description: 'The form factor of the device used for provisioning the network
token.
Possible values: **virtual**, **physical**.'
type: string
osName:
description: The operating system of the device used for provisioning the
network token.
type: string
type: object
Expiry:
additionalProperties: false
properties:
@@ -1354,6 +1419,81 @@ components:
- firstName
- lastName
type: object
NetworkTokenNotificationDataV2:
additionalProperties: false
properties:
authentication:
description: Contains information about the authentication process triggered
during token provisioning.
$ref: '#/components/schemas/TokenAuthentication'
authenticationApplied:
description: Specifies whether the authentication process was triggered
during token provisioning.
type: boolean
balancePlatform:
description: The unique identifier of the balance platform.
type: string
decision:
description: 'The decision about the network token provisioning.
Possible values: **approved**, **declined**, **requiresAuthentication**.'
type: string
id:
description: The unique identifier of the network token.
type: string
paymentInstrumentId:
description: The unique identifier of the payment instrument to which the
network token is associated.
type: string
status:
description: The status of the network token.
type: string
tokenLastFour:
description: The last four digits of the network token. Use this value to
help your user to identify their network token.
type: string
type:
description: The type of network token.
type: string
validationFacts:
description: The rules used to validate the request for provisioning the
network token.
items:
$ref: '#/components/schemas/ValidationFacts'
type: array
wallet:
description: Contains information about the wallet for which the network
token is provisioned.
$ref: '#/components/schemas/Wallet'
type: object
NetworkTokenNotificationRequest:
additionalProperties: false
properties:
data:
description: Contains event details.
$ref: '#/components/schemas/NetworkTokenNotificationDataV2'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
timestamp:
description: When the event was queued.
format: date-time
type: string
type:
description: The type of webhook.
enum:
- balancePlatform.networkToken.created
- balancePlatform.networkToken.updated
type: string
required:
- environment
- type
- data
type: object
PaymentInstrument:
additionalProperties: false
properties:
@@ -1863,6 +2003,46 @@ components:
required:
- type
type: object
TokenAuthentication:
additionalProperties: false
properties:
method:
description: 'The method used to complete the authentication process.
Possible values: **sms_OTP**, **email_OTP**.'
type: string
result:
description: The result of the authentication process.
type: string
type: object
ValidationFacts:
additionalProperties: false
properties:
reasons:
description: 'The reason for the `result` of the validations. For example:
**walletValidation**, **paymentInstrument**.
Sent only when `result` is **invalid**.'
items:
type: string
type: array
result:
description: 'The evaluation result of the validation facts.
Possible values: **valid**, **invalid**, **notValidated**, **notApplicable**.'
enum:
- invalid
- notApplicable
- notValidated
- valid
type: string
type:
description: The type of the validation fact.
type: string
type: object
VerificationDeadline:
additionalProperties: false
properties:
@@ -2120,6 +2300,72 @@ components:
type: array
required: []
type: object
Wallet:
additionalProperties: false
properties:
accountScore:
description: 'The confidence score of the wallet account, calculated by
the wallet provider.
A high score means that account is considered trustworthy. A low score
means that the account is considered suspicious.
Possible values: **1** to **5**.'
type: string
device:
description: Contains information about the device used for provisioning
the network token.
$ref: '#/components/schemas/Device'
deviceScore:
description: 'The confidence score of the device, calculated by the wallet
provider.
A high score means that device is considered trustworthy. A low score
means that the device is considered suspicious.
Possible values: **1** to **5**.'
type: string
provisioningMethod:
description: 'The method used for provisioning the network token.
Possible values: **push**, **manual**.'
type: string
recommendationReasons:
description: A list of codes that specify the reasons for the provided scores.
items:
enum:
- accountCardTooNew
- accountHighRisk
- accountRecentlyChanged
- accountTooNew
- accountTooNewSinceLaunch
- deviceRecentlyLost
- hasSuspendedTokens
- inactiveAccount
- lowAccountScore
- lowDeviceScore
- lowPhoneNumberScore
- outSideHomeTerritory
- suspiciousActivity
- tooManyDifferentCardholders
- tooManyRecentAttempts
- tooManyRecentTokens
- unableToAssess
- unknown
type: string
type: array
type:
description: 'The type of wallet that the network token is associated with.
Possible values: **applePay**, **googlePay**, **garminPay**.'
type: string
type: object
securitySchemes:
BasicAuth:
scheme: basic

248
yaml/BalancePlatformConfigurationNotification-v2.yaml
View File

@@ -19,6 +19,7 @@ tags:
- name: Balance account
- name: Payment instrument
- name: Card order
- name: Network token
webhooks:
balancePlatform.accountHolder.created:
post:
@@ -271,6 +272,54 @@ webhooks:
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.networkToken.created:
post:
tags:
- Network token
summary: Network token created
description: Adyen sends this webhook when you initiate a request for provisioning
a network token.
operationId: post-balancePlatform.networkToken.created
x-sortIndex: 1
x-methodName: networkTokenCreated
security:
- BasicAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkTokenNotificationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.networkToken.updated:
post:
tags:
- Network token
summary: Network token updated
description: Adyen sends this webhook when there is an internal status update
for the network token during the provisioning process.
operationId: post-balancePlatform.networkToken.updated
x-sortIndex: 2
x-methodName: networkTokenUpdated
security:
- BasicAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkTokenNotificationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.paymentInstrument.created:
post:
tags:
@@ -1104,7 +1153,8 @@ components:
description: 'Allocates a specific product range for either a physical or
a virtual card. Possible values: **fullySupported**, **secureCorporate**.
>Reach out to your Adyen contact to get the values relevant for your integration.'
> Reach out to your Adyen contact to get the values relevant for your
integration.'
type: string
required:
- formFactor
@@ -1369,6 +1419,21 @@ components:
- name
- address
type: object
Device:
additionalProperties: false
properties:
formFactor:
description: 'The form factor of the device used for provisioning the network
token.
Possible values: **virtual**, **physical**.'
type: string
osName:
description: The operating system of the device used for provisioning the
network token.
type: string
type: object
Expiry:
additionalProperties: false
properties:
@@ -1411,6 +1476,81 @@ components:
- firstName
- lastName
type: object
NetworkTokenNotificationDataV2:
additionalProperties: false
properties:
authentication:
description: Contains information about the authentication process triggered
during token provisioning.
$ref: '#/components/schemas/TokenAuthentication'
authenticationApplied:
description: Specifies whether the authentication process was triggered
during token provisioning.
type: boolean
balancePlatform:
description: The unique identifier of the balance platform.
type: string
decision:
description: 'The decision about the network token provisioning.
Possible values: **approved**, **declined**, **requiresAuthentication**.'
type: string
id:
description: The unique identifier of the network token.
type: string
paymentInstrumentId:
description: The unique identifier of the payment instrument to which the
network token is associated.
type: string
status:
description: The status of the network token.
type: string
tokenLastFour:
description: The last four digits of the network token. Use this value to
help your user to identify their network token.
type: string
type:
description: The type of network token.
type: string
validationFacts:
description: The rules used to validate the request for provisioning the
network token.
items:
$ref: '#/components/schemas/ValidationFacts'
type: array
wallet:
description: Contains information about the wallet for which the network
token is provisioned.
$ref: '#/components/schemas/Wallet'
type: object
NetworkTokenNotificationRequest:
additionalProperties: false
properties:
data:
description: Contains event details.
$ref: '#/components/schemas/NetworkTokenNotificationDataV2'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
timestamp:
description: When the event was queued.
format: date-time
type: string
type:
description: The type of webhook.
enum:
- balancePlatform.networkToken.created
- balancePlatform.networkToken.updated
type: string
required:
- environment
- type
- data
type: object
PaymentInstrument:
additionalProperties: false
properties:
@@ -1978,6 +2118,46 @@ components:
required:
- type
type: object
TokenAuthentication:
additionalProperties: false
properties:
method:
description: 'The method used to complete the authentication process.
Possible values: **sms_OTP**, **email_OTP**.'
type: string
result:
description: The result of the authentication process.
type: string
type: object
ValidationFacts:
additionalProperties: false
properties:
reasons:
description: 'The reason for the `result` of the validations. For example:
**walletValidation**, **paymentInstrument**.
Sent only when `result` is **invalid**.'
items:
type: string
type: array
result:
description: 'The evaluation result of the validation facts.
Possible values: **valid**, **invalid**, **notValidated**, **notApplicable**.'
enum:
- invalid
- notApplicable
- notValidated
- valid
type: string
type:
description: The type of the validation fact.
type: string
type: object
VerificationDeadline:
additionalProperties: false
properties:
@@ -2235,6 +2415,72 @@ components:
type: array
required: []
type: object
Wallet:
additionalProperties: false
properties:
accountScore:
description: 'The confidence score of the wallet account, calculated by
the wallet provider.
A high score means that account is considered trustworthy. A low score
means that the account is considered suspicious.
Possible values: **1** to **5**.'
type: string
device:
description: Contains information about the device used for provisioning
the network token.
$ref: '#/components/schemas/Device'
deviceScore:
description: 'The confidence score of the device, calculated by the wallet
provider.
A high score means that device is considered trustworthy. A low score
means that the device is considered suspicious.
Possible values: **1** to **5**.'
type: string
provisioningMethod:
description: 'The method used for provisioning the network token.
Possible values: **push**, **manual**.'
type: string
recommendationReasons:
description: A list of codes that specify the reasons for the provided scores.
items:
enum:
- accountCardTooNew
- accountHighRisk
- accountRecentlyChanged
- accountTooNew
- accountTooNewSinceLaunch
- deviceRecentlyLost
- hasSuspendedTokens
- inactiveAccount
- lowAccountScore
- lowDeviceScore
- lowPhoneNumberScore
- outSideHomeTerritory
- suspiciousActivity
- tooManyDifferentCardholders
- tooManyRecentAttempts
- tooManyRecentTokens
- unableToAssess
- unknown
type: string
type: array
type:
description: 'The type of wallet that the network token is associated with.
Possible values: **applePay**, **googlePay**, **garminPay**.'
type: string
type: object
securitySchemes:
BasicAuth:
scheme: basic

57
yaml/BalancePlatformService-v2.yaml
View File

@@ -6551,7 +6551,8 @@ components:
description: 'Allocates a specific product range for either a physical or
a virtual card. Possible values: **fullySupported**, **secureCorporate**.
>Reach out to your Adyen contact to get the values relevant for your integration.'
> Reach out to your Adyen contact to get the values relevant for your
integration.'
required:
- brand
- brandVariant
@@ -6679,7 +6680,8 @@ components:
description: 'Allocates a specific product range for either a physical or
a virtual card. Possible values: **fullySupported**, **secureCorporate**.
>Reach out to your Adyen contact to get the values relevant for your integration.'
> Reach out to your Adyen contact to get the values relevant for your
integration.'
required:
- brand
- brandVariant
@@ -9730,6 +9732,34 @@ components:
Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**,
**greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
walletProviderDeviceType:
$ref: '#/components/schemas/WalletProviderDeviceType'
description: 'Wallet Provider Device Type and the operation.
Supported operations: **anyMatch**, **noneMatch**.
Supported value inputs:
- **MOBILE_PHONE**
- **TABLET_OR_EREADER**
- **WATCH_OR_WRISTBAND**
- **WEARABLE**
- **CARD**
- **PC**
- **OTHER**
- **UNKNOWN**
'
TransactionRulesResponse:
type: object
additionalProperties: false
@@ -9752,6 +9782,7 @@ components:
- bank
- card
- grants
- interest
- internal
- issuedCard
- migration
@@ -10590,6 +10621,28 @@ components:
format: int32
required:
- operation
WalletProviderDeviceType:
type: object
additionalProperties: false
properties:
operation:
type: string
description: Defines how the condition must be evaluated.
value:
type: array
items:
type: string
enum:
- CARD
- MOBILE_PHONE
- OTHER
- PC
- TABLET_OR_EREADER
- UNKNOWN
- WATCH_OR_WRISTBAND
- WEARABLE
required:
- operation
BalanceWebhookSettingInfo:
type: object
properties: