Get Collection Accounts

This API retrieves a list of all collection accounts associated with a specified clientId. The accounts may include Normal, Utility, and Invoice collection types.

Path Parameter

Field Name	Type	Required	Description
clientId	string	true	The unique identifier of a client (merchant)

Response Body

Field Name	Type	Description
`normal`	object	Contains details of the normal collection account.
`normal.name`	string	The name of the normal collection account.
`normal.balance`	decimal	The total balance available in the normal collection account.
`normal.availableBalance`	decimal	The balance that is available for transactions.
`normal.blockedAmount`	decimal	The amount that is currently blocked and not available for transactions.
`normal.mainLedger`	boolean	Indicates whether the account is a main ledger account (`true` or `false`).
`normal.bvn`	string	The Bank Verification Number (BVN) associated with the account.
`normal.groupCode`	string	The unique identifier for the account's group.
`normal.accountID`	string	The unique account identifier.

Field Name	Type	Description
`utility`	object	Contains details of the utility collection account.
`utility.name`	string	The name of the utility collection account.
`utility.balance`	decimal	The total balance available in the utility collection account.
`utility.availableBalance`	decimal	The balance that is available for transactions.
`utility.blockedAmount`	decimal	The amount that is currently blocked and not available for transactions.
`utility.mainLedger`	boolean	Indicates whether the account is a main ledger account (`true` or `false`).
`utility.bvn`	string	The Bank Verification Number (BVN) associated with the account.
`utility.groupCode`	string	The unique identifier for the account's group.
`utility.accountID`	string	The unique account identifier.

Field Name	Type	Description
`invoice`	object	Contains details of the invoice collection account.
`invoice.name`	string	The name of the invoice collection account.
`invoice.balance`	decimal	The total balance available in the invoice collection account.
`invoice.availableBalance`	decimal	The balance that is available for transactions.
`invoice.blockedAmount`	decimal	The amount that is currently blocked and not available for transactions.
`invoice.mainLedger`	boolean	Indicates whether the account is a main ledger account (`true` or `false`).
`invoice.bvn`	string	The Bank Verification Number (BVN) associated with the account.
`invoice.groupCode`	string	The unique identifier for the account's group.
`invoice.accountID`	string	The unique account identifier.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Response

application/json

Bodyapplication/json

Example

{
  "normal": {
    "name": "Sample Customer",
    "balance": 0,
    "availableBalance": 0,
    "blockedAmount": 0,
    "mainLedger": false,
    "bvn": "2575094",
    "groupCode": "ER3GZR04KR",
    "accountID": "0195300214"
  },
  "utility": {
    "name": "Sample Customer",
    "balance": 0,
    "availableBalance": 0,
    "blockedAmount": 0,
    "mainLedger": false,
    "bvn": "98773489631",
    "groupCode": "0000000127",
    "accountID": "1413817920"
  },
  "invoice": {
    "name": "Sample Customer",
    "balance": 0,
    "availableBalance": 0,
    "blockedAmount": 0,
    "mainLedger": false,
    "bvn": "375938",
    "groupCode": "0000000086",
    "accountID": "7348756628"
  }
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Path Parameter

Response Body

Request

Request Code Samples

Responses

Get Collection Accounts

Path Parameter#

Response Body#

Request

Request Code Samples

Responses

Path Parameter

Response Body