Retrieve acquiring offers

Retrieve Acquiring Offering

Request the details of an Acquiring Offer

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

  • Transaction items: fees charged per each transaction, for example Visa Debit or Maestro; including minimum, maximum and default pricing configured for each item
  • Service items: fees not related to transactions are charged on a different basis. For example chargeback fee, joining fee, PCI compliance fee; including minimum, maximum and default pricing configured for each item

To retrieve a list of available transaction items and service items request needs to be sent to the endpoint. The request only contains two query parameters:

Query parametersTypeDescriptionExampleMandatory / Optional / Conditional
acquiring_offering_external_idstringAn Acquiring Offer ID retrieved in the List offersAC1CD-7F1F1-F8C14-E0G53-E7CF2-F09A1-746ADM
alliancestringThe Alliance CodeALL001M

Example request:

?alliance=ALL001&alliance_offering_external_id=AC1CD-7F1F1-F8C14-E0G53-E7CF2-F09A1-746AD

Receive the response with the details of an Acquiring Offer

The response contains the following objects:

AttributeTypeDescriptionExample / Enums
resultstringConfirmation whether the request was processed successfullySUCCESS / ERROR
operationstringDescription of the operation for which the response has been returnedRETRIEVE_ACQUIRING_OFFERING
acquiring_offeringobjectContains the details of the respective acquiring offer
transaction_itemsarrayList of chargeable transaction based items. For example VISA or MasterCard Business...TCIB4-EAA05-E466A-ED065-205F8-6EC63-16430
service_charge_itemsarrayAvailable service based (non-transaction) charges. For example ChargeBack Fee, Set-up Fee...TCIB4-EAA05-E466A-ED065-205F8-6EC63-16430
posting_tarrifsarrayReference to configuration of a service in the Omnipay system which determines the way how funds are transferred to the merchant's banking account.GROSS+
settlement_methodsarrayAvailable options to transfer funds to the merchant's bank accountFor example Daily Funding...
posting_accountsarrayList of bank account types required to set up a merchantServes to provide details of an account to provide the funds to the merchant, an account that hold or collect the fees etc.

More Details of the Acquiring Offer arrays:

FieldDescription
alliance_codeAlliance code echoed from the request
partner_codePartner code echoed from the request
acquiring_offering_external_idAn unique ID of the respective acquiring offer
boarding_platformDescription of the acquiring back-end platform for which the offering is available. For example OMNIPAY
offering_nameHuman readable name of the offering
acquiring_offering_refHuman readable offering name
service_contract_idThe ID of the OmniPay service contract
service_contractOmniPay's specific definition of the way how merchant's transactions are processed
merchant_tariff_idThe ID of an OmniPay's merchant tariff
merchant_tariffOmniPay's specific definition of transaction charges grouping
client_tariff_idThe ID of an OmniPays's client tariff
client_tariffOmniPay's specific definition of account fees grouping
posting_tariff_flagIndicates whether the acquiring offer is configured with a single posting tariff option or multiple. Enums: SINGLE / MULTI / ALL
is_dccIndicator of the DCC service support in the respective offering
FieldFormatDescription
charge_item_namestringHuman readable name of the item
charge_refstringHuman readable reference
charge_unitstringMaximum number of digits for the charge value before the decimal separator
minimum_chargenumberMinimum charge value allowed. In case it has been configured
maximum_chargenumberMaximum charge value allowed. In case has been configured
default_chargenumberDefault charge value that can be overridden with a value within the minimum and maximum charge value range
minimum_base_chargenumberMinimum value allowed
maximum_base_chargenumberMaximum value allowed
default_base_chargenumberDefault value that can be overridden with a value within the minimum and maximum charge value range
card_typesnumberArray containing object carrying information about available cardtype in the respective acquiring offer
card_namestringHuman readable description of the card type
card_type_keystringCard type key
FieldFormatDescription
service_charge_namestringHuman readable name of the item
charge_refstringHuman readable reference
charge_unitstringMaximum nuber of digits for the charge value before the decimal separator
minimum_chargenumberMinimum charge value allowed. If it has been configured
maximum_chargenumberMaximum charge value allowed. If it has been configured
default_chargenumberDefault charge value that can be overridden with a value within the minimum and maximum charge value range
minimum_base_chargenumberMinimum value allowed
maximum_base_chargenumberMaximum value allowed
default_base_chargenumberDefault value that can be overridden with a value within the minimum and maximum charge value range
is_other_service_feenumberArray containing object carrying information about available card type in the respective acquiring offer
service_fee_typestringHuman readable description of the card type
FieldFormatDescription
posting_tariff_idstringThe ID of the OmnipPay's posting tariff
posting_tariff_namestringThe name of the posting tariff
settlement_method_flagstringSINGLE / MULTI / ALL
FieldFormatDescription
settlement_method_idstringThe ID of the OmniPay's settlement method
settlement_method_namestringThe name of the Omnipay's settlement method
settlement_currenciesstringThe available currencies of the settlement method
FieldFormatDescription
settlement_method_idstringThe ID of the referenced settlement method
settlement_method_namestringThe name of the referenced settlement method
settlement_currencystringISO currency code
accountsarrayAn array containing a list of bank account type available for the respective settlement method
account_type_idstringThe ID of the account type
account_typestringThe name of the account type

