cardPricing

Top-level wrapper that contains an instance of cardCharges and exceptionCharges, which in turn contain instances of cardCharge and exceptionCharge objects.

For data examples, see the API Reference.

cardPricing elements

cardPricing - Wrapper for the card charges listing. Contains information regarding business pricing category and desired pricing method.

ElementDescription
pricingCategoryRequired. Business pricing category.
Populated from a list of pricing categories in the card charge table.
pricingMethodRequired. Card charge pricing method to be applied.
Populated from a list of pricing methods in the card charge table.

cardCharge - used to create individual card charges. Each cardCharge will represent one card type. For example, if you want to allow Visa Credit AND Debit cards, you would need one for each of the two cards.

ElementDescription
typeRequired. The name of the credit card issuer (examples: VISA, MasterCard).
Populated from a list of card types in the card charge table.
seNumberRequired when using an existing American Express (AMEX) account. SE stands for Service Establishment.

pricingTiers - Required for tiered pricing method. Each pricing tier will require a discount rate and discount per item.

ElementDescription
discountRateRequired. The per-transaction percentage rate applied to the card product.
discountPerItemRequired. The per-transaction fee applied to the card product.

debitPricing - Wrapper for the debit charges listing. Contains information regarding pricing authorization and desired pricing method.

ElementDescription
pricingMethodRequired. Debit network pricing method to be applied.
authorizationMethodRequired. Debit network authorization method applied (FIXED, PASSTHROUGH, or NONE).

debitNetworkCharge - used to create individual debit networks to be applied. Each debitNetworkCharge will represent one card type, much like a cardCharge.

ElementDescription
debitNetworkChargeRequired. The per transaction percentage rate applied to the network.
discountRateRequired. The per item rate percentage to be applied to the network.
discountPerItemRequired. The per transaction fee to be applied to the network.
perAuthRequired. The per authorization fee to be applied to the network.

amexAcceptingInfo - Container for additional information regarding American Express (AMEX). Required if AMEX is a cardType in use.

ElementDescription
amexMonthlyCardSalesRequired (Canada Only). Monthly sales by AMEX.
isExistingRequired. Is there an existing American Express (AMEX) account?
Boolean true if yes, false if no.