Skip to content
developers

Create pricing intent

Browse API reference

POST/pricing-intentscreatePricingIntent

Use this method to create a pricing intent that you can assign to a processing account.

In the request, you must provide the following:

  • Processing fees, including the pricing program and the fee to process each transaction.
  • Gateway fees, including the fee for each transaction handled by our gateway.
  • Base fees, including maintenance and PCI fees.

In the response, our gateway returns information about the pricing intent and the pricingIntentId, which you need for the following methods:

Parameters

NameInTypeDescription
Idempotency-KeyRequiredheaderstring

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

application/json
Field Edit request inputs →
  • 5.2object
    Object that contains information about a pricing intent for Merchant Processing Agreement (MPA) 5.2.
    • keystringrequired
      Unique identifier that you can assign to the pricing intent for your own records.
    • metadataobject
      Metadata object that contains your custom data.
    • baseobjectrequired
      Object that contains information about U.S. base fees.
      • addressVerificationintegernullrequired
        Fee for each address verification request. The value is in the currency's lowest denomination, for example, cents.≥ 0
      • annualFeeobjectrequired
        Object that contains information about the annual fee.
        • amountintegerrequired
          Annual fee. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • billInMonthstring
          Indicates whether we collect the annual fee in June or December.junedecember
      • batchintegerrequired
        Fee for each batch. The value is in the currency's lowest denomination, for example, cents.≥ 0
      • chargebackinteger
        Fee for each chargeback. The value is in the currency's lowest denomination, for example, cents.750–5000
      • earlyTerminationinteger
        Fee for early termination. The value is in the currency's lowest denomination, for example, cents.19500–59500
      • maintenanceintegerrequired
        Monthly fee for maintenance. The value is in the currency's lowest denomination, for example, cents.≥ 500
      • minimumintegerrequired
        Monthly fee that we charge when the merchant doesn't meet the minimum fee amount. This monthly fee is in the currency's lowest denomination, for example, cents.≥ 0
      • pciNonComplianceinteger
        Fee that we apply each month if you aren't compliant with PCI standards. The value is in the currency's lowest denomination, for example, cents.3995–10000
      • platinumSecurityobject
        Object that contains information about the Platinum Security fee.
        • monthlyobject
          • amountinteger
            Fee for Platinum Security. The value is in the currency's lowest denomination, for example, cents.
          • billingFrequencystringrequired
            Indicates whether we bill your account monthly or annually.monthly
        • annualobject
          • amountinteger
            Fee for the Platinum Security, this is returned in the lowest unit of currency. For example, cents.
          • billingFrequencystringrequired
            Indicates whether we bill your account monthly or annually.annual
      • regulatoryAssistanceProgramintegernullrequired
        Annual fee for the regulatory assistance program. The value is in the currency's lowest denomination, for example, cents.≥ 0
      • retrievalinteger
        Fee for each retrieval. The value is in the currency's lowest denomination, for example, cents.275–5000
      • voiceAuthorizationinteger
        Fee for each voice authorization. The value is in the currency's lowest denomination, for example, cents.95–200
    • countrystringrequired
      Two-digit code for the country that the pricing intent applies to. The format follows the ISO-3166-1 standard.US
    • gatewayobject
      Object that contains information about the gateway fees for MPA 5.2.
      • feesobjectrequired
        Object that contains information about the gateway fees.
        • 3dSecurePerTransactioninteger
          Fee for each transaction which utilizes 3D Secure. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • monthlyintegerrequired
          Monthly fee for the gateway. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • perDeviceMonthlyintegerrequired
          Monthly fee for each device. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • perTransactionintegerrequired
          Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • setupintegerrequired
          Fee for setting up your account with the gateway. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • tapToPayPerTransactioninteger
          Fee for each tap to pay transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    • processorobject
      Object that contains information about U.S. processor fees.
      • achobject
        Object that contains the fees for ACH transactions.
        • feesobject
          Object that contains processing fees for ACH transactions.
          • accountVerificationintegerrequired
            Fee for each account verification. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • batchintegerrequired
            Fee for each batch. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • discountRateAbove10000numberdoublerequired
            Percentage discount for ACH transfers equal to or more than $10,000.0–100
          • discountRateUnder10000numberdoublerequired
            Percentage discount for ACH transfers less than $10,000.0–100
          • monthlyMinimumintegerrequired
            Minimum monthly value of transactions. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • returnsintegerrequired
            Fee for each return. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • statementintegerrequired
            Fee for each statement. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • transactionintegerrequired
            Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • unauthorizedReturnintegerrequired
            Fee for each unauthorized return. The value is in the currency's lowest denomination, for example, cents.≥ 0
      • cardobject
        Object that contains information about card fees.
        • Interchange Plus Planobject
          Object that contains information about Interchange Plus.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Object that contains the fees for American Express transactions.
              • optBlueobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.optBlue
                • volumenumberdoublerequired
                  Percentage of the total transaction amount that the processor charges the merchant.0–100
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              Object that contains information about the processor fees.
              • transactioninteger
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • volumenumberdouble
                Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.interchangePlus
        • Interchange Plus Plusobject
          Object that contains information about Interchange Plus Plus.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Object that contains the fees for American Express transactions.
              • optBlueobject
                • midQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • nonQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • qualifiedRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • typestringrequired
                  Type of American Express program.optBlue
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              • midQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • nonQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • qualifiedRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.interchangePlusPlus
        • Tiered pricing with three tiersobject
          Object that contains information about tiered pricing with three tiers.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Polymorphic object that contains fees for American Express transactions. The value of the type field determines which variant you should use: optBlue Amex OptBlue pricing program. direct Amex Direct pricing program.
              • optBlueobject
                • midQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • nonQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • qualifiedRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • typestringrequired
                  Type of American Express program.optBlue
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              • midQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • nonQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • qualifiedRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.tiered3
        • Tiered pricing with four tiersobject
          Object that contains information about tiered pricing with four tiers.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Polymorphic object that contains fees for American Express transactions. The value of the type field determines which variant you should use: optBlue Amex OptBlue pricing program. direct Amex Direct pricing program.
              • optBlueobject
                • midQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • nonQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • qualifiedRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • typestringrequired
                  Type of American Express program.optBlue
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              • midQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • nonQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • qualifiedRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • premiumRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.tiered4
        • Tiered pricing with six tiersobject
          Object that contains information about tiered pricing with six tiers.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Polymorphic object that contains fees for American Express transactions. The value of the type field determines which variant you should use: optBlue Amex OptBlue pricing program. direct Amex Direct pricing program.
              • optBlueobject
                • midQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • nonQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • qualifiedRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • typestringrequired
                  Type of American Express program.optBlue
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              • regulatedCheckCardobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • unregulatedCheckCardobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • midQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • nonQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • qualifiedRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • premiumRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.tiered6
        • Flat Rate Planobject
          Object that contains information about Flat Rate.
          • feesobjectrequired
            Object that contains information about the Flat Rate fees.
            • amexobject
              Polymorphic object that contains fees for American Express transactions.
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • standardCardsobjectrequired
              Object that contains information about the processor fees.
              • transactioninteger
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • volumenumberdouble
                Percentage of total transaction amount that the processor charges the merchant.0–100
          • planTypestringrequired
            Type of processing plan.flatRate
        • Consumer Choice Planobject
          Object that contains information about ConsumerChoice.
          • feesobjectrequired
            Object that contains information about the fees.
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • merchantChargePercentagenumberdouble
              Percentage of the total transaction amount that the processor charges the merchant.0–100
            • monthlySubscriptionintegerrequired
              Fee for the monthly subscription for the processing plan. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • volumenumberdoublerequired
              Merchant-authorized percentage on non-cash transactions.0–100
          • planTypestringrequired
            Type of processing plan.consumerChoice
        • RewardPayChoice Planobject
          Object that contains information about RewardPayChoice.
          • feesobjectrequired
            Object that contains information about the fees.
            • creditobjectrequired
              Object that contains information about fees for credit transactions.
              • merchantChargePerTransactioninteger
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • tipsstring
                Indicates how the merchant manages tips.noTipstipPrompttipAdjust
            • debitobjectrequired
              Object that contains information about fees for debit transactions.
              • optionstring
                Indicates if debit transactions should be charged at interchange plus or flat rate pricing.interchangePlusflatRate
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • volumenumberdoublerequired
                Percentage of the total transaction that the processor charges the merchant.0–100
            • monthlySubscriptionintegerrequired
              Fee for the monthly subscription for the processing plan. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.rewardPayChoice
    • servicesobject[]
      Object that contains information about our additional services that the merchant can sign up for.
      • option 1object
        Object that contains information about the Hardware Advantage Plan.
        • enabledbooleanrequired
          Indicates if the merchant has signed up for the Hardware Advantage Plan.
        • namestringrequired
          Name of the service.hardwareAdvantagePlan
      • option 2object
        Object that contains the fees for account updater service.
        • feesobjectrequired
          Object that contains information about the gateway fees.
          • monthlyintegerrequired
            Monthly fee for Account Updater service. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • perUpdateintegerrequired
            Fee for each account update. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • setupintegerrequired
            Setup fee for Account Updater service. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • namestringrequired
          Name of the service.accountUpdater
      • option 3object
        Object that contains the fees for wireless processing.
        • feesobjectrequired
          • monthlyAccessintegerrequired
            Monthly network access fee for Wireless Processing. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • setupintegerrequired
            Setup fee for Wireless Processing. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • namestringrequired
          Name of the service.wirelessProcessing
      • option 4object
        Object that contains the fees for the Clover platform service.
        • feesobjectrequired
          Object that contains the Clover platform fee amounts.
          • dataProtectionPerMidintegerrequired
            Data Protection Services fee per MID. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • keyedAuthorizationPerTransactionintegerrequired
            Fee per keyed or card-not-present transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • platformMonthlyintegerrequired
            Monthly platform fee for Clover. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • namestringrequired
          Name of the service.cloverProcessing
      • option 5object
        Object that contains the fees for the Roc Services gateway.
        • feesobjectrequired
          Object that contains the Roc Services fee amounts.
          • monthlyintegerrequired
            Monthly fee for Roc Services. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • namestringrequired
          Name of the service.rocServicesProcessing
    • versionstringrequired
      Version of the MPA.5.2

