Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Sep 11, 2023
1 parent bfe4ca9 commit f6be6db
Show file tree
Hide file tree
Showing 2 changed files with 290 additions and 33 deletions.
132 changes: 117 additions & 15 deletions json/BalancePlatformService-v2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -926,7 +926,7 @@
}
},
"schema" : {
"$ref" : "#/components/schemas/SweepConfigurationV2"
"$ref" : "#/components/schemas/CreateSweepConfigurationV2"
}
}
}
Expand Down Expand Up @@ -5113,7 +5113,7 @@
"type" : "string"
},
"requiredAddressFields" : {
"description" : "List of address fields; i.e. Country , City , etc.",
"description" : "List of address fields.",
"items" : {
"type" : "string"
},
Expand Down Expand Up @@ -5157,16 +5157,16 @@
"additionalProperties" : false,
"properties" : {
"description" : {
"description" : "Specifies the eligible amounts of a particular route.",
"description" : "Specifies the eligible amounts for a particular route.",
"type" : "string"
},
"max" : {
"description" : "max amount in numeric characters i.e. 99999999999",
"description" : "Maximum amount.",
"format" : "int64",
"type" : "integer"
},
"min" : {
"description" : "min amount in numeric characters i.e. 1",
"description" : "Minimum amount.",
"format" : "int64",
"type" : "integer"
},
Expand Down Expand Up @@ -6270,6 +6270,108 @@
],
"type" : "object"
},
"CreateSweepConfigurationV2" : {
"properties" : {
"category" : {
"x-addedInVersion" : "2",
"description" : "The type of transfer that results from the sweep.\n\nPossible values:\n\n - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).\n\n- **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\nRequired when setting `priorities`.",
"enum" : [
"bank",
"internal",
"platformPayment"
],
"type" : "string"
},
"counterparty" : {
"description" : "The destination or the source of the funds, depending on the sweep `type`.\n\nEither a `balanceAccountId`, `transferInstrumentId`, or `merchantAccount` is required.",
"$ref" : "#/components/schemas/SweepCounterparty"
},
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**.\n\nThe sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).",
"type" : "string"
},
"description" : {
"description" : "The message that will be used in the sweep transfer's description body with a maximum length of 140 characters.\n\nIf the message is longer after replacing placeholders, the message will be cut off at 140 characters.",
"type" : "string"
},
"priorities" : {
"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 listed first, and if that's not possible, it moves on to the next option in the order of provided priorities.\n\nPossible values:\n\n* **regular**: For normal, low-value transactions.\n\n* **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.\n\n* **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: High-value transfer to a recipient in a different country.\n\n* **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN).\n\nSet `category` to **bank**. For more details, see [optional priorities setup](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).",
"items" : {
"enum" : [
"crossBorder",
"directDebit",
"fast",
"instant",
"internal",
"regular",
"wire"
],
"type" : "string"
},
"type" : "array"
},
"reason" : {
"description" : "The reason for disabling the sweep.",
"enum" : [
"amountLimitExceeded",
"approved",
"counterpartyAccountBlocked",
"counterpartyAccountClosed",
"counterpartyAccountNotFound",
"counterpartyAddressRequired",
"counterpartyBankTimedOut",
"counterpartyBankUnavailable",
"error",
"notEnoughBalance",
"refusedByCounterpartyBank",
"routeNotFound",
"unknown"
],
"readOnly" : true,
"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"
],
"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"
},
"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"
],
"type" : "string"
}
},
"required" : [
"schedule",
"currency",
"counterparty"
],
"type" : "object"
},
"DKLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
Expand Down Expand Up @@ -6340,11 +6442,11 @@
"type" : "string"
},
"line1" : {
"description" : "The street name of the house. For example, if address is 'Rokin 49', please write 'Rokin'.",
"description" : "The street name. For example, if the address is \"Rokin 49\", provide \"Rokin\".",
"type" : "string"
},
"line2" : {
"description" : "The house number or name. For example, if address is 'Rokin 49', please write '49'.",
"description" : "The house number or name. For example, if the address is \"Rokin 49\", provide \"49\".",
"type" : "string"
},
"line3" : {
Expand Down Expand Up @@ -7351,15 +7453,15 @@
"additionalProperties" : false,
"properties" : {
"description" : {
"description" : "Specifies the requirements for the Payment Instrument that needs to be included in the request for a particular route.",
"description" : "Specifies the requirements for the payment instrument that need to be included in the request for a particular route.",
"type" : "string"
},
"issuingCountryCode" : {
"description" : "The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**.",
"type" : "string"
},
"paymentInstrumentType" : {
"description" : "Type of the payment instrument i.e. BankAccount",
"description" : "The type of the payment instrument. For example, \"BankAccount\" or \"Card\".",
"enum" : [
"BankAccount",
"Card"
Expand Down Expand Up @@ -10423,7 +10525,7 @@
"description" : "Amount of transfer must be at least 100, and no greater than 99999999999",
"max" : 99999999999,
"min" : 100,
"type" : "Amount Min Max Requirement"
"type" : "amountMinMaxRequirement"
},
{
"description" : "Country, street and city is required.",
Expand All @@ -10439,12 +10541,12 @@
"iban",
"numberAndBic"
],
"type" : "Bank Account Identification Type Requirement"
"type" : "bankAccountIdentificationTypeRequirement"
},
{
"issuingCountryCode" : "NL",
"paymentInstrumentType" : "BankAccount",
"type" : "Payment Instrument Requirement"
"type" : "paymentInstrumentRequirement"
}
]
},
Expand All @@ -10457,7 +10559,7 @@
"description" : "Amount of transfer must be at least 100, and no greater than 99999999999",
"max" : 99999999999,
"min" : 100,
"type" : "Amount Min Max Requirement"
"type" : "amountMinMaxRequirement"
},
{
"description" : "Country, street and city is required.",
Expand All @@ -10473,12 +10575,12 @@
"iban",
"numberAndBic"
],
"type" : "Bank Account Identification Type Requirement"
"type" : "bankAccountIdentificationTypeRequirement"
},
{
"issuingCountryCode" : "NL",
"paymentInstrumentType" : "BankAccount",
"type" : "Payment Instrument Requirement"
"type" : "paymentInstrumentRequirement"
}
]
}
Expand Down
Loading

0 comments on commit f6be6db

Please sign in to comment.