Moov · Schema

UpdateSweepConfigRequest

Request body for updating a sweep configuration.

BankingEmbedded FinanceFinancial InfrastructureMoney MovementPaymentsTransfers

Properties

Name Type Description
status string Enable or disable the sweep configuration.
statementDescriptor string Updated statement descriptor for sweep transfers.
minimumBalance object
View JSON Schema on GitHub

JSON Schema

moov-updatesweepconfigrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateSweepConfigRequest",
  "title": "UpdateSweepConfigRequest",
  "type": "object",
  "description": "Request body for updating a sweep configuration.",
  "properties": {
    "status": {
      "type": "string",
      "description": "Enable or disable the sweep configuration.",
      "enum": [
        "enabled",
        "disabled"
      ]
    },
    "statementDescriptor": {
      "type": "string",
      "description": "Updated statement descriptor for sweep transfers.",
      "maxLength": 10
    },
    "minimumBalance": {
      "$ref": "#/components/schemas/Amount"
    }
  }
}