List offers

List Available Offerings

1. Request the list of available offers

To get the list of availale offer you need to send a request to the /offering/available endpoint.

The only mandatory parameter is the request_source object:

AttributeTypeDescriptionExample / EnumsMandatory / Optional / Conditional
initiatorstringDescribes who the initiator of the request isEnumerations: PROVIDER / ALLIANCE / PARTNERM
provider_idstringTo be used by Fiserv onlyC - when the initiator value is PROVIDER
alliance_codestringAllocated by FiservABC1C - when the initiator value is ALLIANCE
partner_codestringAllocated by FiservXYZ1C - when the initiator value is PARTNER

Example 1 - Get all available offers for the Alliance ABC1

{
  "request_source": {
    "initiator": "ALLIANCE",
    "alliance_code": "ABC1"
  }
}

Example 1 - Get all available offers for the Partner XYZ1

{
  "request_source": {
    "initiator": "ALLIANCE",
    "alliance_code": "ABC1",
    "partner_code": "XYZ1"
  }
}

There are 2 optional objects:

  1. operation
AttributeTypeDescriptionExample / Enums
operation_typestringDescribe the type of operation. For getting the list of available offers there is a single enumeration as listed in the column to the rightEnumeration: LIST_AVAILABLE_OFFERINGS
  1. criteria
AttributeTypeDescriptionExample / EnumsMandatory / Optional / Conditional
alliance_codestringProvides list of offers available for a specific alliance. This is used by providers to get the list of offers applicable for one alliance onlyABC1C - if the initiator is PROVIDER
partner_codestringProvides list of offers available for a specific Partner.XYZ4C - if the initiator is PROVIDER or ALLIANCE
mccstringMerchant Category Code of the Merchant.5411 - for supermarkets and grocery stores, 7011 - for hotelsO
atvstringAverage Card Transaction Value15.75O
atostringAnnual Turnover150000O
business_addressobjectFor filtering criteria based on merchant's locationSee belowO
country_codestringCountry ISO code826O
citystringCity nameManchesterO
county_codestringCode of a UK countyGTMO

Example - Request to retrieve a list of available offers accessible for Merchants of the Partner: PAR001 / Alliance: ALL01. The returned offers must meet following criteria:

  • MCC is 7399 (Business Services)
  • Average Transaction Value is 150 (of the respective merchant's country currency)
  • Annual Turnover is 15000000
  • Merchant located in the UK (code 826)
{
 "request_source": {
    "initiator": "ALLIANCE",
    "alliance_code": "ALL001"
  },
  "operation": {
    "operation_type": "LIST_AVAILABLE_OFFERINGS"
  },
  "criteria": {
    "alliance_code": "ALL001",
    "partner_code": "PAR001",
    "mcc": "7399",
    "atv": "150",
    "ato": "15000000",
    "business_address": {
      "country_code": "826"
    }
  }
}

2. Retrieve the response with the list

The response contains the following objects:

AttributeTypeDescriptionExample
resultstringDescription whether the request was processed successfulyEnumerations: SUCCESS / ERROR
operationstringMirrored from the requestLIST_AVAILABLE_OFFERINGS
criteriaobjectMirrored from the request
acquiring_offeringarrayList of objects with ID and the description of the offer(s)See the example below
equipment_offeringarrayList of objects with ID and the description of the offer(s)See the example below
{
  "result": "SUCCESS",
  "operation": {
    "operation_type": "LIST_AVAILABLE_OFFERINGS"
  },
  "criteria": {
    "alliance_code": "ALL001",
    "partner_code": "PAR001",
    "mcc": "7399",
    "atv": "150",
    "ato": "15000000",
    "business_address": {
      "country_code": "826",
      "city": "Oldham",
      "county_code": "Hull"
    }
  },
  "acquiring_offering": [
    {
      "boarding_platform": "OMNIPAY",
      "acquiring_offering_external_id": "ACOC1-A884F-B6FC6-E3BDD-828F3-CA737-1AAF0",
      "acquiring_offering_ref": "All IC EUR",
      "offering_name": "All IC EUR",
      "is_dcc": "0 - This offer does not support DCC"
    }
  ],
  "equipment_offering": [
    {
      "equipment_offering_external_id": "EQOE4-7F631-E36B4-D2ACF-2F432-79769-162EA",
      "equipment_offering_ref": "",
      "offering_name": "Rental Offering",
      "acquiring_only": "0",
      "is_dcc": "0 - This equipment does not support DCC"
    }
  ]
}

3. Working with the retrieved list

After you have the list of available offers, the typical use cases for using them are:

  • Pass the values to a user interface on a Boarding Portal. A user of the Boarding Portal should select an offer they would like to use or find out more about.

After the list of available offers are retrieve you can proceed to getting the details of one or more acquiring offers and / or one or more equipment offers.


Did this page help you?