Upvest · JSON Structure

Investment Api Direct Debit Structure

A direct debit funding request.

Type: object Properties: 9
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

DirectDebit is a JSON Structure definition published by Upvest, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id user_id account_group_id mandate_id cash_amount currency remittance_information status created_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-structure/investment-api-direct-debit-structure.json",
  "name": "DirectDebit",
  "description": "A direct debit funding request.",
  "type": "object",
  "properties": {
    "id": {
      "type": "uuid",
      "description": "The direct debit identifier.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "user_id": {
      "type": "uuid",
      "description": "The user initiating the direct debit.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "account_group_id": {
      "type": "uuid",
      "description": "The account group to fund.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "mandate_id": {
      "type": "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": "datetime",
      "description": "When the direct debit was created.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}