Configuring Merchant Pricing

Use the Merchant Pricing API to create or update pricing plans during merchant onboarding. This helps to configure the transaction fees, service charges, and other cost-related configurations that align with each merchant’s business needs.

Customizable Pricing Plans:

• Defines flexible pricing structures based on your business requirements. Each plan can include specific fee types, rates, and service charges.

Transparent and Competitive Rates:

• Configure pricing using predefined templates or customize plans to match individual merchant operations.

It supports both POST and PUT methods to manage merchant pricing efficiently and maintain transparent, business-aligned rate structures.

1

Create a Pricing Plan

Use POST method /api/pricing/v2/PricingPlan/{merchantNumber} to to assign a new pricing plan to a merchant. Refer to the below request sample code for reference:

{
  "planName": "Standard Plan",
  "effectiveDate": "2025-07-01T00:00:00Z",
  "planTypeId": 1,
  "pricingFees": [
    {
      "feeTypeId": 101,
      "amount": 0.025,
      "isPercentage": true
    },
    {
      "feeTypeId": 102,
      "amount": 0.15,
      "isPercentage": false
    }
  ],
  "enabled": true
}

Refer to the below sample response code for reference:

{
  "pricingFees": [
    {
      "clearentPricingFeeID": 101,
      "pricingFeeDescription": "Transaction Processing Fee",
      "rate": 2.9,
      "fee": 0.30,
      "payInMonth1": 10.00,
      "payInMonth2": 10.00
    },
    {
      "clearentPricingFeeID": 102,
      "pricingFeeDescription": "Monthly Service Fee",
      "rate": 0.0,
      "fee": 25.00,
      "payInMonth1": 25.00,
      "payInMonth2": 25.00
    }
  ],
  "pricingPlanID": 5001,
  "pricingPlanTemplateID": 3002,
  "merchantNumber": "1234567890123456",
  "discountQualificationRangeID": 2,
  "signatureDebitDiscountQualificationRangeID": 3,
  "pricingTypeCode": "INTERCHANGE_PLUS",
  "isAdvancedPricing": true,
  "isEMF": true,
  "isDailySettle": true,
  "includeAssessments": true,
  "effectiveStartDateTimeUTC": "2024-03-01T00:00:00Z",
  "effectiveEndDateTimeUTC": "2025-03-01T00:00:00Z"
}

2

Update a Pricing Plan

Use PUT method /api/pricing/v2/PricingPlan/{merchantNumber}/{id} to modify an existing pricing plan assigned to a merchant.

Refer to the below sample response code for reference:

{
  "pricingFees": [
    {
      "clearentPricingFeeID": 101,
      "pricingFeeDescription": "Transaction Processing Fee",
      "rate": 2.9,
      "fee": 0.30,
      "payInMonth1": 10.00,
      "payInMonth2": 10.00
    },
    {
      "clearentPricingFeeID": 102,
      "pricingFeeDescription": "Monthly Service Fee",
      "rate": 0.0,
      "fee": 25.00,
      "payInMonth1": 25.00,
      "payInMonth2": 25.00
    }
  ],
  "pricingPlanID": 5001,
  "pricingPlanTemplateID": 3002,
  "merchantNumber": "1234567890123456",
  "discountQualificationRangeID": 2,
  "signatureDebitDiscountQualificationRangeID": 3,
  "pricingTypeCode": "INTERCHANGE_PLUS",
  "isAdvancedPricing": true,
  "isEMF": true,
  "isDailySettle": true,
  "includeAssessments": true,
  "effectiveStartDateTimeUTC": "2024-03-01T00:00:00Z",
  "effectiveEndDateTimeUTC": "2025-03-01T00:00:00Z"
}