Bunq · Schema

ScheduleInstanceListing

Banking

Properties

Name Type Description
state string The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR)
time_start string The schedule start time (UTC).
time_end string The schedule end time (UTC).
error_message array The message when the scheduled instance has run and failed due to user error.
scheduled_object object The scheduled object. (Payment, PaymentBatch)
result_object object The result object of this schedule instance. (Payment, PaymentBatch)
request_reference_split_the_bill array The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch
View JSON Schema on GitHub

JSON Schema

bunq-scheduleinstancelisting-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScheduleInstanceListing",
  "title": "ScheduleInstanceListing",
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "description": "The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR)",
      "readOnly": true,
      "writeOnly": false
    },
    "time_start": {
      "type": "string",
      "description": "The schedule start time (UTC).",
      "readOnly": true,
      "writeOnly": false
    },
    "time_end": {
      "type": "string",
      "description": "The schedule end time (UTC).",
      "readOnly": true,
      "writeOnly": false
    },
    "error_message": {
      "type": "array",
      "description": "The message when the scheduled instance has run and failed due to user error.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/Error"
      }
    },
    "scheduled_object": {
      "type": "object",
      "description": "The scheduled object. (Payment, PaymentBatch)",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/ScheduleAnchorObject"
    },
    "result_object": {
      "type": "object",
      "description": "The result object of this schedule instance. (Payment, PaymentBatch)",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/ScheduleInstanceAnchorObject"
    },
    "request_reference_split_the_bill": {
      "type": "array",
      "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/RequestInquiryReference"
      }
    }
  }
}