Create Group Code

This API enables you to create a new group code for a client, which is essential for organizing and managing client accounts under a specific group. This functionality is vital for structuring client data and streamlining subsequent transactions and reporting.

Request Body

The request body is a JSON object with the following fields:

Field Name	Data Type	Required	Description
`clientId`	integer	true	Unique identifier for the client.
`type`	string	true	The type of the group code (e.g., "Normal").
`description`	string	true	A brief description of the group code.
`productId`	integer	true	Unique identifier for the associated product.
`customerNuban`	boolean	true	Indicates whether a custom NUBAN should be enforced.

Response Body

The response is a JSON object containing the details of the created group code.

Field Name	Data Type	Description
`clientId`	integer	Unique identifier for the client.
`type`	string	The type of the group code (e.g., "Normal").
`description`	string	A brief description of the group code.
`productId`	integer	Unique identifier for the associated product.
`customerNuban`	boolean	Indicates whether a custom NUBAN was enforced.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

Example

{
    "clientId": 2,
    "productId": 101,
    "type": "Normal",
    "groupCode": "24JRD25EPC",
    "description": "Jumia Pay App",
    "enforceExternalId": false
}

Request Body#

Response Body#

Request

Request samples

Responses

Request Body

Response Body