CreateOperationPaymentRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-create-operation-payment-request-schema.json",
  "title": "CreateOperationPaymentRequest",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-account-operation-api-openapi.yml#/components/schemas/CreateOperationPaymentRequest",
  "type": "object",
  "required": [
    "externalOperationReference",
    "externalOperationDate",
    "externalOperationServicePoster",
    "referenceAmount"
  ],
  "properties": {
    "description": {
      "type": "string",
      "description": "Textual description of the operation\nCan contain a free text that can be used when the operation is presented to the Customer"
    },
    "externalOperationReference": {
      "type": "string",
      "description": "The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system.\nExternal reference of the operation to be created."
    },
    "externalOperationDate": {
      "format": "date-time",
      "type": "string",
      "description": "The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system.\nThe date the operation is performed (in general, the current date should be provided)."
    },
    "externalOperationServicePoster": {
      "type": "string",
      "description": "The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system.\nThe identifier of the external system which provides the operation to be posted (free text)"
    },
    "externalOperationCode": {
      "type": "string",
      "description": "The external operation code of the payment operation can be provided to identify the operation type in the issuer system."
    },
    "overPaymentAccountIdentifier": {
      "description": "Identifier of the account in case of overpayment situation\nIf provided, the overpayment account must be in an active or being closed status",
      "allOf": [
        {
          "$ref": "#/$defs/AccountIdentifier"
        }
      ]
    },
    "referenceAmount": {
      "description": "The amount of the operation (amount/exponent/currency values)",
      "allOf": [
        {
          "$ref": "#/$defs/Amount"
        }
      ]
    },
    "valueDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date when the operation impacts balances or counters.\nIf not provided, the value date is set to the external operation date.\nWhen the value date is in the future, a pending operation is created."
    },
    "paymentChannel": {
      "type": "string",
      "description": "The channel by which the payment is performed (optional field). \nThe possible values are:\nDIRECT_DEBIT\nCHEQUE\nCASH\nONLINE_MONEY \nNO_CHANNEL_PROVIDED\nINCOMING_PAYMENT\nNote that NO_CHANNEL_PROVIDED will be set by default if the paymentChannel is not provided."
    },
    "sepa": {
      "type": "boolean",
      "description": "Indicates whether the payment is performed in SEPA format.\nBy default, the value is false."
    },
    "paymentReason": {
      "type": "string",
      "description": "The reason why the payment is triggerred\nThe list of possible payment reasons is configurable per issuer."
    },
    "specificFields": {
      "type": "object",
      "description": "The issuer can provide Specific Fields for the operation.\n It is a list of external data {\"label\":\"value\"} separated by a \",\" related to the operation (pass-thru data) that can be provided by e.g. the issuer for information or for usage by other systems. Example : {\"label1\":\"value1\",\"label2\":\"value2\"} Those provided data have no impact on our system business processes.",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "$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"
    }
  }
}