Jump to

• Request
• Response

Get all valid value dated balances for the specified account

post

/balanceFetch/getVDBalance

This endpoint is used to get all the valid value date balances for the specified account and date combinations.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for fetching balances of the speficied accounts

Root Schema : VDBalanceRequestDTO

Type: object

Show Source

• accNumber(optional): string
• accountRequestDetails(optional): array accountRequestDetails
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• externalSystemId(optional): string
• headerBrancRef(optional): string
• interfaceMasterId(optional): string
• isSimulation(optional): string
• methodName(optional): string
• refNo(optional): string
• reqXml(optional): string
• source(optional): string
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}
• txnId(optional): string

{
    "type":"object",
    "properties":{
        "refNo":{
            "type":"string",
            "description":""
        },
        "accNumber":{
            "type":"string",
            "description":""
        },
        "isSimulation":{
            "type":"string",
            "description":""
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "source":{
            "type":"string",
            "description":""
        },
        "interfaceMasterId":{
            "type":"string",
            "description":""
        },
        "externalSystemId":{
            "type":"string",
            "description":""
        },
        "methodName":{
            "type":"string",
            "description":""
        },
        "txnId":{
            "type":"string",
            "description":""
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "headerBrancRef":{
            "type":"string",
            "description":""
        },
        "reqXml":{
            "type":"string",
            "description":""
        },
        "accountRequestDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VDBalanceRequestDetailsDTO"
            }
        }
    }
}

Nested Schema : accountRequestDetails

Type: array

Show Source

• Array of: object VDBalanceRequestDetailsDTO

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

Nested Schema : VDBalanceRequestDetailsDTO

Type: object

Show Source

• accountNumber: string
• balanceType(optional): string
• branchCode: string
• currencyCode: string
• external(optional): boolean
• externalSystemId(optional): string
• simAccountNumber(optional): string
• valueDate: string
  From date for which value dated balance is being fetched

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "currencyCode":{
            "type":"string",
            "description":""
        },
        "valueDate":{
            "type":"string",
            "description":"From date for which value dated balance is being fetched"
        },
        "balanceType":{
            "type":"string",
            "description":""
        },
        "external":{
            "type":"boolean",
            "description":""
        },
        "simAccountNumber":{
            "type":"string",
            "description":""
        },
        "externalSystemId":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "accountNumber",
        "branchCode",
        "currencyCode",
        "valueDate"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : VDBalanceDTO

Type: object

Show Source

• valueDatedBalanceDetails(optional): array valueDatedBalanceDetails

{
    "type":"object",
    "properties":{
        "valueDatedBalanceDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VDBalanceDetailsDTO"
            }
        }
    }
}

Nested Schema : valueDatedBalanceDetails

Type: array

Show Source

• Array of: object VDBalanceDetailsDTO

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

Nested Schema : VDBalanceDetailsDTO

Type: object

Show Source

• accountNumber(optional): string
  account number for which balance has to be fetched
• availableBalance(optional): number
  Value dated balance for the date speficied
• branchCode(optional): string
• currencyCode(optional): string
  Maximum Length: 3

  Currency of the account number
• icBalance(optional): number
• valueDate(optional): string
  Value date for which value dated balance is being fetched
• valueDatedBalance(optional): number
  Value dated balance for the date speficied

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string",
            "description":"account number for which balance has to be fetched"
        },
        "currencyCode":{
            "type":"string",
            "maxLength":3,
            "description":"Currency of the account number"
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "valueDate":{
            "type":"string",
            "description":"Value date for which value dated balance is being fetched"
        },
        "valueDatedBalance":{
            "type":"number",
            "description":"Value dated balance for the date speficied"
        },
        "icBalance":{
            "type":"number",
            "description":""
        },
        "availableBalance":{
            "type":"number",
            "description":"Value dated balance for the date speficied"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top