mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
spec release
This commit is contained in:
Adyen Automation
@@ -743,7 +743,8 @@ components:
|
||||
type: array
|
||||
defaultCurrencyCode:
|
||||
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
|
||||
of the balance account.
|
||||
of the balance account. This is the currency displayed on the Balance
|
||||
Account overview page in your Customer Area.
|
||||
|
||||
The default value is **EUR**.
|
||||
|
||||
@@ -1395,6 +1396,14 @@ components:
|
||||
description: Your reference for the payment instrument, maximum 150 characters.
|
||||
maxLength: 150
|
||||
type: string
|
||||
replacedById:
|
||||
description: The unique identifier of the payment instrument that replaced
|
||||
this payment instrument.
|
||||
type: string
|
||||
replacementOfId:
|
||||
description: The unique identifier of the payment instrument that is replaced
|
||||
by this payment instrument.
|
||||
type: string
|
||||
status:
|
||||
description: "The status of the payment instrument. If a status is not specified\
|
||||
\ when creating a payment instrument, it is set to **Active** by default.\
|
||||
|
||||
@@ -754,7 +754,8 @@ components:
|
||||
type: array
|
||||
defaultCurrencyCode:
|
||||
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
|
||||
of the balance account.
|
||||
of the balance account. This is the currency displayed on the Balance
|
||||
Account overview page in your Customer Area.
|
||||
|
||||
The default value is **EUR**.
|
||||
|
||||
@@ -1455,6 +1456,14 @@ components:
|
||||
description: Your reference for the payment instrument, maximum 150 characters.
|
||||
maxLength: 150
|
||||
type: string
|
||||
replacedById:
|
||||
description: The unique identifier of the payment instrument that replaced
|
||||
this payment instrument.
|
||||
type: string
|
||||
replacementOfId:
|
||||
description: The unique identifier of the payment instrument that is replaced
|
||||
by this payment instrument.
|
||||
type: string
|
||||
status:
|
||||
description: "The status of the payment instrument. If a status is not specified\
|
||||
\ when creating a payment instrument, it is set to **active** by default.\
|
||||
@@ -1743,9 +1752,16 @@ components:
|
||||
x-addedInVersion: '2'
|
||||
description: 'The list of priorities for the bank transfer. This sets the
|
||||
speed at which the transfer is sent and the fees that you have to pay.
|
||||
You can provide multiple priorities. Adyen will try to pay out using the
|
||||
priority you list first. If that''s not possible, it moves on to the next
|
||||
option in the order of your provided priorities.
|
||||
You can provide multiple priorities, ordered by your preference. Adyen
|
||||
will try to pay out using the priorities in the given order. If the first
|
||||
priority is not currently supported or enabled for your platform, the
|
||||
system will try the next one, and so on.
|
||||
|
||||
|
||||
The request will be accepted as long as **at least one** of the provided
|
||||
priorities is valid (i.e., supported by Adyen and activated for your platform).
|
||||
For example, if you provide `["wire","regular"]`, and `wire` is not supported
|
||||
but `regular` is, the request will still be accepted and processed.
|
||||
|
||||
|
||||
Possible values:
|
||||
|
||||
@@ -4432,8 +4432,9 @@ paths:
|
||||
get:
|
||||
tags:
|
||||
- Balances
|
||||
summary: Get webhook settings
|
||||
description: Returns all settings configured for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).
|
||||
summary: Get all balance webhook settings
|
||||
description: Returns all balance webhook settings configured for triggering
|
||||
[balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
|
||||
operationId: get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings
|
||||
parameters:
|
||||
- name: balancePlatformId
|
||||
@@ -4458,36 +4459,35 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/WebhookSettingResponse'
|
||||
$ref: '#/components/schemas/WebhookSettings'
|
||||
examples:
|
||||
get-webhook-settings-200:
|
||||
summary: Get all webhook settings
|
||||
description: Retrieve all settings of a webhook
|
||||
value:
|
||||
- id: BWHS00000000000000000000000001
|
||||
type: balance
|
||||
target:
|
||||
type: balancePlatform
|
||||
id: YOUR_BALANCE_PLATFORM
|
||||
currency: USD
|
||||
status: active
|
||||
conditions:
|
||||
- balanceType: available
|
||||
conditionType: lessThan
|
||||
value: 500000
|
||||
- id: BWHS00000000000000000000000002
|
||||
type: balance
|
||||
target:
|
||||
type: balanceAccount
|
||||
id: BA00000000000000000LIABLE
|
||||
currency: USD
|
||||
status: active
|
||||
conditions:
|
||||
- balanceType: available
|
||||
conditionType: greaterThan
|
||||
value: 1000000
|
||||
WebhookSettings:
|
||||
- id: BWHS00000000000000000000000001
|
||||
type: balance
|
||||
target:
|
||||
type: balancePlatform
|
||||
id: YOUR_BALANCE_PLATFORM
|
||||
currency: USD
|
||||
status: active
|
||||
conditions:
|
||||
- balanceType: available
|
||||
conditionType: lessThan
|
||||
value: 500000
|
||||
- id: BWHS00000000000000000000000002
|
||||
type: balance
|
||||
target:
|
||||
type: balanceAccount
|
||||
id: BA00000000000000000LIABLE
|
||||
currency: USD
|
||||
status: active
|
||||
conditions:
|
||||
- balanceType: available
|
||||
conditionType: greaterThan
|
||||
value: 1000000
|
||||
'400':
|
||||
description: Bad Request - a problem reading or understanding the request.
|
||||
content:
|
||||
@@ -4524,6 +4524,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
x-methodName: getAllWebhookSettings
|
||||
x-sortIndex: 4
|
||||
post:
|
||||
tags:
|
||||
@@ -4571,7 +4572,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/BalanceWebhookSettingsRequest'
|
||||
$ref: '#/components/schemas/BalanceWebhookSettingInfo'
|
||||
examples:
|
||||
create-webhook-setting:
|
||||
summary: Create a webhook setting
|
||||
@@ -4594,7 +4595,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/WebhookSettingResponse'
|
||||
$ref: '#/components/schemas/WebhookSetting'
|
||||
examples:
|
||||
create-webhook-setting:
|
||||
summary: Successfully created a webhook setting
|
||||
@@ -4647,14 +4648,15 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
x-methodName: createWebhookSetting
|
||||
x-sortIndex: 1
|
||||
/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}:
|
||||
get:
|
||||
tags:
|
||||
- Balances
|
||||
summary: Get a webhook setting
|
||||
summary: Get a balance webhook setting by id
|
||||
description: Returns the details of a specific balance webhook setting configured
|
||||
for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).
|
||||
for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
|
||||
operationId: get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId
|
||||
parameters:
|
||||
- name: balancePlatformId
|
||||
@@ -4687,7 +4689,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/WebhookSettingResponse'
|
||||
$ref: '#/components/schemas/WebhookSetting'
|
||||
examples:
|
||||
get-webhook-setting-by-id-200:
|
||||
summary: Get a webhook setting
|
||||
@@ -4740,13 +4742,14 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
x-methodName: getWebhookSetting
|
||||
x-sortIndex: 3
|
||||
delete:
|
||||
tags:
|
||||
- Balances
|
||||
summary: Delete a webhook setting
|
||||
description: Deletes a setting that contains the conditions for triggering [balance
|
||||
webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).
|
||||
summary: Delete a balance webhook setting by id
|
||||
description: Deletes a balance webhook setting that contains the conditions
|
||||
for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
|
||||
operationId: delete-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId
|
||||
parameters:
|
||||
- name: balancePlatformId
|
||||
@@ -4774,8 +4777,9 @@ paths:
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: OK - the request has succeeded.
|
||||
'204':
|
||||
description: No Content - the request has been successfully processed, but
|
||||
there is no additional content.
|
||||
content:
|
||||
application/json: {}
|
||||
'400':
|
||||
@@ -4814,13 +4818,14 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
x-methodName: deleteWebhookSetting
|
||||
x-sortIndex: 5
|
||||
patch:
|
||||
tags:
|
||||
- Balances
|
||||
summary: Update a webhook setting
|
||||
summary: Update a balance webhook setting by id
|
||||
description: Updates the conditions the balance change needs to meet for Adyen
|
||||
to send a [balance webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).
|
||||
to send a [balance webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
|
||||
operationId: patch-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId
|
||||
parameters:
|
||||
- name: balancePlatformId
|
||||
@@ -4851,7 +4856,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PatchableBalanceWebhookSettingsRequest'
|
||||
$ref: '#/components/schemas/BalanceWebhookSettingInfoUpdate'
|
||||
examples:
|
||||
update-webhook-setting:
|
||||
summary: Update a webhook setting
|
||||
@@ -4883,7 +4888,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/WebhookSettingResponse'
|
||||
$ref: '#/components/schemas/WebhookSetting'
|
||||
examples:
|
||||
update-webhook-setting:
|
||||
summary: Successfully updated a webhook setting
|
||||
@@ -4957,6 +4962,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
x-methodName: updateWebhookSetting
|
||||
x-sortIndex: 2
|
||||
components:
|
||||
schemas:
|
||||
@@ -5753,7 +5759,8 @@ components:
|
||||
defaultCurrencyCode:
|
||||
type: string
|
||||
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
|
||||
of the balance account.
|
||||
of the balance account. This is the currency displayed on the Balance
|
||||
Account overview page in your Customer Area.
|
||||
|
||||
The default value is **EUR**.
|
||||
|
||||
@@ -5820,7 +5827,8 @@ components:
|
||||
defaultCurrencyCode:
|
||||
type: string
|
||||
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
|
||||
of the balance account.
|
||||
of the balance account. This is the currency displayed on the Balance
|
||||
Account overview page in your Customer Area.
|
||||
|
||||
The default value is **EUR**.
|
||||
|
||||
@@ -5887,7 +5895,8 @@ components:
|
||||
defaultCurrencyCode:
|
||||
type: string
|
||||
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
|
||||
of the balance account.
|
||||
of the balance account. This is the currency displayed on the Balance
|
||||
Account overview page in your Customer Area.
|
||||
|
||||
The default value is **EUR**.
|
||||
|
||||
@@ -6898,9 +6907,16 @@ components:
|
||||
type: array
|
||||
description: 'The list of priorities for the bank transfer. This sets the
|
||||
speed at which the transfer is sent and the fees that you have to pay.
|
||||
You can provide multiple priorities. Adyen will try to pay out using the
|
||||
priority you list first. If that''s not possible, it moves on to the next
|
||||
option in the order of your provided priorities.
|
||||
You can provide multiple priorities, ordered by your preference. Adyen
|
||||
will try to pay out using the priorities in the given order. If the first
|
||||
priority is not currently supported or enabled for your platform, the
|
||||
system will try the next one, and so on.
|
||||
|
||||
|
||||
The request will be accepted as long as **at least one** of the provided
|
||||
priorities is valid (i.e., supported by Adyen and activated for your platform).
|
||||
For example, if you provide `["wire","regular"]`, and `wire` is not supported
|
||||
but `regular` is, the request will still be accepted and processed.
|
||||
|
||||
|
||||
Possible values:
|
||||
@@ -7954,6 +7970,14 @@ components:
|
||||
type: string
|
||||
description: Your reference for the payment instrument, maximum 150 characters.
|
||||
maxLength: 150
|
||||
replacedById:
|
||||
type: string
|
||||
description: The unique identifier of the payment instrument that replaced
|
||||
this payment instrument.
|
||||
replacementOfId:
|
||||
type: string
|
||||
description: The unique identifier of the payment instrument that is replaced
|
||||
by this payment instrument.
|
||||
status:
|
||||
type: string
|
||||
description: "The status of the payment instrument. If a status is not specified\
|
||||
@@ -8821,9 +8845,16 @@ components:
|
||||
type: array
|
||||
description: 'The list of priorities for the bank transfer. This sets the
|
||||
speed at which the transfer is sent and the fees that you have to pay.
|
||||
You can provide multiple priorities. Adyen will try to pay out using the
|
||||
priority you list first. If that''s not possible, it moves on to the next
|
||||
option in the order of your provided priorities.
|
||||
You can provide multiple priorities, ordered by your preference. Adyen
|
||||
will try to pay out using the priorities in the given order. If the first
|
||||
priority is not currently supported or enabled for your platform, the
|
||||
system will try the next one, and so on.
|
||||
|
||||
|
||||
The request will be accepted as long as **at least one** of the provided
|
||||
priorities is valid (i.e., supported by Adyen and activated for your platform).
|
||||
For example, if you provide `["wire","regular"]`, and `wire` is not supported
|
||||
but `regular` is, the request will still be accepted and processed.
|
||||
|
||||
|
||||
Possible values:
|
||||
@@ -9683,6 +9714,20 @@ components:
|
||||
description: 'The total amount and the operation.
|
||||
|
||||
|
||||
Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**,
|
||||
**greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
|
||||
walletProviderAccountScore:
|
||||
$ref: '#/components/schemas/WalletProviderAccountScoreRestriction'
|
||||
description: 'Checks the wallet account score.
|
||||
|
||||
|
||||
Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**,
|
||||
**greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
|
||||
walletProviderDeviceScore:
|
||||
$ref: '#/components/schemas/WalletProviderDeviceScore'
|
||||
description: 'Wallet Provider Device Score and the operation.
|
||||
|
||||
|
||||
Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**,
|
||||
**greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
|
||||
TransactionRulesResponse:
|
||||
@@ -10007,6 +10052,14 @@ components:
|
||||
type: string
|
||||
description: Your reference for the payment instrument, maximum 150 characters.
|
||||
maxLength: 150
|
||||
replacedById:
|
||||
type: string
|
||||
description: The unique identifier of the payment instrument that replaced
|
||||
this payment instrument.
|
||||
replacementOfId:
|
||||
type: string
|
||||
description: The unique identifier of the payment instrument that is replaced
|
||||
by this payment instrument.
|
||||
status:
|
||||
type: string
|
||||
description: "The status of the payment instrument. If a status is not specified\
|
||||
@@ -10113,9 +10166,16 @@ components:
|
||||
type: array
|
||||
description: 'The list of priorities for the bank transfer. This sets the
|
||||
speed at which the transfer is sent and the fees that you have to pay.
|
||||
You can provide multiple priorities. Adyen will try to pay out using the
|
||||
priority you list first. If that''s not possible, it moves on to the next
|
||||
option in the order of your provided priorities.
|
||||
You can provide multiple priorities, ordered by your preference. Adyen
|
||||
will try to pay out using the priorities in the given order. If the first
|
||||
priority is not currently supported or enabled for your platform, the
|
||||
system will try the next one, and so on.
|
||||
|
||||
|
||||
The request will be accepted as long as **at least one** of the provided
|
||||
priorities is valid (i.e., supported by Adyen and activated for your platform).
|
||||
For example, if you provide `["wire","regular"]`, and `wire` is not supported
|
||||
but `regular` is, the request will still be accepted and processed.
|
||||
|
||||
|
||||
Possible values:
|
||||
@@ -10506,7 +10566,31 @@ components:
|
||||
error.
|
||||
items:
|
||||
$ref: '#/components/schemas/RemediatingAction'
|
||||
BalanceWebhookSettingsRequest:
|
||||
WalletProviderAccountScoreRestriction:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
properties:
|
||||
operation:
|
||||
type: string
|
||||
description: Defines how the condition must be evaluated.
|
||||
value:
|
||||
type: integer
|
||||
format: int32
|
||||
required:
|
||||
- operation
|
||||
WalletProviderDeviceScore:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
properties:
|
||||
operation:
|
||||
type: string
|
||||
description: Defines how the condition must be evaluated.
|
||||
value:
|
||||
type: integer
|
||||
format: int32
|
||||
required:
|
||||
- operation
|
||||
BalanceWebhookSettingInfo:
|
||||
type: object
|
||||
properties:
|
||||
conditions:
|
||||
@@ -10648,16 +10732,16 @@ components:
|
||||
required:
|
||||
- id
|
||||
- type
|
||||
BalanceWebhookSettingsResponse:
|
||||
BalanceWebhookSetting:
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/WebhookSettingResponse'
|
||||
- $ref: '#/components/schemas/WebhookSetting'
|
||||
- type: object
|
||||
properties:
|
||||
conditions:
|
||||
type: array
|
||||
description: The list of settings and criteria for triggering the [balance
|
||||
webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).
|
||||
webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
|
||||
items:
|
||||
$ref: '#/components/schemas/Condition'
|
||||
required:
|
||||
@@ -10670,12 +10754,12 @@ components:
|
||||
type: string
|
||||
enum:
|
||||
- balance
|
||||
WebhookSettingResponse:
|
||||
WebhookSetting:
|
||||
type: object
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
balance: '#/components/schemas/BalanceWebhookSettingsResponse'
|
||||
balance: '#/components/schemas/BalanceWebhookSetting'
|
||||
properties:
|
||||
currency:
|
||||
type: string
|
||||
@@ -10742,7 +10826,15 @@ components:
|
||||
type: string
|
||||
description: A URI that identifies the validation error type. It points
|
||||
to human-readable documentation for the problem type.
|
||||
PatchableBalanceWebhookSettingsRequest:
|
||||
WebhookSettings:
|
||||
type: object
|
||||
properties:
|
||||
webhookSettings:
|
||||
type: array
|
||||
description: The list of webhook settings.
|
||||
items:
|
||||
$ref: '#/components/schemas/WebhookSetting'
|
||||
BalanceWebhookSettingInfoUpdate:
|
||||
type: object
|
||||
properties:
|
||||
conditions:
|
||||
@@ -10936,7 +11028,7 @@ components:
|
||||
description: Example response when retrieving an account holder
|
||||
value:
|
||||
balancePlatform: YOUR_BALANCE_PLATFORM
|
||||
description: Liable account holder used for international payments and payouts
|
||||
description: Account holder used for international payments and payouts
|
||||
legalEntityId: LE322JV223222D5GG42KN6869
|
||||
reference: S.Eller-001
|
||||
capabilities:
|
||||
@@ -11294,7 +11386,7 @@ components:
|
||||
description: Example request for the `receivePayments` capability for an account
|
||||
holder
|
||||
value:
|
||||
description: Liable account holder used for international payments and payouts
|
||||
description: Account holder used for international payments and payouts
|
||||
reference: S.Eller-001
|
||||
capabilities:
|
||||
receivePayments:
|
||||
@@ -11305,7 +11397,7 @@ components:
|
||||
for an account holder
|
||||
value:
|
||||
balancePlatform: YOUR_BALANCE_PLATFORM
|
||||
description: Liable account holder used for international payments and payouts
|
||||
description: Account holder used for international payments and payouts
|
||||
legalEntityId: LE322JV223222F5GKQZZ9DS99
|
||||
reference: S.Eller-001
|
||||
capabilities:
|
||||
@@ -11326,7 +11418,7 @@ components:
|
||||
description: Example response for permanently deactivating an account holder
|
||||
value:
|
||||
balancePlatform: YOUR_BALANCE_PLATFORM
|
||||
description: Liable account holder used for international payments and payouts
|
||||
description: Account holder used for international payments and payouts
|
||||
legalEntityId: LE322JV223222F5GKQZZ9DS99
|
||||
reference: S.Eller-001
|
||||
id: AH3227C223222C5GKR23686TF
|
||||
@@ -11474,7 +11566,7 @@ components:
|
||||
summary: Create an account holder
|
||||
description: Example request for creating an account holder
|
||||
value:
|
||||
description: Liable account holder used for international payments and payouts
|
||||
description: Account holder used for international payments and payouts
|
||||
reference: S.Eller-001
|
||||
legalEntityId: LE322JV223222D5GG42KN6869
|
||||
post-accountHolders-createAccountHolder-200:
|
||||
@@ -11482,7 +11574,7 @@ components:
|
||||
description: Example response for creating an account holder
|
||||
value:
|
||||
balancePlatform: YOUR_BALANCE_PLATFORM
|
||||
description: Liable account holder used for international payments and payouts
|
||||
description: Account holder used for international payments and payouts
|
||||
legalEntityId: LE322JV223222D5GG42KN6869
|
||||
reference: S.Eller-001
|
||||
capabilities:
|
||||
|
||||
Reference in New Issue
Block a user