Event Name
createOrder.requestInternalPayOut
Domain
holdings
Description
Indicates that the internal payout request has been initiated
Properties
{
"paymentRequestorDetails": {
"type": "array",
"description": "Contains the requestor details of a payment request from originating system",
"items": {
"id": "urn:jsonschema:PaymentRequestorDetails",
"properties": {
"requestingSystemId": {
"type": "string",
"description": "Identifier of the system from where the event is originated"
},
"requestingCompanyId": {
"type": "string",
"description": "Identifier of the legal entity within the system from where the event is originated"
},
"requestingSystemDate": {
"type": "string",
"description": "Contains the system date on the originating system"
},
"requestSystemWorkingDate": {
"type": "string",
"description": "Contains the banking date on the originating system"
},
"requestCurrency": {
"type": "string",
"description": "Contains the currency in which payment is requested"
},
"requestAmount": {
"type": "string",
"description": "The signed payment amount in 'requestCurrency'"
},
"requestingSystemLocalCurrency": {
"type": "string",
"description": "Contain the local currency of the legal entity from where the event is originated"
},
"requestingAmountInLocalCurrency": {
"type": "string",
"description": "Contains the signed amount in local currency of the requesting system"
},
"requestingSystemExchRate": {
"type": "string",
"description": "Contains the exchange rate that was used to convert the currency amount to the local equivalent"
},
"requestingContractReference": {
"type": "string",
"description": "Identifier used for the contract reference"
},
"requestingAccountId": {
"type": "string",
"description": "Identifier used for the ordering account"
},
"requestingCustomerId": {
"type": "string",
"description": "Identifier of the primary customer of the account"
},
"requestorTransactionReference": {
"type": "string",
"description": "Indicates the transaction reference of the process that raised the accounting entry. It is a technical reference."
},
"requestedExecutionDate": {
"type": "string",
"description": "Contains the date on which payment has to be executed"
},
"accountOfficer": {
"type": "string",
"description": "Identifier of Department Account Officer"
},
"currencyMarket": {
"type": "string",
"description": "Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"
},
"sourceSystem": {
"type": "string",
"description": "Specifies an alternative short name to refer the current backend system"
}
}
}
},
"callBackDetails": {
"type": "array",
"description": "Contains the call back information based on which the payment needs to be executed in requestor system",
"items": {
"id": "urn:jsonschema:CallBackDetails",
"properties": {
"callBackActivity": {
"type": "string",
"description": "Contains the name of the activity to be executed in the requestor system after payment is executed"
},
"callBackSystemId": {
"type": "string",
"description": "Identifier of the requestor system to which response to the payment request has to be routed"
},
"callBackCompanyId": {
"type": "string",
"description": "Identifier of the requestor company to which response to the payment request has to be routed"
},
"callBackAmount": {
"type": "string",
"description": "Indicates the amount which needs to be posted in the requestor system"
},
"callBackAccountId": {
"type": "string",
"description": "Identifier of the requestor account to which response to the payment request has to be routed"
},
"paymentValueDate": {
"type": "string",
"description": "Indicates the date on which the payment is to be executed."
},
"creditDebitIndicator": {
"type": "string",
"description": "Identifies the type of transaction i.e. DEBIT or CREDIT"
}
}
}
},
"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": {
"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."
}
}
}
},
"paymentInstruction": {
"type": "array",
"description": "Contains the instructions based on which payment needs to be executed",
"items": {
"id": "urn:jsonschema:PaymentInstruction",
"properties": {
"targetAccountId": {
"type": "string",
"description": "Identifier of the account for which payment is requested"
},
"targetAccountCategoryCode": {
"type": "string",
"description": "Contains the type/category code of the account for which payment is requested"
},
"targetSystemId": {
"type": "string",
"description": "Contains the system identifier of the account for which payment is requested"
},
"targetCompanyId": {
"type": "string",
"description": "Contains the company identifier of the account for which payment is requested"
},
"paymentCurrency": {
"type": "string",
"description": "This field holds the transaction currency or currency in 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"
},
"creditDebitIndicator": {
"type": "string",
"description": "Identifies the type of transaction i.e. DEBIT or CREDIT"
},
"paymentProductId": {
"type": "string",
"description": "Identifier of the payment product through which payment has to be executed"
},
"transactionTypeCode": {
"type": "string",
"description": "Contains the transaction type code of the payment"
},
"paymentValueDate": {
"type": "string",
"description": "Indicates the date on which the payment is to be executed."
},
"paymentExposureDate": {
"type": "string",
"description": "Contains the date on which payment system has to process the payment"
},
"IBAN": {
"type": "string",
"description": "International Bank Account number, an identifier of the account. E.g. GB29 NWBK 6016 1331 9268 19"
},
"beneficiaryDetails": {
"type": "array",
"description": "Indicates additional details of Beneficiary",
"items": {
"id": "urn:jsonschema:BeneficiaryDetails",
"properties": {
"beneficiaryReference": {
"type": "string",
"description": "The reference which is provided to the beneficiary by the originator of payment"
}
}
}
},
"paymentNarratives": {
"type": "array",
"description": "Contains the narrative of the transaction",
"items": {
"id": "urn:jsonschema:PaymentNarratives",
"properties": {
"paymentNarrative": {
"type": "string",
"description": "Contains the narrative of the transaction"
}
}
}
},
"compositeAccountId": {
"type": "string",
"description": "Identifier of the composite account for which payment is requested.The ID will be of format – System Identifier | Company Id | Account Id. Where, System Identifier denotes the system which owns the account. Company Id denotes the entity in which the account is held. Account Id denotes the identifier of the account. Example : DDA|GB0010001|USD140410001"
}
}
}
},
"paymentBreakdown": {
"type": "array",
"description": "Contains the breakdown of payment information such as bill details, charge details, commission details and tax details.",
"items": {
"id": "urn:jsonschema:PaymentBreakdown",
"properties": []
}
}
}