List pricing intents

Browse API reference

GET/pricing-intentslistPricingIntents

Use this method to return a paginated list of pricing intents associated with the ISV.

Note: If you want to view the details of a specific pricing intent and you have its pricingIntentId, use our Retrieve Pricing Intent method.

Our gateway returns the following information about each pricing intent in the list:

Information about the fees, including the base fees, gateway fees, and processor fees.
Status of the pricing intent, including whether we approved the pricing intent.

For each pricing intent, we also return its pricingIntentId which you can use to perform follow-on actions.

Parameters

Name	In	Type	Description
`before`	query	`string`	Return the previous page of results before the value that you specify. You can’t send the before parameter in the same request as the after parameter.
`after`	query	`string`	Return the next page of results after the value that you specify. You can’t send the after parameter in the same request as the before parameter.
`limit`	query	`integer`	Limit the maximum number of results that we return for each page.

Responses

Successful response. Returns a list of pricing intents.

200 OK · application/json

{
  "count": 0,
  "data": [],
  "hasMore": false,
  "limit": 10,
  "links": []
}

Response schema · 34 of 594 fields

countinteger
Number of results we returned on this page. Note: This might not be the total number of results that match your query.
hasMoreboolean
Indicates whether there is another page of results available.
limitinteger
Maximum number of results that we return for each page.
linksobject[]
Reference links to navigate to the previous page of results or to the next page of results.
- hrefstringrequired
  URL of the target resource.
- methodstringrequired
  HTTP method that you need to use with the target resource.
- relstringrequired
  Indicates the relationship between the current resource and the target resource.
dataobject[]
Array of pricing intent objects.
- 5.0object
  Object that contains information about a pricing intent for Merchant Processing Agreement (MPA) 5.0.
  - 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.+21 more fields at deeper levels — see the full spec
  - 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.0.+5 more fields at deeper levels — see the full spec
  - processorobject
    Object that contains information about U.S. processor fees.+243 more fields at deeper levels — see the full spec
  - servicesobject[]
    Array of polymorphic objects that contain information about additional services that we offer.+3 more fields at deeper levels — see the full spec
  - versionstringrequired
    Version of the MPA.5.0
- 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.+20 more fields at deeper levels — see the full spec
  - 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.+7 more fields at deeper levels — see the full spec
  - processorobject
    Object that contains information about U.S. processor fees.+237 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.+24 more fields at deeper levels — see the full spec
  - versionstringrequired
    Version of the MPA.5.2

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

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

manage-pricing-intents