v1

latestOpenAPI 3.0.12026-07-2356172250.9 KB

PricingPlanV2

Get pricing plan

Retrieve the pricing plan for a specified merchant.

get/api/pricing/v2/PricingPlan/{merchantNumber}

Path parameters

merchantNumberstring required

The merchant's unique identification number.

Query parameters

effectiveDatestring date-time

Indicates the date from which the pricing plans should be effective.

outof100boolean

Indicates whether pricing fees are displayed as percentages out of 100.

useDisplayFeesboolean

Indicates whether the response includes display-friendly fee values for better readability.

Response

Returns a pricing plan successfully.

pricingPlanIDinteger

The identifier for this pricing plan.

pricingPlanTemplateIDinteger

The id of the pricing template that should be used to validate this pricing plan. These are assigned at the partner level and will be provided by your integration specialist.

merchantNumberstring nullable

The identifier for the merchant.

discountQualificationRangeIDinteger nullable

This value will be provided by your integration specialist.

signatureDebitDiscountQualificationRangeIDinteger nullable

This value will be provided by your integration specialist.

pricingTypeCodestring

This value will be provided by your integration specialist.

isAdvancedPricingboolean

This value will be provided by your integration specialist.

isEMFboolean

Enrolls the merchant in Xplor Pay’s EMF (Express Merchant Funding) program, giving them next-business-day funding of batches submitted prior to 11:00 p.m. Eastern Time.

isDailySettleboolean

Governs the settlement of transaction fees: If IsDailySettle is set to true, fees will be deducted from the merchant's daily deposit. If IsDailySettle is set to false, fees will be deducted from the merchant's bank account at the end of the month (Note: a Month End Billing Option fee may apply to transactions that have fees settled monthly).

includeAssessmentsboolean

Governs the billing of certain card brand fees including but not limited to: Assessments, Foreign Card Fees, Authorization Fees (e.g. NABU, APF), Visa Fees (TIF, FANF, ZFL, Auth Misuse), and Network Fees. As a general guideline: This should be set to false if the merchant is on a flat-rate or two-tier pricing plan, as the Discount Rate (or Card-Present/Card-Not-Present Transaction Fees) is set high enough to cover these items. This should be set to true if the merchant is on a Tiered pricing plan, as the Discount Rate is set to cover Interchange, but not these other fees. This should not be available in the template for IC Plus pricing plans, as it must be set to ""Y"" and not left to the client's discretion.

effectiveStartDateTimeUTCstring date-time nullable

The pricing plan will become active starting with this date.

effectiveEndDateTimeUTCstring date-time nullable

The pricing plan will remain active up to this date.