PriceCriteria Subobject

The PriceCriteria object is used to define dynamic pricing for a CarrierBilling Transaction. (Because mobile payments may only be processed for fixed values in a given country, pricing may be defined as Static, or Dynamic. The PriceCriteria subobject allows you to define your pricing structure.) Note that priceCriteria has no meaning (and will be ignored) when creating a new PaymentMethod for an Account. Therefore, include this subobject with the PaymentMethod only when processing a CarrierBilling-funded Transaction.

Data Member	Data Type	Description
`countryCode`	string	ISO 3166-1 alpha-2 countryCode for customer location. This value will override the `CarrierBilling` object’s `countryCode` data member.
`currency`	string	ISO 4217 Currency Code for either the `staticPriceIncSalesTax`, or the `dynamicTargetPrice.` (For dynamic pricing, the customer currency will be determined by the customer region/countryCode.) This value will override the `CarrierBilling` object’s `currency` data member.
`description`	string	A description for the Price Criteria.
`dynamicDeviation`	int	The % deviation (+/- 1000) from the target value that is acceptable as a price point selection.
`dynamicMatch`	int	The % deviation (+/- 1000) from the target value that is classified as an exact match.
`dynamicPriceMode`	`DynamicPriceMode`	Defines which price point element is matched by the dynamic pricing algorithm. `DynamicPriceMode` may be one of three types: - `Price`: The target value will be matched to “price-inc-salestax” values in the payment provider’s price point matrix. - `PayoutGross`: The target value will be matched to “gross-payout” values in the payment provider’s price point matrix. - `PayoutNet`: The target value will be matched to “net-payout” values in the payment provider’s price point matrix.
`dynamicTargetPrice`	decimal	The target price in the specified currency for dynamic pricing.
`fwdUrl`	string	Overrides both the successful transaction forward-to URL, and the failed transaction forward-to URL.
`merchantServiceIdentifier`	string	Your service identifier for the payment provider.
`paymentProvider`	`PaymentProvider`	`PaymentProvider` selected for the Transaction. This value will override the `CarrierBilling` object’s `PaymentProvider` data member. (Subscribe currently supports BOKU as a `CarrierBilling` payment provider.) See PaymentProvider Data Members.
`pricePointDeviationPolicy`	`PricePointDeviationPolicy`	The allowed price deviation policy for `CarrierBilling` payments using dynamic price selection. `PricePointDeviationPolicy` may be one of three values: - `HiPreferred`: A solution higher than the target value will be favored over a lower solution. - `HiOnly`: Only solutions higher than the target value will be returned. - `LowPreferred`: A solution lower than the target value will be favored over a higher solution. - `LowOnly`: Only solutions lower than the target value will be returned. - `NearestNoPreference`: The closest solution to the target value will be selected.
`staticPriceIncSalesTax`	decimal	The price including tax (the amount your customer will pay). Used with Transactions with static “exact match” pricing.
`staticSelectionRowRef`	int	The row number identifier in the static product/service price matrix.
`subMerchantIdentifier`	string	The sub-merchant identifier for the Transaction. (Note that use of the forward slash character (/) in merchant identifiers is not allowed. Note: use of the forward slash character (/) in merchant identifiers is not allowed. See Merchant Identifiers for more information.
Parent topic:PaymentMethod Subobjects

Home

Guides

APIs