Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml
• text/csv

201 Response

Returns Success or failure messages.

Headers

• Location: string

Body ()

Root Schema : TxnUtilizationServiceCollection

Type: object

Collection of Transaction Utilization.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of Transaction Utilization.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TxnUtilizationServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object TxnUtilizationServiceDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TxnUtilizationServiceDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : TxnUtilizationServiceDTO

Type: object

Match All

Show Source

• object TxnUtilizationServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "virtualAccountNo":{
                    "type":"string",
                    "description":"Virtual Account Number"
                },
                "limitCode":{
                    "type":"string",
                    "description":"Limit Code attached to the Virtual Account"
                },
                "limitDescription":{
                    "type":"string",
                    "description":"Limit Code Description"
                },
                "restrictionId":{
                    "type":"string",
                    "description":"Restriction ID belonging to the attached Limit Code"
                },
                "restrictionDescription":{
                    "type":"string",
                    "description":"Restriction ID Description"
                },
                "startDate":{
                    "type":"string",
                    "description":"Date from which the restriction is applicable"
                },
                "endDate":{
                    "type":"string",
                    "description":"Date on which the restriction expires"
                },
                "totalCount":{
                    "type":"number",
                    "description":"Total count of transactions that are allowed for the restriction"
                },
                "utilizedCount":{
                    "type":"number",
                    "description":"Count of transactions already performed on this Virtual Account for the restriction"
                }
            },
            "required":[
                "virtualAccountNo"
            ]
        }
    ]
}

Nested Schema : TxnUtilizationServiceDTO-allOf[0]

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual Account Number"
        },
        "limitCode":{
            "type":"string",
            "description":"Limit Code attached to the Virtual Account"
        },
        "limitDescription":{
            "type":"string",
            "description":"Limit Code Description"
        },
        "restrictionId":{
            "type":"string",
            "description":"Restriction ID belonging to the attached Limit Code"
        },
        "restrictionDescription":{
            "type":"string",
            "description":"Restriction ID Description"
        },
        "startDate":{
            "type":"string",
            "description":"Date from which the restriction is applicable"
        },
        "endDate":{
            "type":"string",
            "description":"Date on which the restriction expires"
        },
        "totalCount":{
            "type":"number",
            "description":"Total count of transactions that are allowed for the restriction"
        },
        "utilizedCount":{
            "type":"number",
            "description":"Count of transactions already performed on this Virtual Account for the restriction"
        }
    },
    "required":[
        "virtualAccountNo"
    ]
}

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

Back to Top