Read Collection Balance

The readCollectionBalance API is used to read the collection balance of a payer in OCS.io.

API Overview

Parameters Required for Reading Collection Balance

The following table lists and describes the parameters required to read the collection balance through the readCollectionBalance API:

Parameter Description

refId

Ref ID of the Account

externalId

External ID of the Account

calculationForced

Indicates whether Collection Balance calculation is forced.
Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when reading the collection balance:

  • Account must be provided in the request, it must be already created in the system and must not be in Deactivated State.

  • Payer must be already created in the system.

Read Collection Balance Example

Here is a cURL example for the readCollectionBalance API:

curl -X GET 'https://api.ocs.io/v1/rm/payer/read-collection-balance?externalId=<account_external_id>&calculationForced=true'

The outcome of the API call is as follows:

  • The collection balance of the account with external ID <account_external_id> is retrieved.

  • If calculationForced is set to true, the collection balance calculation is forced.