Dynamic collection account balance

Query balance for collection account

Query balance for a collection account

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

To retrieve account balance for a collection account 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	Client's 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

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

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: Not Found

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-91c82e973fbcf54b87d54a3e5408b760-295382d932e2fd48-00"
}s

500: Internal Server Error

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
  "title": "An error occurred while processing your request.",
  "status": 500,
  "traceId": "00-0cb6212be57bd64c8b036f5190557edf-a5e21ee317c93742-00"
}