Retrieving Existing Pricing Templates

To modify merchant pricing, you must first retrieve the available pricing templates from the Automated Merchant Onboarding system. These templates define different pricing structures, which can be assigned to merchants based on their business model and service requirements.

The API (Pricing Plan API) enables integrators to fetch a list of available pricing templates associated with a merchant, which can be used as a base for further modifications.

This includes the following steps:

1

Fetch Available Pricing Templates

To retrieve the pricing templates for a specific merchant, send a GET request to the Pricing Plan API. This will return a list of all pricing templates that are currently available for the merchant.

• API Endpoint: GET /api/pricing/v2/PricingPlan/{merchantNumber}/templates

• Request Parameter: merchantNumber - It identifies the merchant whose pricing templates need to be retrieved.

2

Understand the API Response

A successful response provides a list of available pricing templates, allowing integrators to select the most suitable plan for each merchant.

[
    {
      "pricingPlanTemplateID": 101,
      "hierarchyNodeKey": "987654321",
      "templateName": "Standard Pricing Plan",
      "pricingTypeCode": "STANDARD",
      "isAdvancedPricing": false,
      "isDefaultTemplate": true,
      "isDisabled": false,
      "templateFees": [
        {
          "clearentPricingFeeID": 2001,
          "clearentPricingFeeDescription": "Transaction Fee",
          "isEditable": true,
          "isRequired": true,
          "isVisible": true,
          "isFee": true,
          "isRate": true,
          "isPayInMonthRequired1": false,
          "isPayInMonthRequired2": false,
          "defaultRate": 2.5,
          "minRate": 2.0,
          "maxRate": 3.5,
          "defaultFee": 0.30,
          "minFee": 0.25,
          "maxFee": 0.50,
          "rateLabel": "Percentage Rate",
          "feeLabel": "Fixed Fee"
        }
      ],
      "templateSettings": [
        {
          "pricingPlanSettingID": 5001,
          "settingName": "Daily Settlement",
          "description": "Enable daily settlement for transactions.",
          "isVisible": true,
          "isEditable": true,
          "defaultValue": true
        }
      ],
      "attributes": [
        {
          "name": "Region",
          "value": "USA",
          "type": "String"
        },
        {
          "name": "Currency",
          "value": "USD",
          "type": "String"
        }
      ]
    }
]