Automated Merchant Onboarding offers flexible pricing options, enabling software partners to modify predefined pricing structures to match their business needs and sales strategies. Instead of using a static pricing model, software partners can retrieve existing pricing templates, modify fees, and apply customized pricing plans at the merchant level.
For more information on modifying default merchant pricing, refer to the following articles:
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:
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.
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"
}
]
}
]Once you have selected a pricing template, you can apply and modify the pricing fees before finalizing the merchant application. Use the Create a Merchant endpoint to:
Assign a pricing plan to the merchant.
Modify the pricing fees under the selected plan.
Complete the merchant application process with the required pricing details.
Adjusting pricing at this stage ensures that each merchant receives a tailored pricing structure that aligns with their business requirements.
This includes the following steps:
Submit Merchant Pricing Details
To onboard a merchant and apply pricing fees, send a POST request with the pricing details.
API Endpoint:
POST /api/launchIntegratorSetup/v1.0/integrateMerchant/{hierarchyNodeKey}
Path Parameter: hierarchyNodeKey - It identifies the hierarchy level under which the merchant is being onboarded.
{
"pricingPlan": {
"pricingFees": [
{
"clearentPricingFeeID": 101,
"pricingFeeDescription": "Transaction Fee",
"rate": 2.5,
"fee": 0.30,
"payInMonth1": 12,
"payInMonth2": 24
}
],
"pricingPlanID": 2001,
"pricingPlanTemplateID": 3001,
"pricingTypeCode": "STANDARD",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true
}
}Understand the API Response
A successful response confirms that the pricing plan has been applied and returns the merchant’s pricing details.
{
"merchantNumber": "123456789",
"status": "Active",
"pricingPlan": {
"pricingFees": [
{
"clearentPricingFeeID": 101,
"pricingFeeDescription": "Transaction Fee",
"rate": 2.5,
"fee": 0.30,
"payInMonth1": 12,
"payInMonth2": 24
}
],
"pricingPlanID": 2001,
"pricingPlanTemplateID": 3001,
"pricingTypeCode": "STANDARD",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true
},
"message": "Merchant pricing plan successfully applied."
}After the successful modification of the pricing plan, the merchant application record is updated, and the new pricing structure is applied automatically. This ensures that merchants receive the correct pricing without requiring manual intervention.