Moov · Schema

CreateSweepConfigRequest

Request body for creating a sweep configuration.

BankingEmbedded FinanceFinancial InfrastructureMoney MovementPaymentsTransfers

Properties

Name Type Description
walletID string The wallet from which funds will be swept.
paymentMethodID string The bank account payment method to sweep funds to.
statementDescriptor string Descriptor that appears on bank statements for sweep transfers.
minimumBalance object
View JSON Schema on GitHub

JSON Schema

moov-createsweepconfigrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateSweepConfigRequest",
  "title": "CreateSweepConfigRequest",
  "type": "object",
  "description": "Request body for creating a sweep configuration.",
  "required": [
    "walletID",
    "paymentMethodID"
  ],
  "properties": {
    "walletID": {
      "type": "string",
      "format": "uuid",
      "description": "The wallet from which funds will be swept."
    },
    "paymentMethodID": {
      "type": "string",
      "format": "uuid",
      "description": "The bank account payment method to sweep funds to."
    },
    "statementDescriptor": {
      "type": "string",
      "description": "Descriptor that appears on bank statements for sweep transfers.",
      "maxLength": 10
    },
    "minimumBalance": {
      "$ref": "#/components/schemas/Amount"
    }
  }
}