Getting Product Data

The Get Product and Get Product for Program Manager endpoints enable you to to list products your program has on GPS systems and view the details of each product. The Get Product endpoint enables you to view a list of all products associated with your program, while the Get Product for Program Manager enables you to view detailed information for a specific product.

Get Product

The Get Product endpoint allows you to retrieve the a list of products for your program. You can retrieve the list by making a GET request to the Get Product endpoint. For example:

{{base-url}}/products

A successful response will return a HTTP 200 response code. Below is an example response:

[
    {
        "productID": 8591,
        "productName": "GPS Test Session",
        "accountCode": "01",
        "schemeName": "GPS SCHEME TEST",
        "currencyCode": "GBP"
    }
]

👍

API Explorer

See the Get list of Products for a given Program Manager endpoint.

Get Product for Program Manager

The Get Product for Program Manager endpoint allows you to details for a specified product id. This id must be specified in the endpoint. You can details by making a GET request to the Get Product endpoint. For example:

{{base-url}}/products/{{productId}}

📘

Note

You can get the product id from the Get Product endpoint response.

A successful response will return a HTTP 200 response code. Below is an example response:

{
    "supportedCredentialTypesCsv": null,
    "supportedCredentialTypes": [],
    "defaultCredentialTypeId": null,
    "fallbackCredentialTypeId": null,
    "productId": 8591,
    "accountCode": "01",
    "revealPan": true,
    "schemeName": "GPS SCHEME TEST",
    "currencyCode": "GBP",
    "groupFeeTranCode": "",
    "groupFeeMasterCode": "",
    "groupFeeWebCode": "",
    "groupMCCCode": "",
    "groupUsageCode": "GPS-TEST",
    "ehiMode": 3,
    "supplier3DS": "2",
    "supplier3DSVersion": "1.0"
}

👍

API Explorer

See the Get Product endpoint.


Did this page help you?