Query collection account balance

Query balance for a collection account

Query balance for a collection account

POST https://api-fsdh360-test.fsdhgroup.com/api/v1/virtualaccounts/static/collectionaccount/balance

To query collection account balance, the below parameters should be provided.

Attention should be given to parameters marked *required.

Query Parameters

Name	Type	Description
API-version	String	Version of API

Request Body

Name	Type	Description
Account number *	String	Clients account number

200: OK Success

{
  "availableBalance": 0,
  "ledgerBalance": 0
}

400: Bad Request Bad request

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404: Not Found Not found

500: Internal Server Error Internal server error

Request body

{
  "accountNumber": "string"
}

Curl and Request URL

Server response

Response body

Inputting the correct parameters should give you a 200: Success response which will populate the below Success details. Also specified are possible responses from the request.

200: Success

{
  "availableBalance": 0,
  "ledgerBalance": 0
}

400: Bad Request

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404: Internal Server Error

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}