{ "$schema" : "http://json-schema.org/draft-04/schema#", "type" : "object", "title" : "transaction", "description" : "A transaction is the result of a successful transfer or debit.", "properties" : { "id" : { "$ref" : "./base_types/base_types.json#definitions/id" }, "account_id" : { "$ref" : "./base_types/base_types.json#definitions/account_id", "readOnly" : true }, "transaction_type" : { "$ref" : "./base_types/base_types.json#definitions/transaction_type", "readOnly" : true }, "transaction_type_details" : { "description" : "Details specific to this transaction type are collected here.", "readOnly" : true, "type" : "object", "oneOf" : [ { "title": "credit_card_details", "$ref" : "./transaction_type_details/credit_card_details.json#" }, { "title": "internal_transfer_details", "$ref" : "./transaction_type_details/internal_transfer_details.json#" }, { "title": "sepa_credit_transfer_details", "$ref" : "./transaction_type_details/sepa_credit_transfer_details.json#" }, { "title": "sepa_direct_debit_details", "$ref" : "./transaction_type_details/sepa_direct_debit_details.json#" }, { "title": "gmt_details", "$ref" : "./transaction_type_details/gmt_details.json#" }, { "title": "bonus_details", "$ref" : "./transaction_type_details/bonus_details.json#" }, { "title": "mobile_topup_details", "$ref" : "./transaction_type_details/mobile_topup_details.json#" }, { "title": "fps_details", "$ref" : "./transaction_type_details/fps_details.json#" } ] }, "subject" : { "$ref" : "./base_types/base_types.json#definitions/subject", "readOnly" : true }, "amount" : { "description" : "The transferred amount in account currency, in minor units, e.g. 1EUR is represented as 100. Can be negative e.g. if something was withdrawn from an account.", "type" : "integer", "readOnly" : true }, "currency" : { "$ref" : "./base_types/base_types.json#definitions/currency", "readOnly" : true }, "booking_date" : { "description" : "Date the transaction was booked. ISO 8601 Date", "format" : "date-time", "readOnly" : true, "type" : "string" }, "value_date" : { "description" : "Date the amount was credited to the account. ISO 8601 Date", "format" : "date-time", "readOnly" : true, "type" : "string" }, "booking_code" : { "description" : "Accounting transaction code in the central banking system", "readOnly" : true, "type" : "string" }, "return_transaction_id" : { "description" : "If the transaction was marked for return, this references the new return transaction.", "readOnly" : true, "type" : "string" }, "created_at" : { "$ref" : "./base_types/base_types.json#definitions/created_at" }, "updated_at" : { "$ref" : "./base_types/base_types.json#definitions/updated_at" } }, "links" : [ { "rel" : "self", "href" : "transactions/{id}" }, { "rel" : "instances", "href" : "transactions", "properties" : { "filter[account_ids]" : { "title" : "Find transactions belonging to the given account ids. Single id or multiple ids comma-separated.", "format" : "date-time", "type" : "string" }, "filter[id_from]" : { "title" : "Find transactions with an id greater than given one.", "format" : "integer", "type" : "string" }, "filter[id_to]" : { "title" : "Find transactions with an id smaller than given one.", "format" : "integer", "type" : "string" }, "filter[booking_date_from]" : { "title" : "Date filter from >= date. ISO 8601 Date", "format" : "date-time", "type" : "string" }, "filter[booking_date_to]" : { "title" : "Date filter to <= date. ISO 8601 Date", "format" : "date-time", "type" : "string" }, "filter[value_date_from]" : { "title" : "Date filter from >= date. ISO 8601 Date", "format" : "date-time", "type" : "string" }, "filter[value_date_to]" : { "title" : "Date filter to <= date. ISO 8601 Date", "format" : "date-time", "type" : "string" }, "filter[created_at_from]" : { "title" : "Date filter from >= date. ISO 8601 Date", "format" : "date-time", "type" : "string" }, "filter[created_at_to]" : { "title" : "Date filter to <= date. ISO 8601 Date", "format" : "date-time", "type" : "string" }, "filter[updated_at_from]" : { "title" : "Date filter from >= date. ISO 8601 Date", "format" : "date-time", "type" : "string" }, "filter[updated_at_to]" : { "title" : "Date filter to <= date. ISO 8601 Date", "format" : "date-time", "type" : "string" }, "filter[transaction_types]" : { "$ref" : "./base_types/base_types.json#definitions/transaction_type", "title" : "By transaction types" }, "page" : { "title" : "Page", "description" : "In paginated results set the page to look for", "type" : "integer" }, "per_page" : { "title" : "Per page", "description" : "Results per page. Default is 10, max is 100", "type" : "integer" }, "sort" : { "title" : "Sort", "enum" : [ "ASC", "DESC" ], "description" : "Sort the results in ASC or DESC", "type" : "string" } } } ] }