obrdep-txn-pp-integration-services 9.5.0

The Retail Deposit Services API allows publishing to Integration service Kafka messages.

Operations

Pub AccountingTransactionPublishEvent

AccountingTransactionEvent.

Publishes accounting transaction details.

Accepts the following message:

Accounting Transaction Event AccountingTransactionPublishEvent

Accounting Transaction Event

Payload AccountingTransactionEvent
object
AccountingTransactionEntries
array<object>
AccountingTransactionEntry
object
eaRefNo
string
length <= 20

External Accounting Reference Number

Default: null
txnRefNo
string
length <= 20

Transaction Reference Number

Default: null
source
string
length <= 15

Source which is sending the transaction

Default: null
event
string
length <= 4

Transaction Event

Default: null
eventSrNo
string

Event Serial Number

Default: null
glPostingDate
string
length <= 10

Transaction Posting Date

Default: null
txnInitDate
string
length <= 10

Transaction Initialization Date

Default: null
externalMaker
string
length <= 320

User who has created the transaction

Default: null
externalChecker
string
length <= 320

User who has authorized the transaction

Default: null
txnBranch
string
length <= 6

Transaction Branch from which Transaction is initiated

Default: null
referralAllowed
string
Default: null
suppressAccOverridesUptoSeverityLevel
integer
Default: null
suppressBalanceOverridesUptoSeverityLevel
integer
Default: null
deferredResponse
boolean
length <= 1
Default: null
maker
string
length <= 320

User who has Initiated the transaction

Default: null
checker
string
length <= 320

User who has authorized the transaction

Default: null
createdTimestamp
string
length <= 26

Timestamp when the transaction is created

Default: null
updatedTimestamp
string
length <= 26

Timestamp when the transaction is updated

Default: null
authStatus
string
Default: null
Enum: "U" "A" "R"
txnStatus
string
Default: null
operation
string
length <= 5
Default: null
originalSource
string
length <= 15

Source where the trasaction is originated

Default: null
balancedEntry
boolean
length <= 1

Indicates the Account Transaction being Posted is balanced and should be verifed i.e. sum of credits = sum of debits

Default: null
AccountingTransactionDetailsEntries
array<object>
AccountingTransactionDetailsEntry
object
accNo
string
length <= 34

Account Number

Default: null
accBranch
string
length <= 6

Branch associated with the Account

Default: null
accCcy
string
length <= 3

Account Currency

Default: null
eaRefNo
string
length <= 20

External Accounting Reference Number

Default: null
txnRefNo
string
length <= 20

Transaction Reference Number

Default: null
source
string
length <= 15

Source which is sending the transaction

Default: null
blockRefNo
string
length <= 20

Amount block reference number associated with the transaction

Default: null
accountingRefNo
string
length <= 20

Uniquely generated reference number to Identify each transaction

Default: null
accountCcyAmt
string

Transaction Amount in Account Currency

Default: null
branchLcyAmt
string

Transaction Amount in Transaction Branch Currency

Default: null
exchRate
string

Exchange Rate

Default: null
valueDate
string
length <= 10

Value Date of the Transaction

Default: null
glPostingDate
string
length <= 10

Transaction Posting Date

Default: null
instrumentCode
string
length <= 20

Instrument Code associated with the Transaction

Default: null

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

Examples

AccountingTransactionPublishEvent
Payload
{ "AccountingTransactionEntries": [ { "AccountingTransactionEntry": { "eaRefNo": null, "txnRefNo": null, "source": null, "event": null, "eventSrNo": null, "glPostingDate": null, "txnInitDate": null, "externalMaker": null, "externalChecker": null, "txnBranch": null, "referralAllowed": null, "suppressAccOverridesUptoSeverityLevel": null, "suppressBalanceOverridesUptoSeverityLevel": null, "deferredResponse": null, "maker": null, "checker": null, "createdTimestamp": null, "updatedTimestamp": null, "authStatus": null, "txnStatus": null, "operation": null, "originalSource": null, "balancedEntry": null, "AccountingTransactionDetailsEntries": [ { "AccountingTransactionDetailsEntry": { "accNo": null, "accBranch": null, "accCcy": null, "eaRefNo": null, "txnRefNo": null, "source": null, "blockRefNo": null, "accountingRefNo": null, "accountCcyAmt": null, "branchLcyAmt": null, "exchRate": null, "valueDate": null, "glPostingDate": null, "instrumentCode": null } } ] } } ] }
This example has been generated automatically.

Pub CustomerStatusUpdateEvent

CustomerStatusUpdateEvent.

Publishes information related to customer status.

Accepts the following message:

CustomerStatusUpdateEvent CustomerStatusUpdateEvent

CustomerStatusUpdateEvent

Payload CustomerStatusUpdateEvent
object
referenceIds
array<object>
ReferenceId
object
referenceId
string

Reference ID

Default: null

Additional properties are allowed.

Additional items are allowed.

referenceType
string

Type of the reference

Default: null
branchCode
string

Branch Code

Default: null
event
string

Event associated with the customer status update

Default: null

