Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Aug 23, 2023
1 parent 3f701ca commit a45470a
Show file tree
Hide file tree
Showing 4 changed files with 999 additions and 157 deletions.
332 changes: 267 additions & 65 deletions json/BalancePlatformConfigurationNotification-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -961,13 +961,6 @@
],
"type" : "string"
},
"sweepConfigurations" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/SweepConfiguration"
},
"description" : "Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds).\n\nThe key must be a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.",
"type" : "object"
},
"timeZone" : {
"description" : "The time zone of the balance account. For example, **Europe/Amsterdam**.\nDefaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
"type" : "string"
Expand Down Expand Up @@ -1071,6 +1064,75 @@
"type" : "object"
},
"CapabilityProblem" : {
"properties" : {
"entity" : {
"description" : "Contains the type of the entity and the corresponding ID.",
"$ref" : "#/components/schemas/CapabilityProblemEntity"
},
"verificationErrors" : {
"description" : "Contains information about the verification error.",
"items" : {
"$ref" : "#/components/schemas/VerificationError"
},
"type" : "array"
}
},
"type" : "object"
},
"CapabilityProblemEntity" : {
"properties" : {
"documents" : {
"description" : "List of document IDs to which the verification errors related to the capabilities correspond to.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"id" : {
"description" : "The ID of the entity.",
"type" : "string"
},
"owner" : {
"description" : "Contains details about the owner of the entity that has an error.",
"$ref" : "#/components/schemas/CapabilityProblemEntity-recursive"
},
"type" : {
"description" : "Type of entity. \n\nPossible values: **LegalEntity**, **BankAccount**, **Document**.",
"enum" : [
"BankAccount",
"Document",
"LegalEntity"
],
"type" : "string"
}
},
"type" : "object"
},
"CapabilityProblemEntity-recursive" : {
"properties" : {
"documents" : {
"description" : "List of document IDs to which the verification errors related to the capabilities correspond to.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"id" : {
"description" : "The ID of the entity.",
"type" : "string"
},
"type" : {
"description" : "Type of entity. \n\nPossible values: **LegalEntity**, **BankAccount**, **Document**.",
"enum" : [
"BankAccount",
"Document",
"LegalEntity"
],
"type" : "string"
}
},
"required" : [
],
"type" : "object"
},
"CapabilitySettings" : {
Expand Down Expand Up @@ -1655,80 +1717,35 @@
},
"type" : "object"
},
"Resource" : {
"RemediatingAction" : {
"properties" : {
"balancePlatform" : {
"description" : "The unique identifier of the balance platform.",
"code" : {
"description" : "The remediating action code.",
"type" : "string"
},
"creationDate" : {
"description" : "The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.",
"format" : "date-time",
"type" : "string"
},
"id" : {
"description" : "The ID of the resource.",
"message" : {
"description" : "A description of how you can resolve the verification error.",
"type" : "string"
}
},
"type" : "object"
},
"SweepConfiguration" : {
"Resource" : {
"properties" : {
"balanceAccountId" : {
"description" : "The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).\n\n You can only use this for periodic sweep schedules such as `schedule.type` **daily** or **monthly**.",
"type" : "string"
},
"id" : {
"description" : "The unique identifier of the sweep.",
"type" : "string"
},
"merchantAccount" : {
"description" : "The merchant account that will be the source of funds. You can only use this if you are processing payments with Adyen. This can only be used for sweeps of `type` **pull** and `schedule.type` **balance**.",
"type" : "string"
},
"schedule" : {
"description" : "The schedule when the `triggerAmount` is evaluated. If the balance meets the threshold, funds are pushed out of or pulled in to the balance account.",
"$ref" : "#/components/schemas/SweepSchedule"
},
"status" : {
"description" : "The status of the sweep. If not provided, by default, this is set to **active**.\n\nPossible values: \n\n * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. \n\n * **inactive**: the sweep is disabled and cannot be triggered. \n\n",
"enum" : [
"active",
"inactive"
],
"balancePlatform" : {
"description" : "The unique identifier of the balance platform.",
"type" : "string"
},
"sweepAmount" : {
"description" : "The amount that must be pushed out or pulled in. You can configure either `sweepAmount` or `targetAmount`, not both.",
"$ref" : "#/components/schemas/Amount"
},
"targetAmount" : {
"description" : "The amount that must be available in the balance account after the sweep. You can configure either `sweepAmount` or `targetAmount`, not both.",
"$ref" : "#/components/schemas/Amount"
},
"transferInstrumentId" : {
"description" : "The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments__resParam_id).\n\nYou can also use this in combination with a `merchantAccount` and a `type` **pull** to start a direct debit request from the source transfer instrument. To use this feature, reach out to your Adyen contact.",
"creationDate" : {
"description" : "The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.",
"format" : "date-time",
"type" : "string"
},
"triggerAmount" : {
"description" : "The threshold amount that triggers the sweep. If not provided, by default, the amount is set to zero. The `triggerAmount` is evaluated according to the specified `schedule.type`.\n\n* For `type` **pull**, if the balance is less than or equal to the `triggerAmount`, funds are pulled in to the balance account.\n\n* For `type` **push**, if the balance is more than or equal to the `triggerAmount`, funds are pushed out of the balance account.",
"$ref" : "#/components/schemas/Amount"
},
"type" : {
"default" : "push",
"description" : "The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**.\n\nPossible values:\n\n * **push**: _push out funds_ to a destination balance account or transfer instrument.\n\n * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account.",
"enum" : [
"pull",
"push"
],
"id" : {
"description" : "The ID of the resource.",
"type" : "string"
}
},
"required" : [
"id",
"schedule"
],
"type" : "object"
},
"SweepConfigurationNotificationData" : {
Expand Down Expand Up @@ -1933,6 +1950,191 @@
"routingNumber"
],
"type" : "object"
},
"VerificationError" : {
"properties" : {
"capabilities" : {
"description" : "Contains the capabilities that the verification error applies to.",
"items" : {
"enum" : [
"acceptExternalFunding",
"acceptPspFunding",
"acceptTransactionInRestrictedCountries",
"acceptTransactionInRestrictedCountriesCommercial",
"acceptTransactionInRestrictedCountriesConsumer",
"acceptTransactionInRestrictedIndustries",
"acceptTransactionInRestrictedIndustriesCommercial",
"acceptTransactionInRestrictedIndustriesConsumer",
"acquiring",
"atmWithdrawal",
"atmWithdrawalCommercial",
"atmWithdrawalConsumer",
"atmWithdrawalInRestrictedCountries",
"atmWithdrawalInRestrictedCountriesCommercial",
"atmWithdrawalInRestrictedCountriesConsumer",
"authorisedPaymentInstrumentUser",
"getGrantOffers",
"issueBankAccount",
"issueCard",
"issueCardCommercial",
"issueCardConsumer",
"localAcceptance",
"payout",
"payoutToTransferInstrument",
"processing",
"receiveFromBalanceAccount",
"receiveFromPlatformPayments",
"receiveFromThirdParty",
"receiveFromTransferInstrument",
"receiveGrants",
"receivePayments",
"sendToBalanceAccount",
"sendToThirdParty",
"sendToTransferInstrument",
"thirdPartyFunding",
"useCard",
"useCardCommercial",
"useCardConsumer",
"useCardInRestrictedCountries",
"useCardInRestrictedCountriesCommercial",
"useCardInRestrictedCountriesConsumer",
"useCardInRestrictedIndustries",
"useCardInRestrictedIndustriesCommercial",
"useCardInRestrictedIndustriesConsumer",
"withdrawFromAtm",
"withdrawFromAtmCommercial",
"withdrawFromAtmConsumer",
"withdrawFromAtmInRestrictedCountries",
"withdrawFromAtmInRestrictedCountriesCommercial",
"withdrawFromAtmInRestrictedCountriesConsumer"
],
"type" : "string"
},
"type" : "array"
},
"code" : {
"description" : "The verification error code.",
"type" : "string"
},
"message" : {
"description" : "A description of the error.",
"type" : "string"
},
"remediatingActions" : {
"description" : "Contains the actions that you can take to resolve the verification error.",
"items" : {
"$ref" : "#/components/schemas/RemediatingAction"
},
"type" : "array"
},
"subErrors" : {
"description" : "Contains more granular information about the verification error.",
"items" : {
"$ref" : "#/components/schemas/VerificationError-recursive"
},
"type" : "array"
},
"type" : {
"description" : "The type of error.\n\n Possible values: **invalidInput**, **dataMissing**.",
"enum" : [
"dataMissing",
"invalidInput",
"pendingStatus"
],
"type" : "string"
}
},
"type" : "object"
},
"VerificationError-recursive" : {
"properties" : {
"capabilities" : {
"description" : "Contains the capabilities that the verification error applies to.",
"items" : {
"enum" : [
"acceptExternalFunding",
"acceptPspFunding",
"acceptTransactionInRestrictedCountries",
"acceptTransactionInRestrictedCountriesCommercial",
"acceptTransactionInRestrictedCountriesConsumer",
"acceptTransactionInRestrictedIndustries",
"acceptTransactionInRestrictedIndustriesCommercial",
"acceptTransactionInRestrictedIndustriesConsumer",
"acquiring",
"atmWithdrawal",
"atmWithdrawalCommercial",
"atmWithdrawalConsumer",
"atmWithdrawalInRestrictedCountries",
"atmWithdrawalInRestrictedCountriesCommercial",
"atmWithdrawalInRestrictedCountriesConsumer",
"authorisedPaymentInstrumentUser",
"getGrantOffers",
"issueBankAccount",
"issueCard",
"issueCardCommercial",
"issueCardConsumer",
"localAcceptance",
"payout",
"payoutToTransferInstrument",
"processing",
"receiveFromBalanceAccount",
"receiveFromPlatformPayments",
"receiveFromThirdParty",
"receiveFromTransferInstrument",
"receiveGrants",
"receivePayments",
"sendToBalanceAccount",
"sendToThirdParty",
"sendToTransferInstrument",
"thirdPartyFunding",
"useCard",
"useCardCommercial",
"useCardConsumer",
"useCardInRestrictedCountries",
"useCardInRestrictedCountriesCommercial",
"useCardInRestrictedCountriesConsumer",
"useCardInRestrictedIndustries",
"useCardInRestrictedIndustriesCommercial",
"useCardInRestrictedIndustriesConsumer",
"withdrawFromAtm",
"withdrawFromAtmCommercial",
"withdrawFromAtmConsumer",
"withdrawFromAtmInRestrictedCountries",
"withdrawFromAtmInRestrictedCountriesCommercial",
"withdrawFromAtmInRestrictedCountriesConsumer"
],
"type" : "string"
},
"type" : "array"
},
"code" : {
"description" : "The verification error code.",
"type" : "string"
},
"message" : {
"description" : "A description of the error.",
"type" : "string"
},
"type" : {
"description" : "The type of error.\n\n Possible values: **invalidInput**, **dataMissing**.",
"enum" : [
"dataMissing",
"invalidInput",
"pendingStatus"
],
"type" : "string"
},
"remediatingActions" : {
"description" : "Contains the actions that you can take to resolve the verification error.",
"items" : {
"$ref" : "#/components/schemas/RemediatingAction"
},
"type" : "array"
}
},
"required" : [
],
"type" : "object"
}
},
"securitySchemes" : {
Expand Down
Loading

0 comments on commit a45470a

Please sign in to comment.