A pricing intent is a template of fees that you apply to processing accounts when you board merchants. You can apply the same pricing intent to all processing accounts that you create or create multiple pricing intents to apply to different processing accounts. A pricing intent can include the following fee types:

Base fees: For monthly maintenance, chargebacks, and early contract termination. All pricing intents must include base fees.
Processor fees: For card payments and Automated Clearing House (ACH) payments. Processor fees also include the pricing model that you offer to the merchant, for example, RewardPay.
Gateway fees: For using our payment gateway.

Integration steps

Create a pricing intent.

Before you begin

Bearer tokens

Use our Identity Service to generate a Bearer token to include in the header of your requests. To generate your Bearer token, complete the following steps:

Include your API key in the x-api-key parameter in the header of a POST request.
Send your request to https://identity.payroc.com/authorize.

You need to generate a new Bearer token before the previous Bearer token expires.

Example request

curl --location --request POST  'https://identity.payroc.com/authorize' --header 'x-api-key: <api key>'

Example response

If your request is successful, we return a response that contains your Bearer token, information about its scope, and when it expires.

{
"access_token": "eyJhbGc....adQssw5c",
"expires_in": 3600,
"scope": "service_a service_b",
"token_type": "Bearer"
}

Headers

To create the header of each POST request, you must include the following parameters:

Content-Type: Include application/json as the value for this parameter.
Authorization: Include your Bearer token in this parameter.
Idempotency-Key: Include a UUID v4 to make the request idempotent.

curl
-H "Content-Type: application/json"
-H "Authorization: <Bearer token>"
-H "Idempotency-Key: <UUID v4>"

Header parameters

Body parameters

Example request

Request

curl --request post \
	--url https://api.payroc.com/v1/pricing-intents \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: abc123' \
	--data '{"key":"abc123","metadata":{"internalReference":"2345"},"country":"US","version":"4.0","base":{"addressVerification":5,"annualFee":{"billInMonth":"december","amount":100},"regulatoryAssistanceProgram":15,"pciNonCompliance":4995,"merchantAdvantage":10,"platinumSecurity":{"billingFrequency":"monthly"},"maintenance":500,"minimum":100,"voiceAuthorization":95,"chargeback":2500,"retrieval":1500,"batch":1500,"earlyTermination":57500},"processor":{"card":{"planType":"interchangePlus","fees":{"mastercardVisaDiscover":{"volume":1.25,"transaction":0},"amex":{"type":"optBlue","volume":1.25,"transaction":0},"pinDebit":{"additionalDiscount":1.25,"transaction":0,"monthlyAccess":0},"electronicBenefitsTransfer":{"transaction":0},"enhancedInterchange":{"enrollment":0,"creditToMerchant":1.25},"specialityCards":{"transaction":0}}},"ach":{"fees":{"transaction":50,"batch":1000,"returns":400,"unauthorizedReturn":1999,"statement":800,"monthlyMinimum":20000,"accountVerification":100,"discountRateUnder10000":1.25,"discountRateAbove10000":1.25}}},"gateway":{"fees":{"monthly":0,"setup":0,"perTransaction":0,"perDeviceMonthly":0,"additionalServiceMonthly":0}}}'

Response fields

If your request is successful, our gateway creates the pricing intent. The response contains the following fields:

Response Schema

Status Code 201

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

Response headers

Response body

Example response

Response

application/json

{
  "id": "5",
  "createdDate": "2020-09-22T09:00:00.000Z",
  "lastUpdatedDate": "2020-09-22T09:00:00.000Z",
  "status": "pendingReview",
  "key": "string",
  "metadata": {
    "internalReference": "2345"
  },
  "country": "US",
  "version": "4.0",
  "base": {
    "addressVerification": 5,
    "annualFee": {
      "billInMonth": "december",
      "amount": 100
    },
    "regulatoryAssistanceProgram": 15,
    "pciNonCompliance": 4995,
    "merchantAdvantage": 10,
    "platinumSecurity": {
      "billingFrequency": "monthly",
      "amount": 1295
    },
    "maintenance": 500,
    "minimum": 100,
    "voiceAuthorization": 95,
    "chargeback": 2500,
    "retrieval": 1500,
    "batch": 1000,
    "earlyTermination": 57500
  },
  "processor": {
    "card": {
      "planType": "interchangePlus",
      "fees": {
        "mastercardVisaDiscover": {
          "volume": 1.25,
          "transaction": 5
        },
        "amex": {
          "type": "optBlue",
          "volume": 1.25,
          "transaction": 10
        },
        "pinDebit": {
          "additionalDiscount": 1.25,
          "transaction": 10,
          "monthlyAccess": 1200
        },
        "electronicBenefitsTransfer": {
          "transaction": 10
        },
        "enhancedInterchange": {
          "enrollment": 1000,
          "creditToMerchant": 5.25
        },
        "specialityCards": {
          "transaction": 10
        }
      }
    },
    "ach": {
      "fees": {
        "transaction": 50,
        "batch": 1000,
        "returns": 400,
        "unauthorizedReturn": 1999,
        "statement": 800,
        "monthlyMinimum": 20000,
        "accountVerification": 100,
        "discountRateUnder10000": 5.25,
        "discountRateAbove10000": 10
      }
    }
  },
  "gateway": {
    "fees": {
      "monthly": 1000,
      "setup": 25000,
      "perTransaction": 0,
      "perDeviceMonthly": 0,
      "additionalServiceMonthly": 0
    }
  }
}

Create a pricing intent

Integration steps

Before you begin

Bearer tokens

Example request

Example response

Headers

Errors