Gets the Transaction Utilization for a Virtual Account
get
/service/accountTxnUtil
This endpoint is used to get the list of restrictions attached to a Virtual Account along with the total and utilized counts for those restrictions.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
limit(optional): integer
Fetches the maximum limit of the record.
-
offset(optional): integer
Fetches the starting number of the offset.
-
virtualAccountNo: string
Virtual Account for which the Transaction Utilization is to be retrieved.
Header Parameters
-
sourceCode: string
Source from which request is initiated
Response
Supported Media Types
- application/json
- application/xml
- text/csv
201 Response
Returns Success or failure messages.
Headers
Root Schema : TxnUtilizationServiceCollection
Type:
object
Collection of Transaction Utilization.
Show Source
Nested Schema : TxnUtilizationServiceDTO-allOf[0]
Type:
Show Source
object
-
endDate(optional):
string
Date on which the restriction expires
-
limitCode(optional):
string
Limit Code attached to the Virtual Account
-
limitDescription(optional):
string
Limit Code Description
-
restrictionDescription(optional):
string
Restriction ID Description
-
restrictionId(optional):
string
Restriction ID belonging to the attached Limit Code
-
startDate(optional):
string
Date from which the restriction is applicable
-
totalCount(optional):
number
Total count of transactions that are allowed for the restriction
-
utilizedCount(optional):
number
Count of transactions already performed on this Virtual Account for the restriction
-
virtualAccountNo:
string
Virtual Account Number
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
Invalid input, method is not allowed
500 Response
Internal server error