Responses

Successful response. We created the pricing intent and it is waiting for approval.

201 Created · application/json
{
  "base": {
    "addressVerification": 5,
    "annualFee": {
      "amount": 100,
      "billInMonth": "june"
    },
    "batch": 1000,
    "chargeback": 2500,
    "earlyTermination": 57500,
    "maintenance": 500,
    "minimum": 100,
    "pciNonCompliance": 4995,
    "platinumSecurity": {
      "amount": 1295,
      "billingFrequency": "monthly"
    },
    "regulatoryAssistanceProgram": 15,
    "retrieval": 1500,
    "voiceAuthorization": 95
  },
  "country": "US",
  "createdDate": "2024-07-02T09:00:00Z",
  "gateway": {
    "fees": {
      "monthly": 2000,
      "perDeviceMonthly": 10,
      "perTransaction": 2000,
      "setup": 5000
    }
  },
  "id": "5",
  "key": "Your-Unique-Identifier",
  "lastUpdatedDate": "2024-07-02T09:00:00Z",
  "metadata": {
    "yourCustomField": "abc123"
  },
  "processor": {
    "ach": {
      "fees": {
        "accountVerification": 100,
        "batch": 1000,
        "discountRateAbove10000": 10,
        "discountRateUnder10000": 5.25,
        "monthlyMinimum": 20000,
        "returns": 400,
        "statement": 800,
        "transaction": 50,
        "unauthorizedReturn": 1999
      }
    },
    "card": {
      "fees": {
        "amex": {
          "transaction": 5,
          "type": "optBlue",
          "volume": 1.25
        },
        "electronicBenefitsTransfer": {
          "transaction": 10
        },
        "mastercardVisaDiscover": {
          "transaction": 5,
          "volume": 1.25
        },
        "pinDebit": {
          "additionalDiscount": 1.25,
          "monthlyAccess": 1200,
          "transaction": 10
        },
        "specialityCards": {
          "transaction": 10
        }
      },
      "planType": "interchangePlus"
    }
  },
  "services": [
    {
      "enabled": true,
      "name": "hardwareAdvantagePlan"
    }
  ],
  "status": "pendingReview",
  "version": "5.2"
}
Response schema · 301 fields
  • 5.2object
    Object that contains information about a pricing intent for Merchant Processing Agreement (MPA) 5.2.
    • createdDatestringdate-time
      Date and time that we received your request to create the pricing intent. We return this value in the ISO-8601 format.
    • idstring
      Unique identifier of the pricing intent.
    • keystringrequired
      Unique identifier that you can assign to the pricing intent for your own records.
    • lastUpdatedDatestringdate-time
      Date and time that the pricing intent was last modified. We return this value in the ISO-8601 format.
    • metadataobject
      Metadata object that contains your custom data.
    • statusstring
      Status of the pricing intent. The value can be one of the following: active We have approved the pricing intent. pendingReview We have not yet reviewed the pricing intent. rejected We have rejected the pricing intent.activependingReviewrejected
    • baseobjectrequired
      Object that contains information about U.S. base fees.
      • addressVerificationintegernullrequired
        Fee for each address verification request. The value is in the currency's lowest denomination, for example, cents.≥ 0
      • annualFeeobjectrequired
        Object that contains information about the annual fee.
        • amountintegerrequired
          Annual fee. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • billInMonthstring
          Indicates whether we collect the annual fee in June or December.junedecember
      • batchintegerrequired
        Fee for each batch. The value is in the currency's lowest denomination, for example, cents.≥ 0
      • chargebackinteger
        Fee for each chargeback. The value is in the currency's lowest denomination, for example, cents.750–5000
      • earlyTerminationinteger
        Fee for early termination. The value is in the currency's lowest denomination, for example, cents.19500–59500
      • maintenanceintegerrequired
        Monthly fee for maintenance. The value is in the currency's lowest denomination, for example, cents.≥ 500
      • minimumintegerrequired
        Monthly fee that we charge when the merchant doesn't meet the minimum fee amount. This monthly fee is in the currency's lowest denomination, for example, cents.≥ 0
      • pciNonComplianceinteger
        Fee that we apply each month if you aren't compliant with PCI standards. The value is in the currency's lowest denomination, for example, cents.3995–10000
      • platinumSecurityobject
        Object that contains information about the Platinum Security fee.
        • monthlyobject
          • amountinteger
            Fee for Platinum Security. The value is in the currency's lowest denomination, for example, cents.
          • billingFrequencystringrequired
            Indicates whether we bill your account monthly or annually.monthly
        • annualobject
          • amountinteger
            Fee for the Platinum Security, this is returned in the lowest unit of currency. For example, cents.
          • billingFrequencystringrequired
            Indicates whether we bill your account monthly or annually.annual
      • regulatoryAssistanceProgramintegernullrequired
        Annual fee for the regulatory assistance program. The value is in the currency's lowest denomination, for example, cents.≥ 0
      • retrievalinteger
        Fee for each retrieval. The value is in the currency's lowest denomination, for example, cents.275–5000
      • voiceAuthorizationinteger
        Fee for each voice authorization. The value is in the currency's lowest denomination, for example, cents.95–200
    • countrystringrequired
      Two-digit code for the country that the pricing intent applies to. The format follows the ISO-3166-1 standard.US
    • gatewayobject
      Object that contains information about the gateway fees for MPA 5.2.
      • feesobjectrequired
        Object that contains information about the gateway fees.
        • 3dSecurePerTransactioninteger
          Fee for each transaction which utilizes 3D Secure. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • monthlyintegerrequired
          Monthly fee for the gateway. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • perDeviceMonthlyintegerrequired
          Monthly fee for each device. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • perTransactionintegerrequired
          Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • setupintegerrequired
          Fee for setting up your account with the gateway. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • tapToPayPerTransactioninteger
          Fee for each tap to pay transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    • processorobject
      Object that contains information about U.S. processor fees.
      • achobject
        Object that contains the fees for ACH transactions.
        • feesobject
          Object that contains processing fees for ACH transactions.
          • accountVerificationintegerrequired
            Fee for each account verification. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • batchintegerrequired
            Fee for each batch. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • discountRateAbove10000numberdoublerequired
            Percentage discount for ACH transfers equal to or more than $10,000.0–100
          • discountRateUnder10000numberdoublerequired
            Percentage discount for ACH transfers less than $10,000.0–100
          • monthlyMinimumintegerrequired
            Minimum monthly value of transactions. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • returnsintegerrequired
            Fee for each return. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • statementintegerrequired
            Fee for each statement. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • transactionintegerrequired
            Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • unauthorizedReturnintegerrequired
            Fee for each unauthorized return. The value is in the currency's lowest denomination, for example, cents.≥ 0
      • cardobject
        Object that contains information about card fees.
        • Interchange Plus Planobject
          Object that contains information about Interchange Plus.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Object that contains the fees for American Express transactions.
              • optBlueobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.optBlue
                • volumenumberdoublerequired
                  Percentage of the total transaction amount that the processor charges the merchant.0–100
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              Object that contains information about the processor fees.
              • transactioninteger
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • volumenumberdouble
                Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.interchangePlus
        • Interchange Plus Plusobject
          Object that contains information about Interchange Plus Plus.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Object that contains the fees for American Express transactions.
              • optBlueobject
                • midQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • nonQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • qualifiedRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • typestringrequired
                  Type of American Express program.optBlue
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              • midQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • nonQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • qualifiedRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.interchangePlusPlus
        • Tiered pricing with three tiersobject
          Object that contains information about tiered pricing with three tiers.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Polymorphic object that contains fees for American Express transactions. The value of the type field determines which variant you should use: optBlue Amex OptBlue pricing program. direct Amex Direct pricing program.
              • optBlueobject
                • midQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • nonQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • qualifiedRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • typestringrequired
                  Type of American Express program.optBlue
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              • midQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • nonQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • qualifiedRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.tiered3
        • Tiered pricing with four tiersobject
          Object that contains information about tiered pricing with four tiers.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Polymorphic object that contains fees for American Express transactions. The value of the type field determines which variant you should use: optBlue Amex OptBlue pricing program. direct Amex Direct pricing program.
              • optBlueobject
                • midQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • nonQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • qualifiedRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • typestringrequired
                  Type of American Express program.optBlue
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              • midQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • nonQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • qualifiedRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • premiumRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.tiered4
        • Tiered pricing with six tiersobject
          Object that contains information about tiered pricing with six tiers.
          • feesobjectrequired
            Object that contains information about the fees.
            • amexobject
              Polymorphic object that contains fees for American Express transactions. The value of the type field determines which variant you should use: optBlue Amex OptBlue pricing program. direct Amex Direct pricing program.
              • optBlueobject
                • midQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • nonQualRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • qualifiedRateobjectrequired
                  Object that contains information about the processor fees.
                  • transactioninteger
                    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                  • volumenumberdouble
                    Percentage of total transaction amount that the processor charges the merchant.0–100
                • typestringrequired
                  Type of American Express program.optBlue
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • mastercardVisaDiscoverobjectrequired
              • regulatedCheckCardobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • unregulatedCheckCardobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • midQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • nonQualRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • qualifiedRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
              • premiumRateobjectrequired
                Object that contains information about the processor fees.
                • transactioninteger
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • volumenumberdouble
                  Percentage of total transaction amount that the processor charges the merchant.0–100
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.tiered6
        • Flat Rate Planobject
          Object that contains information about Flat Rate.
          • feesobjectrequired
            Object that contains information about the Flat Rate fees.
            • amexobject
              Polymorphic object that contains fees for American Express transactions.
              • directobject
                • transactionintegerrequired
                  Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
                • typestringrequired
                  Type of American Express program.direct
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • standardCardsobjectrequired
              Object that contains information about the processor fees.
              • transactioninteger
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • volumenumberdouble
                Percentage of total transaction amount that the processor charges the merchant.0–100
          • planTypestringrequired
            Type of processing plan.flatRate
        • Consumer Choice Planobject
          Object that contains information about ConsumerChoice.
          • feesobjectrequired
            Object that contains information about the fees.
            • electronicBenefitsTransferobject
              Object that contains the fees for EBT transactions.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • merchantChargePercentagenumberdouble
              Percentage of the total transaction amount that the processor charges the merchant.0–100
            • monthlySubscriptionintegerrequired
              Fee for the monthly subscription for the processing plan. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • pinDebitobject
              Object that contains the fees for PIN-debit transactions.
              • additionalDiscountnumberdoublerequired
                Percentage of additional discount.0–100
              • monthlyAccessintegerrequired
                Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • volumenumberdoublerequired
              Merchant-authorized percentage on non-cash transactions.0–100
          • planTypestringrequired
            Type of processing plan.consumerChoice
        • RewardPayChoice Planobject
          Object that contains information about RewardPayChoice.
          • feesobjectrequired
            Object that contains information about the fees.
            • creditobjectrequired
              Object that contains information about fees for credit transactions.
              • cardChargePercentagenumberdouble
                Percentage of the total transaction amount that the processor charges the cardholder.0–100
              • merchantChargePerTransactioninteger
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • merchantChargePercentagenumberdouble
                Percentage of the total transaction amount that the processor charges the merchant.0–100
              • tipsstring
                Indicates how the merchant manages tips.noTipstipPrompttipAdjust
            • debitobjectrequired
              Object that contains information about fees for debit transactions.
              • optionstring
                Indicates if debit transactions should be charged at interchange plus or flat rate pricing.interchangePlusflatRate
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
              • volumenumberdoublerequired
                Percentage of the total transaction that the processor charges the merchant.0–100
            • monthlySubscriptionintegerrequired
              Fee for the monthly subscription for the processing plan. The value is in the currency's lowest denomination, for example, cents.≥ 0
            • specialityCardsobject
              Object that contains the fees for speciality cards.
              • transactionintegerrequired
                Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • planTypestringrequired
            Type of processing plan.rewardPayChoice
    • servicesobject[]
      Object that contains information about our additional services that the merchant can sign up for.
      • option 1object
        Object that contains information about the Hardware Advantage Plan.
        • enabledbooleanrequired
          Indicates if the merchant has signed up for the Hardware Advantage Plan.
        • namestringrequired
          Name of the service.hardwareAdvantagePlan
      • option 2object
        Object that contains the fees for account updater service.
        • feesobjectrequired
          Object that contains information about the gateway fees.
          • monthlyintegerrequired
            Monthly fee for Account Updater service. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • perUpdateintegerrequired
            Fee for each account update. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • setupintegerrequired
            Setup fee for Account Updater service. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • namestringrequired
          Name of the service.accountUpdater
      • option 3object
        Object that contains the fees for wireless processing.
        • feesobjectrequired
          • monthlyAccessintegerrequired
            Monthly network access fee for Wireless Processing. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • setupintegerrequired
            Setup fee for Wireless Processing. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • namestringrequired
          Name of the service.wirelessProcessing
      • option 4object
        Object that contains the fees for the Clover platform service.
        • feesobjectrequired
          Object that contains the Clover platform fee amounts.
          • dataProtectionPerMidintegerrequired
            Data Protection Services fee per MID. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • keyedAuthorizationPerTransactionintegerrequired
            Fee per keyed or card-not-present transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
          • platformMonthlyintegerrequired
            Monthly platform fee for Clover. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • namestringrequired
          Name of the service.cloverProcessing
      • option 5object
        Object that contains the fees for the Roc Services gateway.
        • feesobjectrequired
          Object that contains the Roc Services fee amounts.
          • monthlyintegerrequired
            Monthly fee for Roc Services. The value is in the currency's lowest denomination, for example, cents.≥ 0
        • namestringrequired
          Name of the service.rocServicesProcessing
    • versionstringrequired
      Version of the MPA.5.2

Used in workflows

create-pricing-intentmanage-pricing-intents

Search documentation

API reference169
Guides118
Knowledge38
legal1
Solutions32
Workflows74
↑↓highlight↵openView all search results

Menu

Theme

Sign out

Your saved plans remain in your organization. This browser’s private draft and account view will be cleared.

Talk to an engineer