Using Custom Pricing
Custom pricing allows integrators to define specific rates and fees tailored to each merchant’s business needs. This option offers full flexibility in configuring how pricing is applied during onboarding.
There are two ways to implement custom pricing:
By modifying fee values in an existing pricing template, or
By creating a completely customized pricing plan based on retrieved templates.
This method provides flexibility who want full control over how pricing is set up for each merchant.
All merchant and pricing information must be submitted in a single API request when initiating the application.
Follow these steps to onboard a merchant using custom pricing:
Using Existing Pricing Template
For more flexible pricing needs, customize merchant fees using predefined pricing templates. These templates are configured under your portfolio and contain default fee structures that can be modified to match the needs of different business models. This approach supports advanced pricing options while ensuring compliance with allowed fee ranges.
The Hosted Merchant Onboarding Setup API supports a single API call to onboard a merchant. For flexible pricing, this request must include:
All standard fields (DBA name, email, MCC)
Pricing template ID
Fee details are configured from the selected template
Retrieve Available Pricing Templates
To begin, retrieve a list of pricing templates that are assigned to your hierarchy using Pricing Plan API. Pricing Plan API.
Use the GET method /api/pricing/v2/PricingPlan/{merchantNumber}/templates to retrieve the available templates for a specific merchant. A successful response includes the available templates, template IDs, fee structures, and any default settings. This allows you to select or customize a template according to the merchant’s pricing needs.
Refer to the below sample code for reference:
{
"content": [
{
"pricingPlanTemplateID": 0,
"hierarchyNodeKey": "string",
"templateName": "string",
"pricingTypeCode": "string",
"isAdvancedPricing": true,
"isDefaultTemplate": true,
"isDisabled": true,
"templateFees": [
{
"clearentPricingFeeID": 0,
"clearentPricingFeeDescription": "string",
"isEditable": true,
"isRequired": true,
"isVisible": true,
"isFee": true,
"isRate": true,
"isPayInMonthRequired1": true,
"isPayInMonthRequired2": true,
"defaultRate": 0,
"minRate": 0,
"maxRate": 0,
"defaultFee": 0,
"minFee": 0,
"maxFee": 0,
"rateLabel": "string",
"feeLabel": "string"
}
],
"templateSettings": [
{
"pricingPlanSettingID": 0,
"settingName": "string",
"description": "string",
"isVisible": true,
"isEditable": true,
"defaultValue": true
}
],
"attributes": [
{
"name": "string",
"value": "string",
"type": "string"
}
]
}
]
}Select and Customize a Template
After retrieving available templates, review the fee structure and select an appropriate one to assign to the merchant. Use the template as-is with default values, or modify the editable fields (e.g., rates or fixed fees) within the permitted limits. Make sure all required values are populated and remain within the allowed ranges.
Submit the Merchant Application
Once you’ve prepared the custom pricing plan, submit it along with the merchant's application using the Create Merchant endpoint.
Use the POST method /api/launchIntegratorSetup/v1.0/integrateMerchant/{hierarchyNodeKey} to submit the application along with the merchant’s details in a single API request. Refer to the below sample code for reference:
Path parameter hierarchyNodeKey identifies the hierarchy 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
},
"merchantInformation": {
"dbaName": "Stark Industries",
"emailAddress": "[email protected]"
},
"salesProfile": {
"mccCode": "5085"
}
}Confirm Pricing Application
After submission, a successful response confirms that the pricing plan was applied correctly and includes the merchant’s status and pricing summary. Refer to the below sample code for reference:
{
"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 confirmation, the merchant application record is updated.
Ensure that your pricing templates are configured to support the pricing models you intend to use. Consult with your integration support team to define template options aligned with your business requirements.
Using Customized Pricing Plan
Retrieve Available Pricing Templates
Before presenting custom pricing to the merchant, the integrator must retrieve available pricing templates.
Use the GET method /api/pricing/v2/PricingPlan/{merchantNumber}/templates to retrieve the available templates for a specific merchant. A successful response includes the available templates, template IDs, fee structures, and any default settings. This allows you to select or customize a template according to the merchant’s pricing needs.
Refer to the below sample code for reference:
{
"content": [
{
"pricingPlanTemplateID": 0,
"hierarchyNodeKey": "string",
"templateName": "string",
"pricingTypeCode": "string",
"isAdvancedPricing": true,
"isDefaultTemplate": true,
"isDisabled": true,
"templateFees": [
{
"clearentPricingFeeID": 0,
"clearentPricingFeeDescription": "string",
"isEditable": true,
"isRequired": true,
"isVisible": true,
"isFee": true,
"isRate": true,
"isPayInMonthRequired1": true,
"isPayInMonthRequired2": true,
"defaultRate": 0,
"minRate": 0,
"maxRate": 0,
"defaultFee": 0,
"minFee": 0,
"maxFee": 0,
"rateLabel": "string",
"feeLabel": "string"
}
],
"templateSettings": [
{
"pricingPlanSettingID": 0,
"settingName": "string",
"description": "string",
"isVisible": true,
"isEditable": true,
"defaultValue": true
}
],
"attributes": [
{
"name": "string",
"value": "string",
"type": "string"
}
]
}
]
}Configure the Pricing Plan
Using the selected pricing template, the integrator configures the fee and rate structure as per their business model. This is done internally, not by the merchant. Embed a button or link (such as an Enroll button) in your signup form to trigger a POST call to the application endpoint. Include all collected merchant data and the custom pricing plan in your request.
Complete the Application
Once the custom pricing plan is successfully submitted, the response includes a signup URL. Merchants will redirect either to the signup URL or via email to notify about the URL. Guide the merchant through the hosted onboarding flow to finalize their application, review the assigned pricing, and electronically sign the merchant agreement.
The application link is valid for 30 days from the date of creation.
If no custom pricing template is submitted, the system will automatically apply the default pricing template associated with your hierarchy.
Last updated
Was this helpful?