Update pricing intent

Browse API reference

PUT/pricing-intents/{pricingIntentId}updatePricingIntent

Use this method to update the details of a pricing intent. If you update a pricing intent, it won't affect merchant that you've previously onboarded.

To update a pricing intent, you need its pricingIntentId. Our gateway returned the pricingIntentId in the response of the Create Pricing Intent method.

Note: If you don't have the pricingIntentId, use our List Pricing Intents method to search for the pricing intent.

You can update the following details about a pricing intent:

Fees, including the base fees, processor fees, and gateway fees.
Custom name for the pricing intent.
Additional services that merchants can sign up for.

Parameters

Name	In	Type	Description
`pricingIntentId`Required	path	`string`	Unique identifier that we assigned to the pricing intent.

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.+2 more fields at deeper levels — see the full spec
  - 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.+6 more fields at deeper levels — see the full spec
  - 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.+6 more fields at deeper levels — see the full spec
- processorobject
  Object that contains information about U.S. processor fees.
  - achobject
    Object that contains the fees for ACH transactions.+10 more fields at deeper levels — see the full spec
  - cardobject
    Object that contains information about card fees.+223 more fields at deeper levels — see the full spec
- 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.+2 more fields at deeper levels — see the full spec
  - option 2object
    Object that contains the fees for account updater service.+5 more fields at deeper levels — see the full spec
  - option 3object
    Object that contains the fees for wireless processing.+4 more fields at deeper levels — see the full spec
  - option 4object
    Object that contains the fees for the Clover platform service.+5 more fields at deeper levels — see the full spec
  - option 5object
    Object that contains the fees for the Roc Services gateway.+3 more fields at deeper levels — see the full spec
- versionstringrequired
  Version of the MPA.5.2

Responses

Resource successfully updated

No response body — a 204 means the action took effect.

Invalid request

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected time, got '' for start_time",
      "parameter": "start_time"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

replace-a-pricing-intent

curl --request PUT \ --url 'https://api.payroc.com/v1/pricing-intents/{pricingIntentId}' \ --header 'Authorization: Bearer <access-token>' \ --header 'Content-Type: application/json' \ --data '{ "base": { "addressVerification": 5, "annualFee": { "amount": 9900, "billInMonth": "june" }, "batch": 1500, "chargeback": 2500, "earlyTermination": 57500, "maintenance": 500, "minimum": 100, "pciNonCompliance": 4995, "platinumSecurity": { "billingFrequency": "monthly" }, "regulatoryAssistanceProgram": 15, "retrieval": 1500, "voiceAuthorization": 95 }, "country": "US", "gateway": { "fees": { "monthly": 2000, "perDeviceMonthly": 10, "perTransaction": 2000, "setup": 5000 } }, "key": "Your-Unique-Identifier", "metadata": { "yourCustomField": "abc123" }, "processor": { "ach": { "fees": { "accountVerification": 10, "batch": 5, "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" } ], "version": "5.2" }'