Event Name
payout.paymentRequested
Domain
holdings
Description
Indicates an payout transaction request in the account.
Properties
{
"requestDate": {
"type": "string",
"description": "Date on which the client's request to be classified as professional has been received."
},
"currentWorkingDate": {
"type": "string",
"description": "Date of the current business day for all online activities in the selected Company. This field is updated automatically with the date from 'nextWorkingDay' during the Close of Business processing."
},
"currency": {
"type": "string",
"description": "Identifies the currency. E.g. USD, GBP etc"
},
"contractReference": {
"type": "string",
"description": "Contains the contract reference"
},
"orderingAccount": {
"type": "string",
"description": "Contains the National Clearing Code (NCC) or account number of the ordering party."
},
"party": {
"type": "array",
"description": "Identifier of individuals in terms of Customers or Person or Entities with reference to the bank",
"items": {
"id": "urn:jsonschema:Party",
"properties": {
"partyReference": {
"type": "string",
"description": "Contains the identifier used for the party or customer"
},
"partyRole": {
"type": "string",
"description": "Contains the identifier used for the role played by the party or customer in the contract or account"
}
}
}
},
"transactionReference": {
"type": "string",
"description": "Contains the identifier for the transaction in the core system"
},
"requestedAmount": {
"type": "string",
"description": "Requested amount for funds authorisation"
},
"companyReference": {
"type": "string",
"description": "Contains the identifier of the underlying Entity or Company or Branch"
},
"systemId": {
"type": "string",
"description": "System ID of the originating transaction"
},
"applyPaymentActivity": {
"type": "string",
"description": "Indicates the action that will be performed when there is unallocated amount or unidentified transaction type"
},
"settlementDetails": {
"type": "array",
"description": "Contains the settlement details like payin instructions, payout instructions defined in the transaction.",
"items": {
"id": "urn:jsonschema:Settlementdetails",
"properties": {
"accountReference": {
"type": "string",
"description": "Account Reference of the error account"
},
"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"
},
"beneficiaryReference": {
"type": "string",
"description": "The reference which is provided to the beneficiary by the originator of payment"
},
"paymentOrderProduct": {
"type": "string",
"description": "Indicates the payment order product for which payment is initiated"
},
"paymentAmount": {
"type": "string",
"description": "Indicates the payment amount for the defined term, amount and payment frequency. It will include principal, charge and interest"
},
"settlementCurrency": {
"type": "string",
"description": "The currency of the trade settlement"
}
}
}
},
"additionalDetails": {
"type": "array",
"description": "Additional details provided to add context. Closure notes for closed accounts, positing restriction details for restricted accounts & joint holder notes or account title for active accounts",
"items": {
"id": "urn:jsonschema:AdditionalDetails",
"properties": {
"name": {
"type": "string",
"description": "Short title for the Account to be created"
},
"value": {
"type": "string",
"description": "The value of the field on which the Alert criteria is based"
}
}
}
}
}