Upvest · Schema

DirectDebit

A direct debit funding request.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name	Type	Description
id	string	The direct debit identifier.
user_id	string	The user initiating the direct debit.
account_group_id	string	The account group to fund.
mandate_id	string	The mandate authorizing the debit.
cash_amount	string	The debit amount as a decimal string.
currency	string	The currency of the debit.
remittance_information	string	Optional remittance information for the debit.
status	string	The status of the direct debit.
created_at	string	When the direct debit was created.

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-schema.json",
  "title": "DirectDebit",
  "description": "A direct debit funding request.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The direct debit identifier.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "user_id": {
      "type": "string",
      "format": "uuid",
      "description": "The user initiating the direct 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 as a decimal string.",
      "example": "example-value"
    },
    "currency": {
      "type": "string",
      "description": "The currency of the debit.",
      "pattern": "^[A-Z]{3}$",
      "example": "EUR"
    },
    "remittance_information": {
      "type": "string",
      "description": "Optional remittance information for the debit.",
      "example": "example-value"
    },
    "status": {
      "type": "string",
      "enum": [
        "NEW",
        "PROCESSING",
        "COMPLETED",
        "FAILED",
        "REVERSED"
      ],
      "description": "The status of the direct debit.",
      "example": "NEW"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the direct debit was created.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}