Get Report Parameters

Retrieves the parameters a merchant must supply when creating a report of a given type, including the allowed values for list parameters.

GET /admin/reporting/parameters/{reportTypeId}

Path Parameter

Field Name	Type	Required	Description
reportTypeId	integer	true	The unique identifier of the report type, as returned by Get Report Types.

Response

The response is a JSON array of parameter objects.

Field Name	Type	Description
id	integer	Unique identifier of the parameter. Use it as `parameterId` when creating a report.
name	string	Name of the parameter.
parameterType	string	Type of value expected, for example `DATE` (format `yyyy-MM-dd`) or `ARRAY` (value must be one of `options`).
order	integer	Display order of the parameter.
required	boolean	Whether a value must be supplied when creating a report.
options	array	Allowed values for list parameters; empty for other types.

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

🟢200Success

application/json

Success

Bodyapplication/json

Example

[
  {
    "id": 11,
    "name": "START DATE",
    "parameterType": "DATE",
    "order": 1,
    "required": true,
    "options": []
  },
  {
    "id": 12,
    "name": "END DATE",
    "parameterType": "DATE",
    "order": 2,
    "required": true,
    "options": []
  },
  {
    "id": 13,
    "name": "TRANSACTION TYPE",
    "parameterType": "ARRAY",
    "order": 3,
    "required": true,
    "options": [
      "INWARD",
      "OUTWARD"
    ]
  },
  {
    "id": 14,
    "name": "TRANSACTION STATUS",
    "parameterType": "ARRAY",
    "order": 4,
    "required": true,
    "options": [
      "ALL",
      "SUCCESSFUL",
      "FAILED"
    ]
  }
]

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Get Report Parameters