Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Parameters

List program parameters with localization

Get a paginated list of programs with localization parameters.

Returns a translation object with language-specific parameter information.

For information about programs, refer to Core objects.

get/programs/v2/programs/{program_id}/parameters

Path parameters

program_idinteger required

Program ID

Query parameters

pageinteger
Example:1

Page number

perPageinteger
Example:15

Items per page

order'ASC' | 'DESC'

Order to return items: ASC = ascending order, DESC = descending. Default is DESC.

orderBy'ID' | 'NAME'
Example:ID

Sort by ID or NAME. Default = ID.

categorystring

One or more program parameter categories. Use , as separator. <br /> CREDITO - Credit<br /> TAXA - Tax<br /> TARIFA - Fee<br /> PARAMETRO - Parameter<br /> ARQUIVOS - Archives<br /> COBRANCA - Collection<br /> FISCAL - Fiscal<br /> FATURAMENTO - Billing<br /> CARTAO - Card<br /> FRAUDE - Fraud<br /> TIPO DE TRANSACAO - Type of transaction<br />

statusstring

Program status filter. Can be ACTIVE and/or INACTIVE. Use ',' as separator.

requiredstring

Can be REQUIRED and/or OPTIONAL. Use , as separator.

namesstring

One or more program names. Use , as separator.

validFromstring

Return results greater than or equal to the parameter's expiration date. Format = yyyy-mm-ddThh:mm:ss.

validUntilstring

Return results less than or equal to the parameter expiration date. Format = yyyy-mm-ddThh:mm:ss.

searchstring

Filter for provided text in the localization object's name field.

languagestring
Example:en-US

Description language requested. If this field is not present or the language is not in the translation list, the default description (root description) is returned.

For example, the code for English (United States) is en-US. The prefix, en, is a language code following the ISO 639-1 standard. The suffix, US, is a country code following the ISO 3166-1 Alpha-2 standard.

Response

OK

current_pageinteger

Current page number

pagesinteger

Number of pages

per_pageinteger

Maximum number of items per page

total_itemsinteger

Total number of items

Example response

{
  "current_page": 1,
  "items": [
    {
      "id": 1,
      "parameter_id": 11,
      "name": "CONTROL EXPIRATION CHANGES",
      "category": "CREDITO",
      "type": "DECIMAL",
      "value": 1.5,
      "valid_from": "2020-01-01T00:00:00.000Z",
      "valid_until": "2021-07-03T17:23:18Z",
      "status": "ACTIVE",
      "required": "REQUIRED",
      "update_date": "2020-12-31 23:59:59",
      "translation": {
        "name": "Interest projection reversal",
        "description": "Turn the control on and off.",
        "details": "Defines whether the projected interest...",
        "language": "en-us"
      }
    }
  ],
  "pages": 10,
  "per_page": 15,
  "total_items": 100
}