Jump to

• Request
• Response

Service API that gets valid value dated balances details and sweep eligible balance for the specified virtual account and value date

post

/service/sweepandvaluedatedbalance

This endpoint is used to get Sweep Eligible balance for a virtual account. Sweep Eligible balance is account's own balance without accounting child's contributions, unauth debits and blocked amount

Request

Supported Media Types

• application/json

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request Body that contains data required for fetching Balance for Virtual Accounts

Root Schema : SweepAndVDBalanceServiceRequestDtoList

Type: object

Show Source

• sweepandVDBalanceServiceRequestDto(optional): array sweepandVDBalanceServiceRequestDto

{
    "type":"object",
    "properties":{
        "sweepandVDBalanceServiceRequestDto":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SweepAndVDBalanceServiceRequestDto"
            }
        }
    }
}

Nested Schema : sweepandVDBalanceServiceRequestDto

Type: array

Show Source

• Array of: object SweepAndVDBalanceServiceRequestDto

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

Nested Schema : SweepAndVDBalanceServiceRequestDto

Type: object

Show Source

• valueDate(optional): string
• virtalAccountNumber(optional): string

{
    "type":"object",
    "properties":{
        "virtalAccountNumber":{
            "type":"string"
        },
        "valueDate":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : SweepandVDBalanceServiceWrapperDTO

Type: object

Show Source

• data(optional): array data
• messages(optional): object SweepandVDBalanceServiceResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/SweepandVDBalanceServiceResponseDto"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SweepVDBalanceDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object SweepVDBalanceDTO

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

Nested Schema : SweepandVDBalanceServiceResponseDto

Type: object

Show Source

• codes(optional): array codes
• status(optional): string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SweepandVDBalanceServiceResponseCode"
            }
        }
    }
}

Nested Schema : SweepVDBalanceDTO

Type: object

Show Source

• sweepEligibleBalance(optional): number
  Sweep Eligible balance for a virtual account is account's own balance without accounting child's contributions, unauth debits and blocked amount
• valuedate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Value date for which value dated balance is being fetched
• valueDatedBalance(optional): number
  Value dated balance for the date speficied
• virtualAccountCcy(optional): string
  Maximum Length: 3

  Currency of the virtual account number
• virtualAccountNumber(optional): string
  Virtual account number for which balance has to be fetched

{
    "type":"object",
    "properties":{
        "virtualAccountNumber":{
            "type":"string",
            "description":"Virtual account number for which balance has to be fetched"
        },
        "virtualAccountCcy":{
            "type":"string",
            "maxLength":3,
            "description":"Currency of the virtual account number"
        },
        "valuedate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Value date for which value dated balance is being fetched"
        },
        "valueDatedBalance":{
            "type":"number",
            "description":"Value dated balance for the date speficied"
        },
        "sweepEligibleBalance":{
            "type":"number",
            "description":"Sweep Eligible balance for a virtual account is account's own balance without accounting child's contributions, unauth debits and blocked amount"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object SweepandVDBalanceServiceResponseCode

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

Nested Schema : SweepandVDBalanceServiceResponseCode

Type: object

Show Source

• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

204 Response

NO CONTENT. No records found

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.

Back to Top