Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Mar 4, 2024
1 parent bdd244a commit b63ee3f
Show file tree
Hide file tree
Showing 6 changed files with 5,762 additions and 108 deletions.
127 changes: 89 additions & 38 deletions json/BalancePlatformConfigurationNotification-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1442,7 +1442,7 @@
"properties" : {
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"description" : "The form factor of the account.\n\nPossible values: **physical**, **virtual**. Default value: **physical**.",
"nullable" : true,
"type" : "string"
},
Expand Down Expand Up @@ -1486,6 +1486,17 @@
},
"PaymentInstrument" : {
"properties" : {
"additionalBankAccountIdentifications" : {
"description" : "Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.",
"items" : {
"oneOf" : [
{
"$ref" : "#/components/schemas/IbanAccountIdentification"
}
]
},
"type" : "array"
},
"balanceAccountId" : {
"description" : "The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.",
"type" : "string"
Expand All @@ -1496,6 +1507,9 @@
{
"$ref" : "#/components/schemas/IbanAccountIdentification"
},
{
"$ref" : "#/components/schemas/UKLocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/USLocalAccountIdentification"
}
Expand Down Expand Up @@ -1885,6 +1899,43 @@
],
"type" : "object"
},
"UKLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 8-digit bank account number, without separators or whitespace.",
"maxLength" : 8,
"minLength" : 8,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of the account.\n\nPossible values: **physical**, **virtual**. Default value: **physical**.",
"nullable" : true,
"type" : "string"
},
"sortCode" : {
"description" : "The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace.",
"maxLength" : 6,
"minLength" : 6,
"type" : "string"
},
"type" : {
"default" : "ukLocal",
"description" : "**ukLocal**",
"enum" : [
"ukLocal"
],
"type" : "string"
}
},
"required" : [
"type",
"accountNumber",
"sortCode"
],
"type" : "object"
},
"USLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
Expand All @@ -1905,7 +1956,7 @@
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"description" : "The form factor of the account.\n\nPossible values: **physical**, **virtual**. Default value: **physical**.",
"nullable" : true,
"type" : "string"
},
Expand Down Expand Up @@ -2222,11 +2273,11 @@
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "12345",
"street" : "Teststreet 1"
"street" : "Main Street 1"
}
},
"description" : "Shelly Eller",
"legalEntityId" : "LE43319330319C8AYX89L2V59",
"legalEntityId" : "LE00000000000000000000001",
"reference" : "YOUR_REFERENCE-2412C",
"capabilities" : {
"issueCard" : {
Expand Down Expand Up @@ -2260,7 +2311,7 @@
"verificationStatus" : "pending"
}
},
"id" : "AH32272223222B5CZW6QZ2V34",
"id" : "AH00000000000000000000001",
"status" : "Active"
}
},
Expand All @@ -2275,7 +2326,7 @@
"data" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"accountHolder" : {
"legalEntityId" : "LE43319330319C8AYX89L2V59",
"legalEntityId" : "LE00000000000000000000001",
"reference" : "YOUR_REFERENCE-2412C",
"capabilities" : {
"sendToTransferInstrument" : {
Expand All @@ -2285,7 +2336,7 @@
"problems" : [
{
"entity" : {
"id" : "LE43319330319C8AYX89L2V59",
"id" : "LE00000000000000000000001",
"type" : "LegalEntity"
},
"verificationErrors" : [
Expand All @@ -2304,7 +2355,7 @@
},
{
"entity" : {
"id" : "SE576BH223222F5GJVKHH6BDT",
"id" : "SE00000000000000000000001",
"type" : "BankAccount"
},
"verificationErrors" : [
Expand All @@ -2323,7 +2374,7 @@
},
{
"entity" : {
"id" : "SE3222Z223222Q5J4D58K3DWP",
"id" : "SE00000000000000000000002",
"type" : "BankAccount"
},
"verificationErrors" : [
Expand All @@ -2342,7 +2393,7 @@
},
{
"entity" : {
"id" : "LE43319330319C8AYX89L2V59",
"id" : "LE00000000000000000000001",
"type" : "LegalEntity"
},
"verificationErrors" : [
Expand Down Expand Up @@ -2398,21 +2449,21 @@
"enabled" : true,
"requested" : true,
"allowed" : false,
"id" : "SE576BH223222F5GJVKHH6BDT",
"id" : "SE00000000000000000000001",
"verificationStatus" : "pending"
},
{
"enabled" : true,
"requested" : true,
"allowed" : false,
"id" : "SE3222Z223222Q5J4D58K3DWP",
"id" : "SE00000000000000000000002",
"verificationStatus" : "pending"
}
],
"verificationStatus" : "pending"
}
},
"id" : "AH32272223222B5CZW6QZ2V34",
"id" : "AH00000000000000000000001",
"status" : "Active"
}
},
Expand All @@ -2428,7 +2479,7 @@
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"accountHolder" : {
"description" : "Shelly Eller",
"legalEntityId" : "LE43319330319C8AYX89L2V59",
"legalEntityId" : "LE00000000000000000000001",
"reference" : "YOUR_REFERENCE-2412C",
"capabilities" : {
"sendToTransferInstrument" : {
Expand All @@ -2438,7 +2489,7 @@
"problems" : [
{
"entity" : {
"id" : "LE43319330319C8AYX89L2V59",
"id" : "LE00000000000000000000001",
"type" : "BankAccount"
},
"verificationErrors" : [
Expand All @@ -2459,7 +2510,7 @@
"verificationStatus" : "invalid"
}
},
"id" : "AH32272223222B5CZW6QZ2V34",
"id" : "AH00000000000000000000001",
"status" : "Active"
}
},
Expand All @@ -2474,7 +2525,7 @@
"data" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"accountHolder" : {
"legalEntityId" : "LE43319330319C8AYX89L2V59",
"legalEntityId" : "LE00000000000000000000001",
"reference" : "YOUR_REFERENCE-2412C",
"capabilities" : {
"sendToTransferInstrument" : {
Expand All @@ -2484,7 +2535,7 @@
"problems" : [
{
"entity" : {
"id" : "LE43319330319C8AYX89L2V59",
"id" : "LE00000000000000000000001",
"type" : "LegalEntity"
},
"verificationErrors" : [
Expand All @@ -2503,7 +2554,7 @@
},
{
"entity" : {
"id" : "SE576BH223222F5GJVKHH6BDT",
"id" : "SE00000000000000000000001",
"type" : "BankAccount"
},
"verificationErrors" : [
Expand All @@ -2522,7 +2573,7 @@
},
{
"entity" : {
"id" : "SE3222Z223222Q5J4D58K3DWP",
"id" : "SE00000000000000000000002",
"type" : "BankAccount"
},
"verificationErrors" : [
Expand All @@ -2541,7 +2592,7 @@
},
{
"entity" : {
"id" : "LE43319330319C8AYX89L2V59",
"id" : "LE00000000000000000000001",
"type" : "LegalEntity"
},
"verificationErrors" : [
Expand Down Expand Up @@ -2597,21 +2648,21 @@
"enabled" : true,
"requested" : true,
"allowed" : false,
"id" : "SE576BH223222F5GJVKHH6BDT",
"id" : "SE00000000000000000000001",
"verificationStatus" : "pending"
},
{
"enabled" : true,
"requested" : true,
"allowed" : false,
"id" : "SE3222Z223222Q5J4D58K3DWP",
"id" : "SE00000000000000000000002",
"verificationStatus" : "pending"
}
],
"verificationStatus" : "pending"
}
},
"id" : "AH32272223222B5CZW6QZ2V34",
"id" : "AH00000000000000000000001",
"status" : "Active"
}
},
Expand All @@ -2626,9 +2677,9 @@
"data" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"balanceAccount" : {
"accountHolderId" : "AH3227C223222B5CZW72CCC73",
"accountHolderId" : "AH00000000000000000001",
"defaultCurrencyCode" : "EUR",
"id" : "BA3227C223222B5CZW72VCC75",
"id" : "BA00000000000000000001",
"status" : "Active"
}
},
Expand All @@ -2643,9 +2694,9 @@
"data" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"balanceAccount" : {
"accountHolderId" : "AH3227C223222B5CZW72CCC73",
"accountHolderId" : "AH00000000000000000001",
"defaultCurrencyCode" : "EUR",
"id" : "BA3227C223222B5CZW72VCC75",
"id" : "BA00000000000000000001",
"status" : "Active",
"timeZone" : "Europe/Amsterdam"
}
Expand All @@ -2660,7 +2711,7 @@
"value" : {
"data" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"accountId" : "BA3227C223222B5FTD99V8GRS",
"accountId" : "BA00000000000000000001",
"sweep" : {
"id" : "SWPC4227C224555B5FTD2NT2JV4WN5",
"schedule" : {
Expand All @@ -2677,7 +2728,7 @@
},
"type" : "push",
"counterparty" : {
"balanceAccountId" : "BA32272223222B5FTD2KR6TJD"
"balanceAccountId" : "BA00000000000000000002"
},
"currency" : "EUR"
}
Expand All @@ -2692,7 +2743,7 @@
"value" : {
"data" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"accountId" : "BA3227C223222B5FTD99V8GRS",
"accountId" : "BA00000000000000000001",
"sweep" : {
"id" : "SWPC4227C224555B5FTD2NT2JV4WN5",
"schedule" : {
Expand All @@ -2709,7 +2760,7 @@
},
"type" : "push",
"counterparty" : {
"balanceAccountId" : "BA32272223222B5FTD2KR6TJD"
"balanceAccountId" : "BA00000000000000000002"
},
"currency" : "EUR"
}
Expand All @@ -2724,7 +2775,7 @@
"value" : {
"data" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"accountId" : "BA3227C223222B5FTD99V8GRS",
"accountId" : "BA00000000000000000001",
"sweep" : {
"id" : "SWPC4227C224555B5FTD2NT2JV4WN5",
"schedule" : {
Expand All @@ -2741,7 +2792,7 @@
},
"type" : "push",
"counterparty" : {
"balanceAccountId" : "BA32272223222B5FTD2KR6TJD"
"balanceAccountId" : "BA00000000000000000002"
},
"currency" : "EUR"
}
Expand All @@ -2757,7 +2808,7 @@
"data" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"paymentInstrument" : {
"balanceAccountId" : "BA3227C223222B5CZW72VCC75",
"balanceAccountId" : "BA00000000000000000001",
"description" : "C. Holden - card",
"issuingCountryCode" : "GB",
"status" : "Active",
Expand All @@ -2775,7 +2826,7 @@
},
"lastFour" : "2732"
},
"id" : "PI32272223222B5CZW7BQ2V3T"
"id" : "PI00000000000000000001"
}
},
"environment" : "test",
Expand All @@ -2789,7 +2840,7 @@
"data" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"paymentInstrument" : {
"balanceAccountId" : "BA3227C223222B5CZW72VCC75",
"balanceAccountId" : "BA00000000000000000001",
"description" : "C. Holden - card",
"issuingCountryCode" : "GB",
"status" : "Suspended",
Expand All @@ -2807,7 +2858,7 @@
},
"lastFour" : "2732"
},
"id" : "PI32272223222B5CZW7BQ2V3T"
"id" : "PI00000000000000000001"
}
},
"environment" : "test",
Expand Down
Loading

0 comments on commit b63ee3f

Please sign in to comment.