Example response messsage:

{
  "result": "SUCCESS",
  "operation": {
    "operation_type": "RETRIEVE_ACQUIRING_OFFERING"
  },
  "acquiring_offering": {
    "alliance_code": "ALL001",
    "partner_code": "PAR001",
    "acquiring_offering_external_id": "ACOC1-A884F-B6FC6-E3BDD-828F3-CA737-1AAF0",
    "boarding_platform": "OMNIPAY",
    "offering_name": "ANIE Super Enhanced Offering",
    "acquiring_offering_ref": "INTERCHANGE_AB",
    "service_contract_id": "1",
    "service_contract": "Service Contract 1",
    "merchant_tariff_id": "12",
    "merchant_tariff": "Merch Regular 7",
    "client_tariff_id": "10",
    "client_tariff": "Blended UK",
    "posting_tariff_flag": "SINGLE",
    "is_dcc": "0"
  },
  "transaction_items": [
    {
      "transaction_charge_item_external_id": "TCIB4-EAA05-E466A-ED065-205F8-6EC63-16430",
      "charge_item_name": "Desktop Terminal Fee 1 013",
      "charge_ref": "Desktop Terminal Fee 1",
      "charge_unit": 1,
      "minimum_charge": 0.3,
      "maximum_charge": 5,
      "default_charge": 0,
      "minimum_base_charge": 0.05,
      "maximum_base_charge": 5,
      "default_base_charge": 0,
      "card_types": [
        {
          "card_name": "MasterCard",
          "card_type_key": "MC"
        }
      ]
    }
  ],
  "service_charge_items": [
    {
      "service_charge_item_external_id": "SCI7F-CD9F6-E7D44-0C836-7ABA2-E29B5-EDCB5",
      "charge_item_name": "Desktop Terminal Fee 1 013",
      "charge_ref": "Desktop Terminal Fee 1",
      "charge_unit": 1,
      "minimum_charge": 0.25,
      "maximum_charge": 5,
      "default_charge": 0,
      "minimum_base_charge": 0.03,
      "maximum_base_charge": 5,
      "default_base_charge": 0,
      "is_other_service_fee": "0",
      "service_fee_type": "GATEWAY_FEE"
    }
  ],
  "posting_tariffs": [
    {
      "posting_tariff_id": "44444",
      "posting_tariff_name": "Regular 1",
      "settlement_method_flag": "MULTI"
    }
  ],
  "settlement_methods": [
    {
      "settlement_method_id": "12121",
      "settlement_method_name": "Global Wire Trans 1",
      "settlement_currencies": [
        "GBP",
        "USD"
      ]
    }
  ],
  "posting_accounts": [
    {
      "settlement_method_id": "162",
      "settlement_method_name": "Split Fund Monthly",
      "settlement_currency": "EUR",
      "accounts": [
        {
          "account_type_id": "133",
          "account_type": "Payment Account Retail"
        }
      ]
    }
  ]
}

Did this page help you?