spec release

This commit is contained in:
Adyen Automation
2025-02-11 16:44:11 +01:00
parent 8dff45790a
commit 2090d68da3
8 changed files with 64 additions and 47 deletions

View File

@@ -4126,7 +4126,7 @@
"type" : "string"
},
"nominee" : {
"description" : "Default value: **false**Indicates if the `type` **director**, **secondaryPartner** or **shareholder** is a nominee. Only applicable to New Zealand.",
"description" : "Default value: **false**\nIndicates if the entity association `type` **director**, **secondaryPartner** or **shareholder** is also a nominee. Only applicable to New Zealand.",
"type" : "boolean"
},
"relationship" : {
@@ -4755,7 +4755,7 @@
"additionalProperties" : false,
"properties" : {
"acquiringBusinessLineId" : {
"description" : "The unique identifier of the business line that will be the source of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments** capability.",
"description" : "The unique identifier of the business line that is the source of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments** capability.",
"type" : "string"
},
"adyenProcessedFunds" : {

View File

@@ -4567,7 +4567,7 @@
"type" : "string"
},
"nominee" : {
"description" : "Default value: **false**Indicates if the `type` **director**, **secondaryPartner** or **shareholder** is a nominee. Only applicable to New Zealand.",
"description" : "Default value: **false**\nIndicates if the entity association `type` **director**, **secondaryPartner** or **shareholder** is also a nominee. Only applicable to New Zealand.",
"type" : "boolean"
},
"relationship" : {
@@ -5314,7 +5314,7 @@
"additionalProperties" : false,
"properties" : {
"acquiringBusinessLineId" : {
"description" : "The unique identifier of the business line that will be the source of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments** capability.",
"description" : "The unique identifier of the business line that is the source of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments** capability.",
"type" : "string"
},
"adyenProcessedFunds" : {

View File

@@ -5116,7 +5116,7 @@
"type" : "string"
},
"nominee" : {
"description" : "Default value: **false**Indicates if the `type` **director**, **secondaryPartner** or **shareholder** is a nominee. Only applicable to New Zealand.",
"description" : "Default value: **false**\nIndicates if the entity association `type` **director**, **secondaryPartner** or **shareholder** is also a nominee. Only applicable to New Zealand.",
"type" : "boolean"
},
"relationship" : {
@@ -6043,7 +6043,7 @@
"deprecated" : true,
"x-deprecatedInVersion" : "3",
"x-deprecatedMessage" : "This field will be removed in v4.",
"description" : "The unique identifier of the business line that will be the source of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments** capability.",
"description" : "The unique identifier of the business line that is the source of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments** capability.",
"type" : "string"
},
"adyenProcessedFunds" : {

View File

@@ -5128,7 +5128,7 @@
"type" : "string"
},
"nominee" : {
"description" : "Default value: **false**Indicates if the `type` **director**, **secondaryPartner** or **shareholder** is a nominee. Only applicable to New Zealand.",
"description" : "Default value: **false**\nIndicates if the entity association `type` **director**, **secondaryPartner** or **shareholder** is also a nominee. Only applicable to New Zealand.",
"type" : "boolean"
},
"relationship" : {
@@ -5669,7 +5669,7 @@
},
"doingBusinessAsAbsent" : {
"x-addedInVersion" : "4",
"description" : "`Doing business as` is absent.",
"description" : "Set this to **true** if the organization or legal arrangement does not have a `Doing business as` name.",
"nullable" : true,
"type" : "boolean"
},
@@ -6017,7 +6017,7 @@
},
"doingBusinessAsAbsent" : {
"x-addedInVersion" : "4",
"description" : "`Doing business as` is absent.",
"description" : "Set this to **true** if the legal arrangement does not have a `Doing business as` name.",
"nullable" : true,
"type" : "boolean"
},
@@ -6083,7 +6083,7 @@
"additionalProperties" : false,
"properties" : {
"adyenProcessedFunds" : {
"description" : "Indicates whether the funds are coming from transactions processed by Adyen. If **false**, `type` is required.",
"description" : "Indicates whether the funds are coming from transactions processed by Adyen. If **false**, the `type` is required.",
"type" : "boolean"
},
"amount" : {
@@ -6109,12 +6109,12 @@
},
"dateOfFundsReceived" : {
"x-addedInVersion" : "4",
"description" : "The date the funds were received, in YYYY-MM-DD format. Required if `type` is **donations** or **inheritance**.",
"description" : "The date the funds were received, in YYYY-MM-DD format. Required if the `type` is **donations** or **inheritance**.",
"$ref" : "#/components/schemas/LocalDate"
},
"dateOfSourceEvent" : {
"x-addedInVersion" : "4",
"description" : "The date when the source of funds became available, in YYYY-MM-DD format. Required if `type` is **assetSale** or **gamblingWinnings**.\n\nFor example, if the source of funds is of type **assetSale**, the dateOfSourceEvent is the date of the sale. If the source of funds is of type **gamblingWinnings**, the dateOfSourceEvent is the date of winnings.",
"description" : "The date when the source of funds became available, in YYYY-MM-DD format. Required if `type` is **assetSale** or **gamblingWinnings**.\n\nFor example, if the source of funds is **assetSale**, the `dateOfSourceEvent` is the date of the sale. If the source of funds is **gamblingWinnings**, the `dateOfSourceEvent` is the date of winnings.",
"$ref" : "#/components/schemas/LocalDate"
},
"description" : {
@@ -6158,7 +6158,7 @@
},
"purpose" : {
"x-addedInVersion" : "4",
"description" : "The reasoning behind receiving the funds. Required if `type` is **donations**.",
"description" : "The reason for receiving the funds. Required if `type` is **donations**.",
"type" : "string"
},
"relationship" : {
@@ -6271,6 +6271,11 @@
"description" : "The tax ID number (TIN) of the organization or individual.",
"type" : "string"
},
"numberAbsent" : {
"x-addedInVersion" : "4",
"description" : "The tax ID number (TIN) of the organization or individual is absent.",
"type" : "boolean"
},
"type" : {
"description" : "The TIN type depending on the country where it was issued. Only provide if the country has multiple tax IDs: Singapore, Sweden, the UK, or the US. For example, provide **SSN**, **EIN**, or **ITIN** for the US.",
"type" : "string"
@@ -6493,7 +6498,7 @@
},
"doingBusinessAsAbsent" : {
"x-addedInVersion" : "4",
"description" : "`Doing business as` is absent.",
"description" : "Set this to **true** if the legal arrangement does not have a `Doing business as` name.",
"nullable" : true,
"type" : "boolean"
},
@@ -6684,7 +6689,7 @@
},
"doingBusinessAsAbsent" : {
"x-addedInVersion" : "4",
"description" : "`Doing business as` is absent.",
"description" : "Set this to **true** if the legal arrangement does not have a `Doing business as` name.",
"nullable" : true,
"type" : "boolean"
},

View File

@@ -2942,9 +2942,10 @@ components:
readOnly: true
type: string
nominee:
description: 'Default value: **false**Indicates if the `type` **director**,
**secondaryPartner** or **shareholder** is a nominee. Only applicable
to New Zealand.'
description: 'Default value: **false**
Indicates if the entity association `type` **director**, **secondaryPartner**
or **shareholder** is also a nominee. Only applicable to New Zealand.'
type: boolean
relationship:
description: 'The individual''s relationship to a legal representative if
@@ -3609,9 +3610,9 @@ components:
additionalProperties: false
properties:
acquiringBusinessLineId:
description: The unique identifier of the business line that will be the
source of funds.This must be a business line for a **receivePayments**
or **receiveFromPlatformPayments** capability.
description: The unique identifier of the business line that is the source
of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments**
capability.
type: string
adyenProcessedFunds:
description: Indicates whether the funds are coming from transactions processed

View File

@@ -3273,9 +3273,10 @@ components:
readOnly: true
type: string
nominee:
description: 'Default value: **false**Indicates if the `type` **director**,
**secondaryPartner** or **shareholder** is a nominee. Only applicable
to New Zealand.'
description: 'Default value: **false**
Indicates if the entity association `type` **director**, **secondaryPartner**
or **shareholder** is also a nominee. Only applicable to New Zealand.'
type: boolean
relationship:
description: 'The individual''s relationship to a legal representative if
@@ -4051,9 +4052,9 @@ components:
additionalProperties: false
properties:
acquiringBusinessLineId:
description: The unique identifier of the business line that will be the
source of funds.This must be a business line for a **receivePayments**
or **receiveFromPlatformPayments** capability.
description: The unique identifier of the business line that is the source
of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments**
capability.
type: string
adyenProcessedFunds:
description: Indicates whether the funds are coming from transactions processed

View File

@@ -3683,9 +3683,10 @@ components:
readOnly: true
type: string
nominee:
description: 'Default value: **false**Indicates if the `type` **director**,
**secondaryPartner** or **shareholder** is a nominee. Only applicable
to New Zealand.'
description: 'Default value: **false**
Indicates if the entity association `type` **director**, **secondaryPartner**
or **shareholder** is also a nominee. Only applicable to New Zealand.'
type: boolean
relationship:
description: 'The individual''s relationship to a legal representative if
@@ -4606,9 +4607,9 @@ components:
deprecated: true
x-deprecatedInVersion: '3'
x-deprecatedMessage: This field will be removed in v4.
description: The unique identifier of the business line that will be the
source of funds.This must be a business line for a **receivePayments**
or **receiveFromPlatformPayments** capability.
description: The unique identifier of the business line that is the source
of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments**
capability.
type: string
adyenProcessedFunds:
description: Indicates whether the funds are coming from transactions processed

View File

@@ -3687,9 +3687,10 @@ components:
readOnly: true
type: string
nominee:
description: 'Default value: **false**Indicates if the `type` **director**,
**secondaryPartner** or **shareholder** is a nominee. Only applicable
to New Zealand.'
description: 'Default value: **false**
Indicates if the entity association `type` **director**, **secondaryPartner**
or **shareholder** is also a nominee. Only applicable to New Zealand.'
type: boolean
relationship:
description: 'The individual''s relationship to a legal representative if
@@ -4280,7 +4281,8 @@ components:
type: string
doingBusinessAsAbsent:
x-addedInVersion: '4'
description: '`Doing business as` is absent.'
description: Set this to **true** if the organization or legal arrangement
does not have a `Doing business as` name.
nullable: true
type: boolean
email:
@@ -4576,7 +4578,8 @@ components:
type: string
doingBusinessAsAbsent:
x-addedInVersion: '4'
description: '`Doing business as` is absent.'
description: Set this to **true** if the legal arrangement does not have
a `Doing business as` name.
nullable: true
type: boolean
financialReports:
@@ -4632,7 +4635,7 @@ components:
properties:
adyenProcessedFunds:
description: Indicates whether the funds are coming from transactions processed
by Adyen. If **false**, `type` is required.
by Adyen. If **false**, the `type` is required.
type: boolean
amount:
x-addedInVersion: '4'
@@ -4663,7 +4666,7 @@ components:
dateOfFundsReceived:
x-addedInVersion: '4'
description: The date the funds were received, in YYYY-MM-DD format. Required
if `type` is **donations** or **inheritance**.
if the `type` is **donations** or **inheritance**.
$ref: '#/components/schemas/LocalDate'
dateOfSourceEvent:
x-addedInVersion: '4'
@@ -4671,9 +4674,9 @@ components:
format. Required if `type` is **assetSale** or **gamblingWinnings**.
For example, if the source of funds is of type **assetSale**, the dateOfSourceEvent
is the date of the sale. If the source of funds is of type **gamblingWinnings**,
the dateOfSourceEvent is the date of winnings.'
For example, if the source of funds is **assetSale**, the `dateOfSourceEvent`
is the date of the sale. If the source of funds is **gamblingWinnings**,
the `dateOfSourceEvent` is the date of winnings.'
$ref: '#/components/schemas/LocalDate'
description:
description: 'Text describing the source of funds. Required if `type` is
@@ -4727,8 +4730,7 @@ components:
type: string
purpose:
x-addedInVersion: '4'
description: The reasoning behind receiving the funds. Required if `type`
is **donations**.
description: The reason for receiving the funds. Required if `type` is **donations**.
type: string
relationship:
x-addedInVersion: '4'
@@ -4892,6 +4894,11 @@ components:
number:
description: The tax ID number (TIN) of the organization or individual.
type: string
numberAbsent:
x-addedInVersion: '4'
description: The tax ID number (TIN) of the organization or individual is
absent.
type: boolean
type:
description: 'The TIN type depending on the country where it was issued.
Only provide if the country has multiple tax IDs: Singapore, Sweden, the
@@ -5122,7 +5129,8 @@ components:
type: string
doingBusinessAsAbsent:
x-addedInVersion: '4'
description: '`Doing business as` is absent.'
description: Set this to **true** if the legal arrangement does not have
a `Doing business as` name.
nullable: true
type: boolean
name:
@@ -5288,7 +5296,8 @@ components:
type: string
doingBusinessAsAbsent:
x-addedInVersion: '4'
description: '`Doing business as` is absent.'
description: Set this to **true** if the legal arrangement does not have
a `Doing business as` name.
nullable: true
type: boolean
name: