Retrieve equipment

Retrieve Equipment Offering

Request the details of an Equipment Offer

The Retrieve Equipment Offering endpoint /offering/equipment enables you to retrieve the details included within a particular equipment offer such as:

  • equipment (terminals/card readers, peripherals, etc) including minimum, maximum and default pricing configured for each item.

  • services (PCI, ecom, etc). including minimum, maximum and default pricing configured for each item.

Query parametersTypeDescriptionExampleMandatory / Optional / Conditional
equipment_offering_external_idstringAn Equipment Offer ID retrieved in the List offersEQ146-12368-91852-66F6E-AEA69-40D7D-6C845M
alliancestringThe Alliance CodeALL001M

Example request:

?alliance=ALL001&equipment_offering_external_id=EQ146-12368-91852-66F6E-AEA69-40D7D-6C845 

Receive the response with the details of the Equipment Offer

AttributeTypeDescriptionExample / Enums
resultstringConfirmation whether the request was processed successfullySUCCESS
operationstring"operation_type": "RETRIEVE_EQUIPMENT_OFFERING"Description of the successfully performed operation
equipment_offeringobjectContains available details of the offering specified in the requestSee below
offering_namestringA human readable name of the offeringSOFTPOS Rental
equipment_offering_refstringA referrence value assigned by the Alliance for its own purposesSFP1
acquiring_onlybooleanNot usedAlways no value or 0
is_dccstringDCC support indication on the respective equipment0 - No DCC support / 1 - DCC supported
equipment_offering_external_idstringAn external unique ID assigned to the offeringEQ146-12368-91852-66F6E-AEA69-40D7D-6C845
equipment_offering_bundlesarrayList of available bundles combining hardware equipments, billing methods and featuresSee next tab
AttributeTypeDescriptionExample / Enums
equipment_bundle_external_idstringAn unique ID assigned to the bundleEQBF8-3F2D9-8569A-15460-55354-4D2BA-3FD27
bundle_namestringThe name of the bundleSoftPos Bundle
individual_item_onlybooleanNot usedAlways no value or 0
bundle_itemsarrayList of available itemsSee next tab
AttributeTypeDescriptionExample / Enums
equipment_bundle_item_external_idstringAn unique ID assigned to the bundle itemEBI0C-0355A-A3226-723D2-BF472-49CA1-B8D9D
equipmentarrayList of available equipment in the bundleSee next tab
AttributeTypeDescriptionExample / Enums
equipment_external_idstringAn unique ID assigned to the equipmentP1OFB-47CC7-6230A-A1AD3-562D8-BF8D6-02A70
equipment_namestringName of the equipmentClover Flex
equipment_api_codestringFor Fiserv's internal use onlyn/a
equipment_manufacturerstringName of the manufacturerClover
supplier_codestringDescription of the supplier of the equipmentCLOVER
equipment_type_codestringType indicatorPOS / Peripheral
equipment_refstringFor Fiserv's internal use onlyn/a
is_dccstringDCC support indicator0 - this equipment does not support DCC; 1 - this equipment supports DCC
equipment_featuresarrayList of available features for the respective equipmentSee next tab
billing_plansarrayList of available billing plans for the respective equipmentSee next tab
AttributeTypeDescriptionExample / Enums
feature_namestringA name assigned to the featurePOS AMEX
feature_typestringType of the featureAvailable values are agreed with the alliance in the OMS configuration process
feature_api_codestringFiserv's internal usen/a
default_valuestringA value to be used for the feature if not provided in a boarding request9.99
is_requiredstringfeature required: 1 - true or 0 - false
is_service_parameterstringRelated service indicator0 - PHERIPHERAL or POS; 1 - ECOM or MOTO
feature_external_idstringAn unique ID assigned to the featurePRF39-CE684-7B0B7-462AC-8E48D-4AAEF-35D72
control_level_type_external_idstringIndicates how the value for the feature is assignedFIXED_FOR_PROVIDER (availabe as a fixed value for all Alliances) / FIXED_FOR_ALLIANCE (alliance specific value) / VARIABLE FOR ALLIANCE
feature_refstringFiserv internal usen/a
feature_input_typestringInput type of the featureNUMERIC / TEXT/ BOOL (boolean) / LIST (List of values)
AttributeTypeDescriptionExample / Enums
minimum_chargenumberMinimum value configured for the billing plan10
maximum_chargenumberMinimum value configured for the billing plan10
billing_method_external_idstringAn unique ID assigned to the billing methodPBM20-E1100-0EDAE-70935-08947-69453-761E5
billing_api_codestringFiserv's internal use onlyn/a
billing_method_namestringA name of the billing method12 Month Rental
billing_lengthstringDuration in months if applicable for the plan12
billing_typestringType of the billingFixed / Deferred / Rolling / Purchase / N/A

