Get Group Codes

This API retrieves a list of group codes associated with a specific client. This data is essential for tracking virtual account groups and managing associated financial activities.

Request Parameters

Path Parameter:

Field Name	Data Type	Required	Description
clientId	integer	true	The unique identifier for the client.

Response Body

The response is a JSON array of group code objects. Each object includes the following fields:

Field Name	Data Type	Description
clientId	integer	Unique identifier of the client.
productId	integer	Identifier for the associated product (0 if not applicable).
type	string	The type of the group (e.g., "Normal").
balance	number	The current balance of the group account.
accountId	string	Identifier of the account associated with the group.
groupCode	string	A unique code representing the group.
description	string	A brief description of the group (e.g., "BuyPower Virtual Accounts Group").
enforceExternalId	string	A flag indicating external ID enforcement (typically "0").
lastTransDate	string	Timestamp of the last transaction for the group (ISO 8601 format).
subLedgerType	string	Code representing the sub-ledger type.
createdOn	string	Timestamp when the group code was created (ISO 8601 format).

Responses

🟢200Group Codes

application/json

Body

Example

[
    {
        "clientId": 2,
        "productId": 0,
        "type": "Normal",
        "balance": 1101,
        "accountId": "2",
        "groupCode": "VKRS4HQ5VD",
        "description": "BuyPower Virtual Accounts Group",
        "enforceExternalId": "0",
        "lastTransDate": "2024-04-30T16:06:53.000Z",
        "subLedgerType": "2",
        "createdOn": "2024-02-02T22:08:26.000Z"
    },
    {
        "clientId": 2,
        "productId": 0,
        "type": "Normal",
        "balance": 0,
        "accountId": "532",
        "groupCode": "HP51HEQO4G",
        "description": "Jumia Pay App 2",
        "enforceExternalId": "0",
        "lastTransDate": "2024-06-26T13:33:37.000Z",
        "subLedgerType": "2",
        "createdOn": "2024-06-26T12:33:37.000Z"
    },
    {
        "clientId": 2,
        "productId": 0,
        "type": "Normal",
        "balance": 0,
        "accountId": "531",
        "groupCode": "24JRD25EPC",
        "description": "Jumia Pay App",
        "enforceExternalId": "0",
        "lastTransDate": "2024-06-26T13:07:55.000Z",
        "subLedgerType": "2",
        "createdOn": "2024-06-26T12:07:55.000Z"
    }
]

Request Parameters#

Response Body#

Request

Request samples

Responses

Request Parameters

Response Body