Create pricing intent

using Payroc.Boarding.PricingIntents;
using Payroc;
var client = new PayrocClient("x-api-key");
await client.Boarding.PricingIntents.CreateAsync(
    new CreatePricingIntentsRequest
    {
        IdempotencyKey = "8e03978e-40d5-43e8-bc93-6894a57f9324",
        Body = new PricingIntent50
        {
            Country = PricingAgreementUs50Country.Us,
            Version = PricingAgreementUs50Version.Five0,
            Base = new BaseUs
            {
                AddressVerification = 5,
                AnnualFee = new BaseUsAnnualFee
                {
                    BillInMonth = BaseUsAnnualFeeBillInMonth.June,
                    Amount = 9900,
                },
                RegulatoryAssistanceProgram = 15,
                PciNonCompliance = 4995,
                MerchantAdvantage = 10,
                PlatinumSecurity = new BaseUsPlatinumSecurity(
                    new BaseUsPlatinumSecurity.Monthly(new BaseUsMonthly())
                ),
                Maintenance = 500,
                Minimum = 100,
                VoiceAuthorization = 95,
                Chargeback = 2500,
                Retrieval = 1500,
                Batch = 1500,
                EarlyTermination = 57500,
            },
            Processor = new PricingAgreementUs50Processor
            {
                Card = new PricingAgreementUs50ProcessorCard(
                    new PricingAgreementUs50ProcessorCard.InterchangePlus(
                        new InterchangePlus
                        {
                            Fees = new InterchangePlusFees
                            {
                                MastercardVisaDiscover = new ProcessorFee(),
                            },
                        }
                    )
                ),
            },
            Services = new List<ServiceUs50>()
            {
                new ServiceUs50(
                    new ServiceUs50.HardwareAdvantagePlan(
                        new HardwareAdvantagePlan { Enabled = true }
                    )
                ),
            },
            Key = "Your-Unique-Identifier",
            Metadata = new Dictionary<string, string>() { { "yourCustomField", "abc123" } },
        },
    }
);

{
  "id": "5",
  "createdDate": "2024-07-02T09:00:00",
  "lastUpdatedDate": "2024-07-02T09:00:00",
  "status": "pendingReview",
  "key": "string",
  "metadata": {
    "yourCustomField": "abc123"
  },
  "country": "US",
  "version": "5.0",
  "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
        },
        "enhancedInterchange": {
          "enrollment": 1000,
          "creditToMerchant": 5.25
        },
        "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 create a pricing intent that you can assign to a processing account.

In the request, you must provide the following:

Processing fees, including the pricing program and the fee to process each transaction.
Gateway fees, including the fee for each transaction handled by our gateway.
Base fees, including maintenance and PCI fees.

In the response, our gateway returns information about the pricing intent and the pricingIntentId, which you need for the following methods:

Create Merchant Platform - Assign the pricing intent to a processing account, when you create the merchant platform and its processing accounts.
Create Processing Account - Assign the pricing intent to a processing account.
Retrieve Pricing Intent - Retrieve information about a pricing intent.
Update Pricing Intent - Update the details of a pricing intent.
Delete Pricing Intent - Delete a pricing intent.
Partially Update Pricing Intent - Partially update the details of a pricing intent.

Use this method to create a pricing intent that you can assign to a processing account. In the request, you must provide the following: - Processing fees, including the pricing program and the fee to process each transaction. - Gateway fees, including the fee for each transaction handled by our gateway. - Base fees, including maintenance and PCI fees. In the response, our gateway returns information about the pricing intent and the pricingIntentId, which you need for the following methods: - [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) - Assign the pricing intent to a processing account, when you create the merchant platform and its processing accounts. - [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) - Assign the pricing intent to a processing account. - [Retrieve Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/retrieve) - Retrieve information about a pricing intent. - [Update Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/update) - Update the details of a pricing intent. - [Delete Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/delete) - Delete a pricing intent. - [Partially Update Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/partially-update) - Partially update the details of a pricing intent.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

pricing intent version 5.0objectRequired

Response headers

locationstring or null

URI reference to created resource.

Response

Successful response. We created the pricing intent and it is waiting for approval.

pricing intent version 5.0object

Authentication

Headers

Request

Response headers

Response

Errors