Additional properties are allowed.

Examples

CustomerStatusUpdateEvent
Payload
{ "referenceIds": [ { "ReferenceId": { "referenceId": null } } ], "referenceType": null, "branchCode": null, "event": null }
This example has been generated automatically.

Pub localHolidayUpdateMessage

localHolidayUpdateMessage.

Publishes information related to local holidays.

Accepts the following message:

localHolidayUpdateMessage localHolidayUpdateMessage

localHolidayUpdateMessage

Payload LocalHolidayUpdateMessage
object
holidayList
array<object>
holidayDto
object
branchCode
string
length <= 10

Branch Code

Default: null
year
string
length <= 4

Year of the holiday

Default: null
month
string
length <= 20

Month of the holiday

Default: null
date
string
length <= 10

Date of the holiday

Default: null
status
string
length <= 10

Status of the holiday

Default: null

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

Examples

localHolidayUpdateMessage
Payload
{ "holidayList": [ { "holidayDto": { "branchCode": null, "year": null, "month": null, "date": null, "status": null } } ] }
This example has been generated automatically.

Messages

#1 Accounting Transaction Event AccountingTransactionPublishEvent

Accounting Transaction Event

Payload AccountingTransactionEvent
object
AccountingTransactionEntries
array<object>
AccountingTransactionEntry
object
eaRefNo
string
length <= 20

External Accounting Reference Number

Default: null
txnRefNo
string
length <= 20

Transaction Reference Number

Default: null
source
string
length <= 15

Source which is sending the transaction

Default: null
event
string
length <= 4

Transaction Event

Default: null
eventSrNo
string

Event Serial Number

Default: null
glPostingDate
string
length <= 10

Transaction Posting Date

Default: null
txnInitDate
string
length <= 10

Transaction Initialization Date

Default: null
externalMaker
string
length <= 320

User who has created the transaction

Default: null
externalChecker
string
length <= 320

User who has authorized the transaction

Default: null
txnBranch
string
length <= 6

Transaction Branch from which Transaction is initiated

Default: null
referralAllowed
string
Default: null
suppressAccOverridesUptoSeverityLevel
integer
Default: null
suppressBalanceOverridesUptoSeverityLevel
integer
Default: null
deferredResponse
boolean
length <= 1
Default: null
maker
string
length <= 320

User who has Initiated the transaction

Default: null
checker
string
length <= 320

User who has authorized the transaction

Default: null
createdTimestamp
string
length <= 26

Timestamp when the transaction is created

Default: null
updatedTimestamp
string
length <= 26

Timestamp when the transaction is updated

Default: null
authStatus
string
Default: null
Enum: "U" "A" "R"
txnStatus
string
Default: null
operation
string
length <= 5
Default: null
originalSource
string
length <= 15

Source where the trasaction is originated

Default: null
balancedEntry
boolean
length <= 1

Indicates the Account Transaction being Posted is balanced and should be verifed i.e. sum of credits = sum of debits

Default: null
AccountingTransactionDetailsEntries
array<object>
AccountingTransactionDetailsEntry
object
accNo
string
length <= 34

Account Number

Default: null
accBranch
string
length <= 6

Branch associated with the Account

Default: null
accCcy
string
length <= 3

Account Currency

Default: null
eaRefNo
string
length <= 20

External Accounting Reference Number

Default: null
txnRefNo
string
length <= 20

Transaction Reference Number

Default: null
source
string
length <= 15

Source which is sending the transaction

Default: null
blockRefNo
string
length <= 20

Amount block reference number associated with the transaction

Default: null
accountingRefNo
string
length <= 20

Uniquely generated reference number to Identify each transaction

Default: null
accountCcyAmt
string

Transaction Amount in Account Currency

Default: null
branchLcyAmt
string

Transaction Amount in Transaction Branch Currency

Default: null
exchRate
string

Exchange Rate

Default: null
valueDate
string
length <= 10

Value Date of the Transaction

Default: null
glPostingDate
string
length <= 10

Transaction Posting Date

Default: null
instrumentCode
string
length <= 20

Instrument Code associated with the Transaction

Default: null

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

#2 CustomerStatusUpdateEvent CustomerStatusUpdateEvent

CustomerStatusUpdateEvent

Payload CustomerStatusUpdateEvent
object
referenceIds
array<object>
ReferenceId
object
referenceId
string

Reference ID

Default: null

Additional properties are allowed.

Additional items are allowed.

referenceType
string

Type of the reference

Default: null
branchCode
string

Branch Code

Default: null
event
string

Event associated with the customer status update

Default: null

Additional properties are allowed.

#3 localHolidayUpdateMessage localHolidayUpdateMessage

localHolidayUpdateMessage

Payload LocalHolidayUpdateMessage
object
holidayList
array<object>
holidayDto
object
branchCode
string
length <= 10

Branch Code

Default: null
year
string
length <= 4

Year of the holiday

Default: null
month
string
length <= 20

Month of the holiday

Default: null
date
string
length <= 10

Date of the holiday

Default: null
status
string
length <= 10

Status of the holiday

Default: null

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.