Retrieve pricing intent | Payroc

using Payroc;
using System.Threading.Tasks;
using Payroc.Boarding.PricingIntents;
namespace Usage;
public class Example
{
    public async Task Do() {
        var client = new PayrocClient();
        await client.Boarding.PricingIntents.RetrieveAsync(
            new RetrievePricingIntentsRequest {
                PricingIntentId = "pricingIntentId"
            }
        );
    }
}

{
  "id": "5",
  "createdDate": "2024-07-02T09:00:00Z",
  "lastUpdatedDate": "2024-07-02T09:00:00Z",
  "status": "pendingReview",
  "key": "string",
  "metadata": {
    "yourCustomField": "abc123"
  },
  "country": "US",
  "version": "5.2",
  "base": {
    "addressVerification": 5,
    "annualFee": {
      "billInMonth": "june",
      "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
        },
        "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
    }
  },
  "services": [
    {
      "name": "hardwareAdvantagePlan",
      "enabled": true
    }
  ]
}

Use this method to retrieve information about a pricing intent.

To retrieve 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.

Our gateway returns the following information about the pricing intent:

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.

Use this method to retrieve information about a pricing intent. To retrieve a pricing intent, you need its pricingIntentId. Our gateway returned the pricingIntentId in the response of the [Create Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/create) method. **Note:** If you don't have the pricingIntentId, use our [List Pricing Intents](https://docs.payroc.com/api/schema/boarding/pricing-intents/list) method to search for the pricing intent. Our gateway returns the following information about the pricing intent: - 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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

pricingIntentIdstringRequired

Response

Successful response. Returns the requested pricing intent.

pricing intent version 5.2object

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error