Example response:

{
 "result": "SUCCESS",
 "operation": {
   "operation_type": "RETRIEVE_EQUIPMENT_OFFERING"
 },
 "equipment_offering": {
   "alliance_code": "ALL001",
   "partner_code": "PAR001",
   "equipment_offering_external_id": "EQOC1-A884F-B6FC6-E3BDD-828F3-CA737-1AAF0",
   "offering_name": "EMS Rental Offering",
   "equipment_offering_ref": "4326",
   "acquiring_only": "0",
   "is_dcc": "0"
 },
 "equipment_offering_bundles": [
   {
     "equipment_bundle_external_id": "EQB08-7B774-A66D1-4846D-C3B73-067F4-C7DE2",
     "bundle_name": "SYSTEM_GENERATED",
     "individual_item_only": "0",
     "bundle_items": [
       {
         "equipment_bundle_item_external_id": "EBI37-BB86C-22F53-E3C6C-8B43A-32B91-B5B9E",
         "equipment": {
           "equipment_external_id": "PROB9-D635E-69776-9D286-A1090-9E0E1-A37B1",
           "equipment_api_code": "GEN",
           "equipment_ref": "General",
           "equipment_name": "GENERAL",
           "equipment_manufacturer": "Verifone",
           "supplier_code": "CLOVER",
           "equipment_type_code": "POS",
           "is_dcc": "0",
           "dcc_supplier": "Fiserv",
           "dcc_supplier_code": "FISV",
           "linking": {
             "service": [
               {
                 "service_external_id": "PQOB9-E635E-79776-8D286-A1090-7E0E1-B37B1",
                 "is_mandatory": "0"
               }
             ],
             "peripheral": [
               {
                 "equipment_external_id": "PROB9-D635E-69776-9D286-A1090-9E0E1-A37B1",
                 "is_mandatory": "0"
               }
             ]
           }
         },
         "equipment_features": [
           {
             "feature_external_id": "PRFA9-DD78C-287FC-D5C92-DCB43-C7EB7-70220",
             "feature_name": "POS Visa",
             "feature_ref": "123",
             "feature_api_code": "POS_PAY_INST_VISA",
             "control_level_type_external_id": "PCTA6-9C8D3-BB945-34262-38E82-21B56-EF107",
             "feature_type": "POS_PAY_INST",
             "is_required": "1",
             "is_service_param": "0",
             "feature_input_type": "NUMERIC",
             "min": "0",
             "max": "99999999",
             "default_value": "0000",
             "default_values": [
               "\"Merchant Specified\": \"18\""
             ],
             "list_of_values": [
               "\"Fixed Time\": 17"
             ]
           }
         ],
         "billing_plans": [
           {
             "billing_method_external_id": "PBM20-E1100-0EDAE-70935-08947-69453-761E5",
             "billing_api_code": "12LR",
             "billing_method_ref": "12MonthContract",
             "billing_method_name": "12 Month Rental",
             "billing_length": "12",
             "billing_type": "Fixed",
             "minimum_charge": 1,
             "maximum_charge": 40,
             "default_charge": 0,
             "renewal_minimum_charge": 0,
             "renewal_maximum_charge": 0,
             "renewal_default_charge": 0
           }
         ],
         "service": {
           "service_external_id": "PQOB9-E635E-79776-8D286-A1090-7E0E1-B37B1",
           "service_api_code": "GEN",
           "service_ref": "General",
           "service_name": "GENERAL",
           "service_level": "OUTLET",
           "supplier_code": "CLOVER",
           "service_type_code": "POS",
           "service_type": "CAP"
         },
         "service_features": [
           {
             "feature_external_id": "PRFA9-DD78C-287FC-D5C92-DCB43-C7EB7-70220",
             "feature_name": "POS Visa",
             "feature_ref": "123",
             "feature_api_code": "POS_PAY_INST_VISA",
             "control_level_type_external_id": "PCTA6-9C8D3-BB945-34262-38E82-21B56-EF107",
             "feature_type": "POS_PAY_INST",
             "is_required": "1",
             "is_service_param": "0",
             "feature_input_type": "NUMERIC",
             "min": "0",
             "max": "99999999",
             "default_value": "0000",
             "default_values": [
               "\"Merchant Specified\": \"18\""
             ],
             "list_of_values": [
               "\"Fixed Time\": 17"
             ]
           }
         ]
       }
     ]
   }
 ]
}

Did this page help you?