Transactions.proto

option java_package = "com.idamobile.instabank.dto.protobuf";
option java_outer_classname = "Transactions";

import "Commons.proto";
import "Order.proto";

// Return for endpoint: fetchDrafts
// NOTE: For request, Use standard feed request (FeedRequestDTO) for this endpoint
message DraftFeedProtobufDTO {
    repeated DraftProtobufDTO items = 1;
}

// Draft is an abstract container that might contany any of the following:
// order - details on payment order
// auth - authorization transaction details
// clearings - clearing transactions detail
// The contract requres that at least one of these is present, however there are no other assumptions.
message DraftProtobufDTO {
    // Timestamp when transaction is first seen by the system
    required int64 timestamp = 1;

    // Authorization id (provided by bank). Optional, null for back office transactions.
    // Note that for we might have authId but not have authorization id but not have authorization transaction itself
    optional string authId = 2;

    // Financial id (provided by bank). Optional, null for authorizations that are not yet cleared
    optional string finId = 3;

    // Presence of this field indicates that transaction has been canceled and stores timestamp when that happened
    optional int64 canceled = 4;

    // Payment Order
    optional OrderProtobufDTO order = 5;

    // Authorization
    optional AuthorizationProtobufDTO auth = 6;

    // Clearings
    repeated ClearingProtobufDTO clearings = 7;

    // The moment, when authorization  has occured, according to bank's records.
    // Placed on top level because it might originate both from authorization or clearing
    optional int64 authTimestamp = 8;

    // Calculated transaction class
    optional TransactionClass clazz = 10;

    // Calculated transaction category
    optional string categoryId = 11;

    // Terminal description. Terminal data comes aggregated from all transactions
    // with data from authorization taking priority over financial.
    optional TerminalProtobufDTO terminal = 12;

    // User-defined transaction category
    optional string userCategoryId = 21;

    // Envelope bound to the authId
    optional EnvelopeProtobufDTO authEnvelope = 22;

    // Envelope bound to the finId
    optional EnvelopeProtobufDTO finEnvelope = 23;
}

message AuthorizationProtobufDTO {
    // Original transaction currency code
    optional string origCurrency = 2;

    // Original amount of funds, measured in original transaction currency
    required int64 origAmount = 3;

    // Amount of funds applied to account, measured in account currency
    required int64 billAmount = 4;

    // Amount of funds commissioned for this transaction, measured in account currency
    optional int64 commAmount = 5;

    // Amount of funds reported by bank as 'remaining balance', measured in account currency
    required int64 balance = 6;

    // Human readable transaction message (typically as specified by merchant)
    required string message = 7;

    // Transaction title (human readable text provided by bank)
    required string title = 8;

    // Do we really need this?
    //optional string broker = 8;
}

message ClearingProtobufDTO {
    // The moment, when clearing has occured, according to bank's records (financial date).
    required int64 timestamp = 1;

    // Original transaction currency code
    optional string origCurrency = 2;

    // Original amount of funds, measured in original transaction currency
    optional int64 origAmount = 3;

    // Amount of funds applied to account, measured in account currency
    required int64 billAmount = 4;

    // Transaction title (human readable text provided by bank)
    required string title = 8;

}

message TerminalProtobufDTO {
    optional string id = 1;
    optional string name = 2;
    optional string sic = 3;
    optional string country = 4;
    optional string city = 5;
    optional string location = 6;
    optional string desc = 7;
    optional string retailer = 8;
}