Usage Info

Retrieve calculated pricing information for a workflow. Pricing must first be generated using workflow.pricing.calculate.

This method is only supported for Workflows of type BUSINESS_APPLICATION.

Pricing may become stale if the underlying data is changed. If this method is called with stale pricing, the SYSTEM_RULE_VIOLATION of sub-code PRICING_NOT_CALCULATED will be thrown. Use the workflow.pricing.calculate method to generate up-to-date pricing.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The unique identifier of the Workflow to retrieve pricing for.

Example

{
  "workflow_id": "w_7h1EpxerrZQyLnRC1EQ9Ck",
}

Response

Data

Parameter	Type	Description
pricing	object	The pricing attribute is defined in the table below.

Pricing Parameters

Parameter	Type	Description
items	array of objects	Array of individual pricing components and rates. The items parameter is defined in the table below.

Items Parameters

Parameter	Type	Description
item_code	string	Name of the pricing component. One of PRICING_ITEM_CODES .
value_type	string	Pricing item type. One of PRICING_ITEM_TYPES .
details	object	Details of the related item_code. Details parameters are defined in the table below.

Details Parameters

Parameter	Type	Description
value	string	The pricing value or configuration value. For percentage types, this represents the actual percentage (e.g., 2.9 = 2.9%). For flat fee types, this represents the monetary amount (e.g., 0.3 = $0.30).
currency	string	Currency code for `FIXED_AMOUNT` pricing items. Currently only USD is supported.
unit	string	Unit for `PER_UNIT` pricing items.
locales	array of objects	Contains the custom text locales when available. Details locales parameters are defined in the table below.

Details Locales Parameters

Parameter	Type	Description
locale	string	The language of the text locale.
value	string	The value of the text locale.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {
    "pricing": {
      "items": [
        {
          "item_code": "per_transaction_rate",
          "value_type": "PERCENTAGE",
          "details": {
            "value": 9.9
          }
        },
        {
          "item_code": "blended_rate",
          "value_type": "PERCENTAGE",
          "details": {
            "value": 9.9
          }
        },
        {
          "item_code": "amex_rate",
          "value_type": "PERCENTAGE",
          "details": {
            "value": 9.9
          }
        },
        {
          "item_code": "international_surcharge_rate",
          "value_type": "PERCENTAGE",
          "details": {
            "value": 9.9
          }
        },
        {
          "item_code": "credit_card_rate",
          "value_type": "PERCENTAGE",
          "details": {
            "value": 9.9
          }
        },
        {
          "item_code": "debit_card_rate",
          "value_type": "PERCENTAGE",
          "details": {
            "value": 9.9
          }
        },
        {
          "item_code": "international_rate",
          "value_type": "PERCENTAGE",
          "details": {
            "value": 9.9
          }
        },
        {
          "item_code": "ach_per_transaction_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "ach_return_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "chargeback_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "maintenance_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "no_payment_maintenance_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "application_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "monthly_subscription_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "annual_subscription_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "internal_cost_per_transaction_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "credit_card_per_transaction_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "debit_card_per_transaction_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "amex_per_transaction_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "international_per_transaction_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "payouts_per_transaction_fee",
          "value_type": "FIXED_AMOUNT",
          "details": {
            "value": 49.99,
            "currency": "USD"
          }
        },
        {
          "item_code": "rate_cost",
          "value_type": "PER_UNIT",
          "details": {
            "value": 5,
            "unit": "BPS"
          }
        },
        {
          "item_code": "custom_pricing",
          "value_type": "CUSTOM_TEXT",
          "details": {
            "locales": [
              {
                "locale": "en_US",
                "value": "Your application qualifies for custom pricing. Our sales team will reach you shortly."
              }
            ]
          }
        }
      ]
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `workflow_id` provided does not exist.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below
ACCOUNT_CONFIGURATION_VIOLATION	400	Account configuration rule violations are described below.

System Rule Violations

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Workflow	PRICING_NOT_CALCULATED	Pricing has not been calculated or was invalidated due to data changes. Use `workflow.pricing.calculate` to generate current pricing.
Workflow	INVALID_WORKFLOW_TYPE	The method is not supported for the current Workflow type.

ACCOUNT_CONFIGURATION_VIOLATION

When a ACCOUNT_CONFIGURATION_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Workflow	FEATURE_NOT_ENABLED	Pricing feature is not enabled for this account.