CreateDirectDebitRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-create-direct-debit-request-schema.json",
  "title": "CreateDirectDebitRequest",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-direct-debit-api-openapi.yml#/components/schemas/CreateDirectDebitRequest",
  "type": "object",
  "required": [
    "overPaymentAccountIdentifier",
    "amount"
  ],
  "properties": {
    "overPaymentAccountIdentifier": {
      "description": "Card account identifier to be credited",
      "allOf": [
        {
          "$ref": "#/$defs/AccountIdentifier"
        }
      ]
    },
    "amount": {
      "description": "Amount of Direct Debit",
      "allOf": [
        {
          "$ref": "#/$defs/Amount"
        }
      ]
    },
    "externalOperationCode": {
      "type": "string",
      "description": "The external operation code of the balance adjustment can be provided."
    },
    "paymentReason": {
      "type": "string",
      "description": "The reason why the payment is triggerred\nThe list of possible payment reasons is configurable per issuer."
    }
  },
  "$defs": {
    "AccountIdentifier": {
      "type": "object",
      "properties": {
        "accountReference": {
          "type": "string",
          "description": "Account reference is to identify the Account calculated by the system (algorithm is configurable per issuer). Either the account number or the issuerAccountExternalReference is provided, or, if both are provided then only the account number is used."
        },
        "issuerAccountExternalReference": {
          "type": "string",
          "description": "Issuer account external reference is to identify the Account. Either the account number or the issuerAccountExternalReference is provided, or, if both are provided then only the account number is used. Algorithm configurable by issuer, can be generated by the system if there is an externalReferenceGeneratorAlgorithm."
        }
      },
      "title": "AccountIdentifier"
    },
    "Amount": {
      "type": "object",
      "required": [
        "value",
        "exponent",
        "isoCode"
      ],
      "properties": {
        "value": {
          "type": "integer",
          "format": "int64",
          "description": "Integer amount value. Ex. if it is two hundred euros and 17 cents, then amount value is 20017 (exponent = 2 digits for currency=EUR)"
        },
        "exponent": {
          "type": "integer",
          "format": "int32",
          "description": "Exponent of Amount. Number of decimal digits."
        },
        "isoCode": {
          "type": "string",
          "description": "Currency code of amount\nThe currency in ISO4217 alphabetic format.\nExample: EUR for Euro"
        }
      },
      "title": "Amount"
    }
  }
}