Misc Credit API
post
/api-gateway/obremo-srv-branch-teller-services/obremo-srv-branch-teller-services/ob/obbrn/branchteller/v1/externalMiscGLRequest
External API to perform Miscellaneous General Ledger Credit transaction
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
Indicates a unique code to identify the application sub-domain. The value to be passed for this service as: SRVBRNTLR
-
authToken: string
Indicates the authorization token generated for the User ID mentioned above.
-
branchCode: string
Indicates the application branch in which the operation is being initiated. The User ID used should have appropriate roles/rights to perform the action/operation in the given Branch.
-
branchDate: string
Indicates the date of the application branch in which the operation is being initiated.
-
contentType: string
Indicates the media type of the resource being sent in the HTTP message body. This specifies the kind of data being sent by the server or the client. The value to be passed for this service as: application/json
-
sourceCode(required): string
Indicates the source system from where the operation is being initiated.
-
tenantId: string
Indicates the Tenent ID on the SaaS Deployment.
-
userId: string
Indicates the application User ID which will be used to initiate the operation. This User ID will be stored for audit purpose in the application against the operation. The User ID used here should have the appropriate roles/rights to perform the operation/action.
Request Body that contains data required for creating a Miscellaneous General Ledger Credit Request
Root Schema : MiscGlCreditData
Type:
objectUser Misc GL Credit Request
Show Source
-
addDtls:
object AdditionalTransactionDetails
Additional Configuration Master Model
-
dataPayload:
object dataPayload
-
demDtls:
array demDtls
-
extSysDtls:
object ExtSysDtls
External System Details
-
miscGlCreditTransaction:
object ExtMiscGlCreditRequest
GL Credit Request
-
sourceCode:
string
Indicates the source system from where the operation is being initiated
-
sourceRefNo:
string
Indicates the Reference Number of the source system from where the operation is being initiated
-
txnDtls:
object TransactionDetails
Transaction Master Model
Nested Schema : AdditionalTransactionDetails
Type:
objectAdditional Configuration Master Model
Show Source
-
adviceName:
string
Advice Name
-
cashInOutIndicator:
string
Cash In/Out Indicator Possible Values I,O, IO (FX case)
-
crossCcyEnabled:
string
crossCcyEnabled Indicator Possible Values N,Y
-
ejLoggingRequired:
string
Teller Sq required/logged Default Value Y Possible Values Y-Yes, N-No
-
ejTxnAmtMapping:
string
EJ TXN Amount Mapping Possible Values FROM or TO
-
ejTxnCcyMapping:
string
EJ TXN Currency Mapping Possible Values FROM or TO
-
email:
string
email of the Customer Involved in the Transaction
-
hostMultiTripId:
string
Unique ID to identify the Trips with Host
-
hostStatus:
string
Host Status during Transaction
-
ignoreApproval:
boolean
Default Value:
falseignore approval or not -
ignoreWarning:
boolean
Default Value:
falseignore warning or not -
isAdvice:
string
Default Value:
Nis advice generation required or not -
isExternal:
boolean
Default Value:
falseIs External call -
isFetchAccImages:
string
isFetchAccImages Indicator Possible Values N,Y
-
isNewChargesEnabled:
string
isNewChargesEnabled Indicator Possible Values N,Y
-
isObpayApproval:
string
Default Value:
Yis it obpay approval -
isObpayReversalApproval:
string
Default Value:
Nis it reversal obpay approval -
isReversal:
string
Default Value:
Nis it reversal -
isReversalAdvice:
string
Default Value:
Nis reversal advice generation required or not -
isTotChargesReq:
string
isTotChargesReq Indicator Possible Values N,Y
-
mandatorySignatureFlag:
string
Mandatory Signature Flag
-
mobile:
string
Mobile number of the Customer Involved in the Transaction
-
orchestratorId:
string
Orchestrator Id
-
ovdDefault:
boolean
Default Value:
falseOverride Default -
paymentAccount:
string
Payment Account
-
reversalButton:
string
Default Value:
NReversal button -
rsp:
string
Reversal Supported Possible Values Y-Yes, N-No
-
signatureVerifyIndicator:
string
Indiactes if Signature Verification is Needed for the Transaction
-
tillUpdate:
boolean
Default Value:
trueTill Update -
txnBranchCcy:
string
Currency of the Branch in which Transaction is Done
-
txnBranchCode:
string
Branch Code in which Transaction is Done
-
txnBranchDate:
string(date)
Date of the Branch in which Transaction is Done
-
txnDate:
string
Branch Date in which transaction has happened
-
txnType:
string
Type of the Transaction That is Done
Nested Schema : dataPayload
Type:
objectNested Schema : ExtSysDtls
Type:
objectExternal System Details
Match All
External System Details
Show Source
Nested Schema : ExtMiscGlCreditRequest
Type:
objectGL Credit Request
Match All
GL Credit Request
Show Source
Nested Schema : TransactionDetails
Type:
objectTransaction Master Model
Show Source
-
accountType:
string
Account Type of the Account involved in the Transaction
-
assignmentMode:
string
Assigment Mode of the Request
-
authoriserComments:
string
Authoriser Comments to be Captured for the Transaction
-
eventCode:
string
Event Code to identify the Events occuring in the Transaction
-
functionCode:
string
Unique Function Code to Identify the Type of Transaction
-
inflowAmt:
number
Inflow Amount
-
inflowCcy:
string
Inflow Currency received in which the transaction is Done
-
multiAuthResponseFlag:
string
multiAuth Authorizer approval status flag
-
onlineOfflineTxn:
string
Offline Support Default Value N No
-
outflowAmt:
number
Outflow Amount
-
outflowCcy:
string
Outflow Currency paid out for the Transaction Done
-
overrideConfirmFlag:
string
Identifies if the Overrides are confirmwed by the User
-
requestStatus:
string
Status of the Request Received
-
ruleSuccessFlag:
string
Default Value:
NRuleBased authorisation success flag -
sourceRefNumber:
string
Unique Reference number Generated by External System
-
subScreenClass:
string
Identifies the type of business process under a function Id
-
supervisorId:
string
Unique Supervisor Id for Approval
-
tellerSeqNumber:
string
Teller Sequence Number generated during the transaction
-
tvOpen:
string
Default Value:
Nflag for till Vault Open Screen -
txnAmount:
string
Amount for which the transaction is Processes
-
txnBranchCcy:
string
Currency of the Branch in which transaction has happened
-
txnBranchCode:
string
Branch Code in which transaction has happened
-
txnBranchDate:
string(date)
Date of the Branch in which transaction has happened
-
txnCcy:
string
Currency in which Transaction is Happening
-
txnId:
string
Unique Transaction ID of the Request
-
txnRefNumber:
string
Branch Transaction Reference Number for the request
-
userComments:
string
User Comments to be captured for the transaction
-
vamApplicable:
string
Default Value:
NVam account or not
Nested Schema : DenomTxnDtlsModel
Type:
Show Source
object-
denomCode(required):
string
Denomination Code that Identifies Each diffrent Denomination That is used in the Bank
-
denomCodeValue(required):
string
Value for each Denomination Code That is used in the Bank
-
denomType(required):
string
Type of Denomination That is used in the Bank
-
inOutIndicator(required):
string
InOut Indicator for Each Denomination
-
parentId:
string
Parent ID for the Transaction
-
recordId:
string
Unique Record Id for the Transaction
-
tellerId:
string
User ID of the User doing the Transaction
-
units(required):
number
No of Units for Each Denomination code
-
value(required):
number
Value of the Denomination for Each Denomination Code
Nested Schema : ExtSysDtls-allOf[0]
Type:
Show Source
object-
sourceCode:
string
Indicates the source system from where the operation is being initiated
-
sourceRefNo:
string
Indicates the transaction source reference number of the Source System from Where the Operation is being initiated
-
sourceRole:
string
This column contains the Role that needs to be used for processing a transaction
-
stationId:
string
Indicates the station id
-
txnBranch:
string
Branch Code in which transaction has happened
Nested Schema : ExtMiscGlCreditRequest-allOf[0]
Type:
Show Source
object-
chequeDate:
string(date)
Cheque date of the cheque leaf
-
chequeNumber:
string
Cheque Number on the cheque leaf
-
emailId:
string
Email id of customer during the transaction is stored here
-
exchangeRate:
number
Exchange rate used for the transaction for the main leg
-
fromAccountAmt:
number
Transaction Amount for which the transaction is done
-
fromAccountBranch:
string
Account Branch from which the Transaction is Done
-
fromAccountCcy:
string
Account Currency in which the Transaction is Done
-
fromAccountNumber:
string
Account Number from which the Transaction is done
-
mobileNumber:
string
Mobile Number of customer during the transaction is stored here
-
narrative:
string
Teller comment provided during the transaction
-
netAccountAmt:
number
Net Account Amount
-
netAccountCcy:
string
Net Account Currency
-
originalExchangeRate:
number
Exchange Rate fetched by system. This is the value prior to amendment by teller
-
tellerSeqNumber:
string
Teller Sequence Number generated during the transaction
-
toAccountAmt:
number
Amount that is posted to the Account
-
toAccountBranch:
string
Account Branch to which the transaction is done
-
toAccountCcy:
string
Account Currency to which the transaction is done
-
toAccountNumber:
string
Account Number to which the transaction is done
-
totalCharges:
number
Total charges for the transaction
-
txnBranchCode:
string
Branch Code in which transaction
-
txnCustomer:
string
Customer of the Account That is part of the transaction
-
txnDate:
string(date)
Branch Date in which transaction has happened
-
txnRefNumber:
string
Branch Transaction Reference Number for the request
-
uniqueIdentifierNumber:
string
Unique Identifier Number
-
uniqueIdentifierType:
string
Unique Identifier Type
-
userRefNumber:
string
User Reference Number
-
valueDate:
string(date)
Value Date of the Transaction
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of succes or failure
Headers
-
Location: string
URL of newly created Miscellaneous General Ledger Credit request
Nested Schema : data
Type:
objectNested Schema : items
Type:
object400 Response
Bad request error, the server is unable to process the request.
401 Response
Unauthorized request error, invalid credentials.
403 Response
Request denied, no permission to access the request.
405 Response
Request denied, invalid input.
500 Response
Internal server error.