External Till Service Reversal
post
/api-gateway/obremo-srv-branch-teller-services/obremo-srv-branch-teller-services/ob/obbrn/branchteller/v1/tillServiceReversal
External Transaction Till update Reversal request for same day performed transactions
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
Authorization(required): string
Indicates authorization token generated for the User ID mentioned above
-
appId(required): string
Indicates a unique code to identify the application sub-domain. The value to be passed for this service as: SRVBRNTLR
-
authToken: string
Indicates whether authtoken is enabled or not
-
branchCode(required): 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
-
entityId(required): string
Information related to Entity id should be sent as part of request
-
multiEntityAdmin(required): string
Indicates multiEntityAdmin is enabled or not
-
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(required): 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 any external till update reversal transaction
Root Schema : ExternalTransactionReversal
Type:
Show Source
object-
customFlds:
array customFlds
-
extRefNo:
string
Source Reference number for the transaction for which the Reversal to be Done
-
functionCode:
string
Function Code of the transaction for which the Reversal to be Done
-
subScreenClass:
string
Sub screen class code of the transaction for which the Reversal to be Done
-
txnRefNo:
string
Reference number for the transaction for which the Reversal to be Done
Nested Schema : customObj
Type:
objectResponse
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of succes or failure.
Root Schema : ExternalTransactionResponseModel
Type:
Show Source
object-
data:
object data
Response Data Received
-
errors:
object errors
Error list to diaplay all the Errors
-
informations:
object informations
Information list to Display all Information Messages
-
paging:
object paging
Page number Information based on the size of the Data
-
warnings:
object warnings
Warnings list to Display all Warnings
Nested Schema : data
Type:
objectResponse Data Received
Nested Schema : errors
Type:
objectError list to diaplay all the Errors
Nested Schema : informations
Type:
objectInformation list to Display all Information Messages
Nested Schema : paging
Type:
objectPage number Information based on the size of the Data
Nested Schema : warnings
Type:
objectWarnings list to Display all Warnings
400 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.