pricingIntents

Partially update pricing intent

Changed on

Use this method to partially update a pricing intent. Structure your request to follow the RFC 6902 standard.

If you update a pricing intent, it won't affect merchants 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.
patch/pricing-intents/{pricingIntentId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/pricing-intents/{pricingIntentId}
  • Auth
    HTTP bearer

Path parameters

pricingIntentIdstring required

Unique identifier that we assigned to the pricing intent.

Headers

Idempotency-Keystring uuid required

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

Response

Successful request. We updated the pricing intent.

idstring

Unique identifier of the pricing intent.

createdDatestring date-time

Date and time that we received your request to create the pricing intent. We return this value in the ISO-8601 format.

lastUpdatedDatestring date-time

Date and time that the pricing intent was last modified. We return this value in the ISO-8601 format.

status'active' | 'pendingReview' | 'rejected'

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.
keystring required

Unique identifier that you can assign to the pricing intent for your own records.

metadataobject

Metadata object that contains your custom data.

country'US' required

Two-digit code for the country that the pricing intent applies to. The format follows the ISO-3166-1 standard.

version'5.2' required

Version of the MPA.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id partiallyUpdate removed and replaced with pricingIntents_partiallyUpdate