Upvest · Schema

DirectDebitCreate

Request body for creating a direct debit.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name	Type	Description
user_id	string	The user initiating the debit.
account_group_id	string	The account group to fund.
mandate_id	string	The mandate authorizing the debit.
cash_amount	string	The debit amount.
currency	string	The currency as an ISO 4217 code.
remittance_information	string	Optional remittance information.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-schema/investment-api-direct-debit-create-schema.json",
  "title": "DirectDebitCreate",
  "description": "Request body for creating a direct debit.",
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string",
      "format": "uuid",
      "description": "The user initiating the debit.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "account_group_id": {
      "type": "string",
      "format": "uuid",
      "description": "The account group to fund.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "mandate_id": {
      "type": "string",
      "format": "uuid",
      "description": "The mandate authorizing the debit.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "cash_amount": {
      "type": "string",
      "description": "The debit amount.",
      "example": "example-value"
    },
    "currency": {
      "type": "string",
      "description": "The currency as an ISO 4217 code.",
      "pattern": "^[A-Z]{3}$",
      "example": "EUR"
    },
    "remittance_information": {
      "type": "string",
      "description": "Optional remittance information.",
      "example": "example-value"
    }
  },
  "required": [
    "user_id",
    "account_group_id",
    "mandate_id",
    "cash_amount",
    "currency"
  ]
}