- Introduction
- Terminologies
- Webhooks
- Authentication
- Account
- KYC
- Transaction
- Transfer
- Reporting
Get Report Parameters
GET
/core/reporting/parameters/{reportTypeId}
Request Parameters#
| Field Name | Type | Description |
|---|---|---|
reportTypeId | integer | The unique identifier of the report type for which parameters are being retrieved. |
Response Fields#
| Field Name | Description |
|---|---|
id | The unique identifier of the report parameter. |
name | The name of the report parameter. |
parameterType | The type of the parameter (e.g., DATE, ARRAY, MULTISELECT_ARRAY, TEXT). |
order | The sequence in which the parameter should be displayed. |
required | Indicates whether the parameter is mandatory (true) or optional (false). |
options | A list of selectable values for type ARRAY or MULTISELECT_ARRAY parameters. |
Request
Path Params
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/core/reporting/parameters/1'Responses
🟢200Success
application/json
Body
Example
[
{
"id": 8,
"name": "START DATE",
"parameterType": "DATE",
"order": 1,
"required": true,
"options": []
},
{
"id": 9,
"name": "END DATE",
"parameterType": "DATE",
"order": 2,
"required": true,
"options": []
},
{
"id": 10,
"name": "TRANSACTION TYPE",
"parameterType": "ARRAY",
"order": 3,
"required": true,
"options": [
"INWARD",
"OUTWARD",
"ALL"
]
},
{
"id": 11,
"name": "TRANSACTION STATUS",
"parameterType": "ARRAY",
"order": 4,
"required": true,
"options": [
"CONFIRMED",
"UNRESOLVED",
"SENT_TO_GATEWAY_SUCCESS",
"SENT_TO_GATEWAY_ERROR",
"PENDING",
"ALL"
]
},
{
"id": 12,
"name": "CLIENTS",
"parameterType": "MULTISELECT_ARRAY",
"order": 5,
"required": false,
"options": [
{
"id": 1,
"name": "Mohammed Olateju"
},
{
"id": 2,
"name": "akin dami"
},
{
"id": 3,
"name": "abc"
},
{
"id": 4,
"name": "Test Merchant 1"
},
{
"id": 5,
"name": "monday street"
},
{
"id": 6,
"name": "tuesday street"
},
{
"id": 7,
"name": "Mohammed Olateju"
},
{
"id": 9,
"name": "ABS Test"
},
{
"id": 10,
"name": "Abiyo Katonda Dauda"
},
{
"id": 11,
"name": "Bala Ame Abubakar"
},
{
"id": 12,
"name": "Grace Dariya Garba"
},
{
"id": 13,
"name": "Hannatu Gideon Akpasu"
},
{
"id": 14,
"name": "Chibuisi Isaac Onuoha"
},
{
"id": 15,
"name": "Jatau Solomon"
},
{
"id": 16,
"name": "Joe Leo"
},
{
"id": 17,
"name": "Seyi Zee"
},
{
"id": 18,
"name": "Zee Seye"
},
{
"id": 19,
"name": "Vic Salem"
},
{
"id": 20,
"name": "ZainVic"
},
{
"id": 21,
"name": "Fortune Odesanya"
},
{
"id": 22,
"name": "abc"
},
{
"id": 23,
"name": "Joe Leo"
},
{
"id": 24,
"name": "Shakir Kamal"
},
{
"id": 25,
"name": "Damilola Ola"
},
{
"id": 26,
"name": "Shakir Kamal"
},
{
"id": 27,
"name": "Damilola Ola"
},
{
"id": 29,
"name": "Murazik and Sons"
},
{
"id": 33,
"name": "abc"
},
{
"id": 35,
"name": "Bergnaum - Ruecker"
},
{
"id": 36,
"name": "Rodriguez - Reinger"
},
{
"id": 37,
"name": "BizzBuzz"
},
{
"id": 38,
"name": "abc"
},
{
"id": 39,
"name": "abc"
},
{
"id": 40,
"name": "abc"
},
{
"id": 41,
"name": "abc"
},
{
"id": 42,
"name": "abc"
},
{
"id": 43,
"name": "abc"
},
{
"id": 44,
"name": "abc"
},
{
"id": 45,
"name": "Damilola Ola"
},
{
"id": 46,
"name": "Kola Obasooto"
},
{
"id": 47,
"name": "Abimbola Adelakun"
},
{
"id": 48,
"name": "Akin Abayomi"
},
{
"id": 49,
"name": "MFB Test"
},
{
"id": 50,
"name": "OpateQ Consulting Ltd"
},
{
"id": 51,
"name": "BuyPower"
},
{
"id": 52,
"name": "Seyi Devos"
},
{
"id": 53,
"name": "Tayo Inc"
},
{
"id": 54,
"name": "Seyi Jones"
},
{
"id": 55,
"name": "Shakir Kamal"
},
{
"id": 56,
"name": "ajks,n"
},
{
"id": 57,
"name": "EJKFOEIRORPT"
},
{
"id": 58,
"name": "Marvel & DC"
},
{
"id": 59,
"name": "Damilola Ola"
},
{
"id": 60,
"name": "Test Business"
},
{
"id": 61,
"name": "Shakir Kamal"
},
{
"id": 62,
"name": "Kamal Lekan"
},
{
"id": 63,
"name": "Shakir Kamal"
},
{
"id": 64,
"name": "Shakir Kamal"
},
{
"id": 65,
"name": "Shakir Kamal"
},
{
"id": 66,
"name": "Shakir Kamal"
},
{
"id": 67,
"name": "Martins Alex"
},
{
"id": 68,
"name": "Martins Alex"
},
{
"id": 69,
"name": "abc"
},
{
"id": 70,
"name": "abc"
},
{
"id": 71,
"name": "abc"
},
{
"id": 72,
"name": "abc"
},
{
"id": 75,
"name": "AM,NDF AS,MFNWKL"
},
{
"id": 76,
"name": "Tayo James"
},
{
"id": 77,
"name": "Dammy Ola"
},
{
"id": 78,
"name": "Martins Aguegbodo"
},
{
"id": 79,
"name": "DC Universe"
},
{
"id": 80,
"name": "Dammy Ola"
},
{
"id": 81,
"name": "Marvel Universe"
},
{
"id": 82,
"name": "janedoe"
},
{
"id": 83,
"name": "AbuAbe-1 Ltd"
},
{
"id": 84,
"name": "The Boogie Corp"
},
{
"id": 85,
"name": "endthistest"
},
{
"id": 86,
"name": "Joe Leo"
},
{
"id": 87,
"name": "Adeniji Adewunmi"
},
{
"id": 88,
"name": "kwjdnw"
},
{
"id": 89,
"name": "Martins Alex"
},
{
"id": 90,
"name": "Test Business II"
},
{
"id": 91,
"name": "Dele John"
},
{
"id": 93,
"name": "Favour Joseph"
},
{
"id": 94,
"name": "Dammy Ola"
},
{
"id": 95,
"name": "Shakir Kamal"
},
{
"id": 96,
"name": "Adam Smith"
},
{
"id": 98,
"name": "Ade Tayo"
},
{
"id": 99,
"name": "Samuel Timothy"
},
{
"id": 100,
"name": "Samuel Timothy"
},
{
"id": 101,
"name": "Martha Fredrick"
},
{
"id": 102,
"name": "Jeremy Chris"
},
{
"id": 103,
"name": "sam oke"
},
{
"id": 104,
"name": "Talatu Abu"
},
{
"id": 106,
"name": "Ima Shem"
},
{
"id": 107,
"name": "Jane Clement"
},
{
"id": 108,
"name": "Henry Shield"
},
{
"id": 109,
"name": "Christopher Mendy"
},
{
"id": 110,
"name": "Amit Hammad"
},
{
"id": 111,
"name": "Seyi Edwards"
},
{
"id": 113,
"name": "Seyi Problems"
},
{
"id": 114,
"name": "Seyi Problems"
},
{
"id": 115,
"name": "Eric Mensah"
},
{
"id": 116,
"name": "Pope Francis"
},
{
"id": 118,
"name": "BuyMoney Inc"
},
{
"id": 120,
"name": "Ayo Bami"
},
{
"id": 121,
"name": "Director Test 1"
},
{
"id": 124,
"name": "D1 E1"
},
{
"id": 127,
"name": "TPGateway User 2"
},
{
"id": 129,
"name": "Samuel Timothy"
},
{
"id": 130,
"name": "Samuel Timothy"
},
{
"id": 132,
"name": "Dami Cient"
},
{
"id": 134,
"name": "Dami Cient"
},
{
"id": 135,
"name": "Samuel Timothy"
},
{
"id": 137,
"name": "Dami Cient"
},
{
"id": 138,
"name": "Oketola Samuel"
},
{
"id": 141,
"name": "TPGateway User 2"
},
{
"id": 142,
"name": "TPGateway User 2"
},
{
"id": 146,
"name": "John Doe"
},
{
"id": 149,
"name": "Tech start up"
},
{
"id": 151,
"name": "TPGateway User 2"
},
{
"id": 152,
"name": "Toluwani"
},
{
"id": 157,
"name": "John Doe"
},
{
"id": 158,
"name": "John Doe"
},
{
"id": 160,
"name": "Test Tester"
},
{
"id": 161,
"name": "Samuel Timothy"
},
{
"id": 163,
"name": "ajs Oketola"
},
{
"id": 165,
"name": "iuy seyi"
},
{
"id": 166,
"name": "victor test 001"
},
{
"id": 167,
"name": "Samuel Timothy"
},
{
"id": 171,
"name": "TIMO TIMO"
},
{
"id": 173,
"name": "Toluwani"
},
{
"id": 175,
"name": "TIMO TIMOTHY"
},
{
"id": 179,
"name": "Oketola Samuel"
},
{
"id": 180,
"name": "Zango Kangiwa"
},
{
"id": 181,
"name": "Toluwani"
},
{
"id": 183,
"name": "Toluwani"
}
]
},
{
"id": 13,
"name": "SAVINGS ACCOUNTS",
"parameterType": "TEXT",
"order": 5,
"required": false,
"options": []
},
{
"id": 14,
"name": "VIRTUAL ACCOUNTS",
"parameterType": "TEXT",
"order": 5,
"required": false,
"options": []
}
]Modified at 2025-03-19 15:04:34