Sign in

v1

latestOpenAPI 3.0.22026-07-242673105.9 KB
Products

Retrieve list of products

Retrieve a paginated list of products with optional filtering and sorting.

Available sort fields:

  • id: Product ID
  • name: Product name
  • amount: Destination Amount
get/products

Query parameters

type'FIXED_VALUE_RECHARGE' | 'RANGED_VALUE_RECHARGE' | 'FIXED_VALUE_PIN_PURCHASE' | 'RANGED_VALUE_PIN_PURCHASE' | 'RANGED_VALUE_PAYMENT'
service_idinteger

Service identifier. See Services for more details.

Service identifier. See Services for more details. Required when subservice_id is specified.

subservice_idinteger

Sub-service identifier. See Services for more details.

tagsProductTag[]
country_iso_codestring

Country code in ISO 3166 format. Note that the official list can be extended with additional country codes.

operator_idinteger

Operator identifier.

regionstring

Country subregion code in ISO 3166 format. Note that the official list can be extended with additional country codes.

benefit_typesBenefitTypes[]
sortstring

Sort results by supported fields: id (default), name or amount. Pass the dash operator (-) for descending direction. Default is ascending. Multiple fields can be separated by a comma. Examples: "sort=name" sort by name in ascending manner. "sort=-amount" sort by destination amount in descending manner. "sort=amount,name" sort by amount and then by name

Example:name
pageinteger

Page number.

per_pageinteger

Number of records per page.

Headers

Accept-Languagestring
Example:es

Preferred language for the content

Response

successful operation