Event Name
payin.transactionExecuted
Domain
holdings
Description

Indicates execution of pay in (credit).

Properties
{
    "transactionCurrency": {
        "type": "string",
        "description": "Indicates the currency of the transaction. For example GBP, USD etc."
    },
    "transactionAmount": {
        "type": "string",
        "description": "Contains the transaction amount. This is based on the currency, either local or foreign currency"
    },
    "contractAmount": {
        "type": "string",
        "description": "Indicates the amount of the transaction in contract currency"
    },
    "baseDetails": {
        "type": "object",
        "description": "Indicates the identifier for base details in which system reference, base contract reference, event name, effective date and other related details are defined",
        "id": "urn:jsonschema:BaseDetails",
        "properties": {
            "contractReference": {
                "type": "string",
                "description": "Contains the contract reference"
            },
            "systemReference": {
                "type": "string",
                "description": "Contains the identifier for the system in which the event originated from. For ex, Hogan or TransactAccounts etc"
            },
            "companyReference": {
                "type": "string",
                "description": "Contains the identifier of the underlying Entity or Company or Branch"
            },
            "eventName": {
                "type": "string",
                "description": "The name that is displayed for the event"
            },
            "baseEventIdentifier": {
                "type": "string",
                "description": "Indicates the name of the event that is happening in the core system"
            },
            "effectiveDate": {
                "type": "string",
                "description": "Contains the identifier for the transaction date. Dates are expected in YYYYMMDD format"
            },
            "bookingDate": {
                "type": "string",
                "description": "Indicates the date on which this business activity is booked in the underlying system. The effective date and booking date could be different if systems allow forward/back dated business transactions. Dates are expected in YYYYMMDD format. If booking date is not passed, effective date would be assumed as booking date."
            },
            "contractCurrency": {
                "type": "string",
                "description": "Indicates the currency associated with the contract"
            },
            "channel": {
                "type": "string",
                "description": "Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"
            },
            "branch": {
                "type": "string",
                "description": "Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"
            },
            "lineOfBusiness": {
                "type": "string",
                "description": "Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"
            },
            "activityDateTimeStamp": {
                "type": "string",
                "description": "Contains the date and time of activity triggered."
            },
            "transactionReference": {
                "type": "string",
                "description": "Contains the identifier for the transaction in the core system"
            },
            "reversalIndicator": {
                "type": "boolean",
                "description": "Indicates whether the underlying transaction is reversed so that the details of the same could be removed from Enterprise product pricing system"
            },
            "originationReference": {
                "type": "string",
                "description": "Identifier of the account in source system, eg, a origination system."
            },
            "contractStatus": {
                "type": "string",
                "description": "Contains the status of the contract, e.g. open, matured or liquidated, unauthorised or authorised, closed."
            },
            "accountId": {
                "type": "string",
                "description": "Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"
            },
            "overdue": {
                "type": "string",
                "description": "Indicates the aging status of the arrangement."
            },
            "eventCount": {
                "type": "number",
                "description": "Indicates the number of events emitted from Transact for an activity"
            },
            "quotationReference": {
                "type": "string",
                "description": "Contains the unique identifier for the requested pricing quotation. Pricing quotation can be requested for new account, account transaction, account closure, etc"
            },
            "feeDetails": {
                "type": "array",
                "description": "Indicates the identifier for fee details in which fee name, fee amount, adjsuted fee amount are defined",
                "items": {
                    "id": "urn:jsonschema:FeeDetails",
                    "properties": {
                        "feeName": {
                            "type": "string",
                            "description": "Indicates the description for type of fee which is applied for payment instruction"
                        },
                        "feeAmount": {
                            "type": "string",
                            "description": "Indicates the amount corresponding to the arrangement charge property."
                        },
                        "feeCurrency": {
                            "type": "string",
                            "description": "Indicates the fee currency in which fee amount is applied for the payment instruction"
                        },
                        "adjustFeeAmount": {
                            "type": "string",
                            "description": "Indicates the adjustment detail if the base fee is adjusted for some reason in the system. This is a signed number. Hence if any decrease in fee should be indicated with a negative sign."
                        },
                        "adjustFeeReason": {
                            "type": "string",
                            "description": "Indicates the reason for adjusting the base fee. System use adjust fee reason for analytics purpose."
                        }
                    }
                }
            },
            "balances": {
                "type": "array",
                "description": "The monetary value of each balance type for an account is itemised.",
                "items": {
                    "id": "urn:jsonschema:Balances",
                    "properties": {
                        "balanceName": {
                            "type": "string",
                            "description": "Balance name"
                        },
                        "closingBalance": {
                            "type": "string",
                            "description": "Closing balance of the arrangement"
                        },
                        "dateType": {
                            "type": "string",
                            "description": "Indicates the date type which qualifies the balance dates. Allowed options are TRADE or VALUE. If it is not passed, default option will be value"
                        },
                        "debitTotalAmount": {
                            "type": "string",
                            "description": "Indicates the total amount which is debited from the contract or account."
                        },
                        "creditTotalAmount": {
                            "type": "string",
                            "description": "Indicates the total amount which is credited to the contract or account"
                        },
                        "timeStamp": {
                            "type": "string",
                            "description": "Deprecated - Time Stamp"
                        },
                        "openingBalance": {
                            "type": "string",
                            "description": "Balance brought forward from the previous date/period."
                        }
                    }
                }
            },
            "alternateReferences": {
                "type": "array",
                "description": "If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will be mapped to ALTERNATE.ID field in arrangement activity and ensure that this Account doesn't already exist in T24 with another reference (because ALTERNATE.ID would be configured to be unique across T24).",
                "items": {
                    "id": "urn:jsonschema:AlternateReferences",
                    "properties": {
                        "alternateIdType": {
                            "type": "string",
                            "description": "Contains the alternate account system identifier used for defining the alternate account Id"
                        },
                        "alternateId": {
                            "type": "string",
                            "description": "An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."
                        }
                    }
                }
            },
            "extension": {
                "type": "array",
                "description": "Specifies extension data.",
                "items": {
                    "id": "urn:jsonschema:Extension",
                    "properties": {
                        "key": {
                            "type": "string",
                            "description": "Key to a specific extension"
                        },
                        "values": {
                            "type": "array",
                            "description": "Values associated to the key for extension",
                            "items": {
                                "type": "string"
                            }
                        }
                    }
                }
            }
        }
    },
    "accountsBaseDetails": {
        "type": "object",
        "description": "Contains the base details like overdraft status, dormancy status for an accounts contract",
        "id": "urn:jsonschema:AccountsBaseDetails",
        "properties": {
            "overdraftStatus": {
                "type": "string",
                "description": "Indicates the overdraft status of the accounts contract"
            },
            "dormancyStatus": {
                "type": "string",
                "description": "Indicates the Dormancy status"
            },
            "multiCurrencyAccountIds": {
                "type": "object",
                "description": "Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies",
                "id": "urn:jsonschema:mcyAccountDetails",
                "properties": {
                    "multiCurrencyAccountId": {
                        "type": "string",
                        "description": "Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"
                    },
                    "currency": {
                        "type": "string",
                        "description": "Identifies the currency. E.g. USD, GBP etc"
                    },
                    "multiCurrencyAccountBalances": {
                        "type": "object",
                        "description": "Contains the balance value of the multicurrency account like balance name, date type, closing balance for each balance name.",
                        "id": "urn:jsonschema:MultiCurrencyAccountBalances",
                        "properties": {
                            "currency": {
                                "type": "string",
                                "description": "Identifies the currency. E.g. USD, GBP etc"
                            },
                            "balances": {
                                "type": "array",
                                "description": "The monetary value of each balance type for an account is itemised.",
                                "items": {
                                    "id": "urn:jsonschema:Balances",
                                    "properties": {
                                        "balanceName": {
                                            "type": "string",
                                            "description": "Balance name"
                                        },
                                        "closingBalance": {
                                            "type": "string",
                                            "description": "Closing balance of the arrangement"
                                        },
                                        "dateType": {
                                            "type": "string",
                                            "description": "Indicates the date type which qualifies the balance dates. Allowed options are TRADE or VALUE. If it is not passed, default option will be value"
                                        },
                                        "debitTotalAmount": {
                                            "type": "string",
                                            "description": "Indicates the total amount which is debited from the contract or account."
                                        },
                                        "creditTotalAmount": {
                                            "type": "string",
                                            "description": "Indicates the total amount which is credited to the contract or account"
                                        },
                                        "timeStamp": {
                                            "type": "string",
                                            "description": "Deprecated - Time Stamp"
                                        },
                                        "openingBalance": {
                                            "type": "string",
                                            "description": "Balance brought forward from the previous date/period."
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "bills": {
        "type": "array",
        "description": "Indicates the bills generated for an account",
        "items": {
            "id": "urn:jsonschema:Bills",
            "properties": {
                "billId": {
                    "type": "string",
                    "description": "Indicates the bill reference or Id"
                },
                "billDetails": {
                    "type": "object",
                    "description": "Contains the bill details like bill reference, bill type, bill amount, bill date of a payment transaction.",
                    "id": "urn:jsonschema:BillDetails",
                    "properties": {
                        "dueDate": {
                            "type": "string",
                            "description": "Identifies the date on which the activity is due."
                        },
                        "paymentDate": {
                            "type": "string",
                            "description": "Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"
                        },
                        "deferDate": {
                            "type": "string",
                            "description": "Date that the payment has been deferred to"
                        },
                        "cashflowDate": {
                            "type": "string",
                            "description": "Indicates the cashflow dates corresponding to cashflow type and cashflow amount during the entire lifecycle of the contract "
                        },
                        "expiryDate": {
                            "type": "string",
                            "description": "This indicates the  date  on which the offer or privilege terminates for the event."
                        },
                        "billedAmount": {
                            "type": "string",
                            "description": "Indicates the bill amount"
                        },
                        "billedAmountLcy": {
                            "type": "string",
                            "description": "Indicates the given bill amount in local currrency"
                        },
                        "currency": {
                            "type": "string",
                            "description": "Identifies the currency. E.g. USD, GBP etc"
                        },
                        "billStatus": {
                            "type": "string",
                            "description": "Indicates the status of a bill(Issued,Due,Ageing,Settled)"
                        },
                        "paymentTypes": {
                            "type": "array",
                            "description": "Indicates if the payment is Customer (C) type or Bank (B) type",
                            "items": {
                                "id": "urn:jsonschema:PaymentTypes",
                                "properties": {
                                    "issueDate": {
                                        "type": "string",
                                        "description": "The date the item was issued."
                                    },
                                    "paymentType": {
                                        "type": "string",
                                        "description": "Contains the details of the standard payment types like LINEAR, ANNUNITY as defined in the product."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "Contains the description of purpose of the payment."
                                    },
                                    "billType": {
                                        "type": "string",
                                        "description": "The type of payment obligation generated"
                                    },
                                    "billTypeDescription": {
                                        "type": "string",
                                        "description": "Contains the short name of the bill type identifier"
                                    },
                                    "paymentMethod": {
                                        "type": "string",
                                        "description": "Method chosen to make the payment"
                                    },
                                    "paymentDetails": {
                                        "type": "array",
                                        "description": "Indicates the payment details for the beneficiary to apply the payment.",
                                        "items": {
                                            "id": "urn:jsonschema:PaymentDetails",
                                            "properties": {
                                                "propertyId": {
                                                    "type": "string",
                                                    "description": "Contains the identifier of the product property"
                                                },
                                                "propertyName": {
                                                    "type": "string",
                                                    "description": "Indicates the  property description to which benefit has been applied"
                                                },
                                                "propertyAmount": {
                                                    "type": "string",
                                                    "description": "Indicates the payment amount which is corresponding to the product property"
                                                },
                                                "propertyAmountLcy": {
                                                    "type": "string",
                                                    "description": "Indicates the given property amount in local currency"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "propertyBalances": {
                            "type": "array",
                            "description": "Indicates the balance status of the property",
                            "items": {
                                "id": "urn:jsonschema:PropertyBalances",
                                "properties": {
                                    "amount": {
                                        "type": "string",
                                        "description": "This is the payment amount"
                                    },
                                    "property": {
                                        "type": "string",
                                        "description": "Id of the product property"
                                    },
                                    "bankOutstandingAmount": {
                                        "type": "string",
                                        "description": "Contains the outstanding amount in bank's books for the corresponding property after the charge off activity."
                                    },
                                    "chargeoffAmount": {
                                        "type": "string",
                                        "description": "Indicates the charged off amount of a loan under (FASB)Financial Accounting Standard Board regulation"
                                    },
                                    "writeOffAmount": {
                                        "type": "string",
                                        "description": "Indicates that the corresponding balance needs to be written off partially. It should not be greater than the original balance amount."
                                    },
                                    "adjustValue": {
                                        "type": "string",
                                        "description": "Indicates the value by which base value has to be adjusted"
                                    },
                                    "repaymentDetails": {
                                        "type": "array",
                                        "description": "Contains the repayment details like payment type, payment frequency, payment method defined in the transaction.",
                                        "items": {
                                            "id": "urn:jsonschema:RepaymentDetails",
                                            "properties": {
                                                "reference": {
                                                    "type": "string",
                                                    "description": "Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is requested"
                                                },
                                                "repaidAmount": {
                                                    "type": "string",
                                                    "description": "Indicates the amount which was repaid from the customer"
                                                }
                                            }
                                        }
                                    },
                                    "lastScheduleDate": {
                                        "type": "string",
                                        "description": "Indicates the date on which the actual last schedule happened for the fee. This date is required if there are any rules to be applied like average balance in the period, number of transactions within this period etc, then it would be used as the start date"
                                    }
                                }
                            }
                        },
                        "agingStatus": {
                            "type": "string",
                            "description": "Indicates the ageing status of a bill"
                        },
                        "agingstatusChangeDate": {
                            "type": "string",
                            "description": "Contains the effective date of the current aging status of the transaction"
                        },
                        "previousAgingStatus": {
                            "type": "string",
                            "description": "Contains the previous aging status of the transaction"
                        },
                        "nextAgeDate": {
                            "type": "string",
                            "description": "Contains the effective date of the next aging status of the transaction"
                        },
                        "bankTotalOutstandingAmount": {
                            "type": "string",
                            "description": "Contains the total outstanding amount in bank's books after the charge off activity."
                        },
                        "advancePayment": {
                            "type": "string",
                            "description": "Indicates whether advance payment made is set on an account"
                        },
                        "delinquentAmount": {
                            "type": "string",
                            "description": "Indicates the bill amount during the ageing status(Bill which crossed the due date)"
                        },
                        "paymentIndicator": {
                            "type": "string",
                            "description": "Indicates whether its a credit/debit type of bill"
                        },
                        "settlementStatus": {
                            "type": "string",
                            "description": "Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message,  Action required : awaiting action to be performed to get the final update on settlement status.Matched : transactions whose nominals have matched with the depository position"
                        },
                        "billStatuses": {
                            "type": "array",
                            "description": "Indicates the status of a bill(Issued,Due,Ageing,Settled)",
                            "items": {
                                "id": "urn:jsonschema:BillStatus",
                                "properties": {
                                    "billStatus": {
                                        "type": "string",
                                        "description": "Indicates the status of a bill(Issued,Due,Ageing,Settled)"
                                    },
                                    "statusChangeDate": {
                                        "type": "string",
                                        "description": "Identifies the effective date of change of status"
                                    }
                                }
                            }
                        },
                        "settlementStatuses": {
                            "type": "array",
                            "description": "Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message,  Action required : awaiting action to be performed to get the final update on settlement status.Matched : transactions whose nominals have matched with the depository position",
                            "items": {
                                "id": "urn:jsonschema:SettleStatuses",
                                "properties": {
                                    "settlementStatus": {
                                        "type": "string",
                                        "description": "Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message,  Action required : awaiting action to be performed to get the final update on settlement status.Matched : transactions whose nominals have matched with the depository position"
                                    },
                                    "statusChangeDate": {
                                        "type": "string",
                                        "description": "Identifies the effective date of change of status"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "context": {
        "type": "array",
        "description": "Contains the context details in which context names and context values are defined. It defines the specific contexts that needs to be passed in addition to the amount or currency for pricing calculation. Pricing calculation means fee or interest amount calculated based on the predefined rules applied for the contract.",
        "items": {
            "id": "urn:jsonschema:Context",
            "properties": {
                "contextName": {
                    "type": "string",
                    "description": "Field name returned by the payment engine (TPH) for information or further processing."
                },
                "contextValue": {
                    "type": "string",
                    "description": "Field value returned by the payment engine (TPH) for information or further processing."
                }
            }
        }
    },
    "interestProperties": {
        "type": "array",
        "description": "Contains the identifiers of the interest properties attached to the product level",
        "items": {
            "id": "urn:jsonschema:InterestAccruals",
            "properties": {
                "property": {
                    "type": "string",
                    "description": "Id of the product property"
                },
                "accrualInfo": {
                    "type": "array",
                    "description": "",
                    "items": {
                        "id": "urn:jsonschema:AccrualInfo",
                        "properties": {
                            "accruedInterests": {
                                "type": "object",
                                "description": "The amount of interest that has been accrued",
                                "id": "urn:jsonschema:AccruedInterests",
                                "properties": {
                                    "accrualAmount": {
                                        "type": "string",
                                        "description": "Indicates interest accumulated for an account for the defined time period"
                                    },
                                    "negativeInterestAmount": {
                                        "type": "string",
                                        "description": "Indicates the negative amount of a interest property"
                                    },
                                    "positiveInterestAmount": {
                                        "type": "string",
                                        "description": "Negative interest amount accrued"
                                    }
                                }
                            },
                            "periodEndDate": {
                                "type": "string",
                                "description": "Indicates the end date of a period over which the transaction or payment can be cycled based on the frequency"
                            },
                            "periodStartDate": {
                                "type": "string",
                                "description": "Indicates the start date of a period over which the transaction or payment can be cycled based on the frequency"
                            }
                        }
                    }
                },
                "interestPaidYtd": {
                    "type": "string",
                    "description": "Interest paid from the start of current year till current date"
                },
                "lastPaidDivident": {
                    "type": "string",
                    "description": "Deprecated - Interest accrued for the specified period"
                },
                "accruedInterest": {
                    "type": "string",
                    "description": "The amount of interest that has been accrued"
                }
            }
        }
    },
    "itemizedEvents": {
        "type": "array",
        "description": "Indicates the itemized event details for an activity",
        "items": {
            "id": "urn:jsonschema:ItemizedEvents",
            "properties": {
                "eventName": {
                    "type": "string",
                    "description": "The name that is displayed for the event"
                },
                "transactionAmount": {
                    "type": "number",
                    "description": "Contains the transaction amount. This is based on the currency, either local or foreign currency"
                },
                "baseEventIdentifier": {
                    "type": "string",
                    "description": "Indicates the name of the event that is happening in the core system"
                },
                "eventCount": {
                    "type": "number",
                    "description": "Indicates the number of events emitted from Transact for an activity"
                },
                "extension": {
                    "type": "array",
                    "description": "Specifies extension data.",
                    "items": {
                        "id": "urn:jsonschema:Extension",
                        "properties": {
                            "key": {
                                "type": "string",
                                "description": "Key to a specific extension"
                            },
                            "values": {
                                "type": "array",
                                "description": "Values associated to the key for extension",
                                "items": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}