---
title: "Update Payfac Lead"
method: PATCH
path: "/v1/agent-hub/apply/lead/{id}"
---

# Update Payfac Lead

`PATCH /v1/agent-hub/apply/lead/{id}`

## Path parameters

- `id` string, required

## Request body

- object
  - `Lead` object
    - `ProcessingType` string, required
    - `Industry` '4121' | '4215' | '4899' | '4900' | '5013' | '5045' | '5047' | '5065' | '5072' | '5074' | '5099' | '5111' | '5137' | '5139' | '5172' | '5192' | '5193' | '5199' | '5200' | '5231' | '5251' | '5261' | '5310' | '5311' | '5331' | '5399' | '5441' | '5451' | '5462' | '5499' | '5511' | '5521' | '5532' | '5533' | '5541' | '5611' | '5621' | '5641' | '5651' | '5655' | '5661' | '5691' | '5697' | '5699' | '5722' | '5732' | '5733' | '5734' | '5735' | '5812' | '5813' | '5814' | '5815' | '5817' | '5912' | '5921' | '5940' | '5941' | '5942' | '5943' | '5945' | '5946' | '5947' | '5977' | '5992' | '5994' | '5995' | '6300' | '7011' | '7210' | '7211' | '7216' | '7217' | '7230' | '7276' | '7298' | '7342' | '7349' | '7372' | '7375' | '7379' | '7531' | '7534' | '7535' | '7538' | '7542' | '7549' | '7622' | '7629' | '7699' | '7832' | '7911' | '7922' | '7932' | '7933' | '7993' | '7994' | '7998' | '7999' | '8011' | '8021' | '8041' | '8042' | '8043' | '8049' | '8050' | '8099' | '8351' | '8398' | '8661' | '8931' | '8999', required — All options are listed here: https://docs.payarc.net/v1.1.0/docs/industry-codes
    - `MerchantName` string, required — Name of the merchant.
    - `LegalName` string, required — Legal name of the merchant.
    - `ContactFirstName` string, required
    - `ContactLastName` string, required
    - `ContactEmail` string, required
    - `Website` string, required
    - `IdentificationNumberType` '1' | '2' | '3', required — 1 - SSN, 2 - EIN, 3 - Other Tax ID
    - `MerchantSSN` string, required — Required if IdentificationNumberType = 1 ex: "999999999"
    - `TaxId` string — Required if IdentificationNumberType = 2 ex: "999999999"
    - `MerchantOtherTaxId` string — Required if IdentificationNumberType = 3 ex: "999999999"
    - `IrsFilingType` 'N' | 'A' | 'B' | 'F' | 'D' | 'C' | 'G' | 'J', required — N - Not Excluded, A - Foreign Entity Verification Pending, B - Foreign Entity Identified before 1/1/11, F - Foreign Entity Verified, D - Non Profit Verification Pending, C - Non Profit Verified, G - Government Entity, J - Financial Institution
    - `FoundationDate` string, date, required
    - `SalesDeliveryOffer` 'yes' | 'no', required — Do you offer delivery?
    - `SalesAnnualMastercard` string, required — ex: "123456"
    - `SalesDeliveryDays0Pct` integer, required — Percent 0 Day Deliveries, if you don't offer deliveries this defaults to 100
    - `SalesDeliveryDays1Pct` integer, required — Percent 1 to 7 Day Deliveries
    - `SalesDeliveryDays8Pct` integer, required
    - `SalesDeliveryDays15Pct` integer, required — Percent 15 to 30 Day Deliveries
    - `SalesDeliveryDays30Pct` integer, required — Percent of Deliveries over 30 days
    - `CardPresentPct` integer, required — Card Present Transactions
    - `MotoPct` integer, required — Card Not Present Transactions. This must equall to the sum of SalesKeyedInternetPct, SalesKeyedMailPct and SalesKeyedPhonePct
    - `SalesKeyedInternetPct` integer, required
    - `SalesKeyedMailPct` integer, required
    - `SalesKeyedPhonePct` integer, required
    - `SalesTradeshowPct` integer, required
    - `SalesTotalAnnual` integer, required — Must be more than 12xTotalMonthlyProcessing
    - `SalesB2BPct` integer, required — Sum of SalesB2BPct and SalesB2CPct must be 100
    - `SalesB2CPct` integer, required — Sum of SalesB2BPct and SalesB2CPct must be 100
    - `SalesCardB2BPct` integer, required — Sum of SalesCardB2BPct and SalesCardB2CPct must be 100
    - `SalesCardB2CPct` integer, required
    - `SalesProductServices` string, required — Sales Product Services description up to 600 chars
    - `MerchantBankName` string, required — ex: "International Bank"
    - `MerchantAccountAddress` string, required — Bank address. ex: "559 Timber Ridge Road"
    - `MerchantAccountCity` string, required — City of Bank address. ex: "Sacramento"
    - `MerchantAccountState` 'AR' | 'AS' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'FM' | 'GA' | 'GU' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MH' | 'MI' | 'MN' | 'MO' | 'MP' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'PW' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VI' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY', required — State of Bank Address ex: "CA"
    - `MerchantZipCode` string, required — Zip code of Bank Address.
    - `DateIncorporated` string, date, required
    - `OfficeCity` string, required — ex: "Sample City"
    - `OfficeZipCode` string, required — Zip code.
    - `OfficeState` 'AR' | 'AS' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'FM' | 'GA' | 'GU' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MH' | 'MI' | 'MN' | 'MO' | 'MP' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'PW' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VI' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY', required
    - `CustomerSupportNumber` string, required — ex: "3234567890"
    - `RegisteredZipCode` string, required — Zip code.
    - `RegisteredCity` string, required — ex: "Sample City"
    - `Country` string, required
    - `RegisteredAddress` string, required — ex: "Sample string 7"
    - `RegisteredState` 'AR' | 'AS' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'FM' | 'GA' | 'GU' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MH' | 'MI' | 'MN' | 'MO' | 'MP' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'PW' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VI' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY', required
    - `BankAccountNo` string, required — ex: "123456789"
    - `BankRoutingNo` string, required — ex: "123456789"
    - `BankAccountType` '01' | '02', required — "01" - Checking, "02" - Saving
    - `OwnershipType` 'L' | 'G' | 'N' | 'S' | 'X' | 'U' | 'V' | 'O', required — L - Limited Liability co, G - Government, N - Partnership, S - Association/Estate/Trust, X - Tax Exempt Organisation, U - Public Corp, V - Private Corp, O - Proprietorship
    - `TotalMonthlyProcessing` string, required — ex: "5000.0"
    - `AvgTicketValue` string, required — ex: "5.0"
    - `HighTicketValue` string, required — ex: "50.0"
    - `SalesDeliveryDays` string — ex: "0"
    - `OfficeAddress` string
    - `ContactPhoneNo` string
    - `StateOfIncorporation` string
    - `BusinessSummary` string
    - `CurrentyAcceptCreditCards` 'yes' | 'no'
    - `ProcessingTerminated` 'yes' | 'no'
    - `Bankruptcy` 'yes' | 'no'
    - `CommentsOther` string
    - `DriverLicenseOrId` string — ex: "1234567890"
    - `MerchantAmexProcessingPerYear` number, double — Conditionally Required if (TotalMonthlyProcessing * 12) > 1000000
  - `BlendedRatePricing` object
    - `BlendedBaseCharge` string, required — ex: "0.5"
    - `BlendedChargePct` string, required — % ex: "5.0"
    - `AmexOptBlue` '0' | '1' — Enable Amex Opt Blue
    - `AmexBaseCharge` string — ex: "0.5"
    - `AmexChargePct` string — % ex: "5.0"
    - `DailyFee` string — ex: "0.5"
    - `WeeklyFee` string — ex: "1.0"
    - `MonthlyFee` string — ex: "2.0"
    - `ChargebackFee` string — ex: "5.0"
    - `ChargebackPercFee` string — % ex: "10.0"
    - `FiservDiscountRateFeePct` string — % ex: "4.0"
    - `FiservTransactionFee` string — ex: "0.05"
    - `FiservMonthlySplitFundingFee` string — ex: "0.45"
    - `FiservGatewayMonthlyFee` string — ex: "10.0"
    - `FiservGatewayTransactionFee` string — ex: "0.05"
    - `FiservGatewayTransactionFeePct` string — % ex: "2.0"
    - `FiservAmexSponsorFeePct` string — % ex: "2.0"
    - `FiservBatchFee` string — ex: "0.45"
    - `FiservSplitFundingFee` string — ex: "0.45"
    - `FiservTokenizationFee` string — ex: "0.5"
    - `FiservMonthlyMinimumFee` string — ex: "15.0"
  - `Owners` object — Passing this object will cause the whole owners field to be overwritten.
    - `WebsitePayments` 'No' | 'Yes' | 'NoWebSite'
    - `SSLProvider` string
    - `ProdSoldNorthAmericaPct` integer
    - `ProdSoldEuropePct` integer
    - `ProdSoldOtherMarketsPct` integer
    - `SellBusinessPct` integer
    - `SellConsumerPct` integer
    - `ReturnPolicy` 'GreaterThan30Days' | 'LessThan30Days' | 'NoReturns' | 'OtherReason'
    - `NoRefundsInfo` string
    - `ReturnPolicyOther` string
    - `MonthlyRefundsPct` integer
    - `RefundDays` integer
    - `Refund100Pct` boolean
    - `RefundLess100PctInfo` string
    - `WhenIsCustomerCharged` 'ShipmentOrCompletionOfService' | 'Order'
    - `IsShipmentTraceable` boolean
    - `IsDeliveryReceiptRequested` boolean
    - `OrderTurnaroundTime` integer
    - `AdvancedDeposits` boolean
    - `DepositPct` integer
    - `DepositAmt` number, double
    - `WarehouseAddress` string
    - `WarehouseCity` string
    - `WarehouseState` string
    - `WarehouseCountry` string
    - `WarehouseZipCode` string
    - `OwnProductAtTimeOfSale` boolean
    - `OtherCompaniesInvolved` boolean
    - `OtherCompaniesInvolvedInfo` string
    - `AdvertiseInfo` string
    - `WhoEntersCardInfo` 'Consumer' | 'FulfillmentCenter' | 'Merchant'
    - `IsProcessingSeasonal` boolean
    - `ProcessingSeasonalMonth1` boolean
    - `ProcessingSeasonalMonth2` boolean
    - `ProcessingSeasonalMonth3` boolean
    - `ProcessingSeasonalMonth4` boolean
    - `ProcessingSeasonalMonth5` boolean
    - `ProcessingSeasonalMonth6` boolean
    - `ProcessingSeasonalMonth7` boolean
    - `ProcessingSeasonalMonth8` boolean
    - `ProcessingSeasonalMonth9` boolean
    - `ProcessingSeasonalMonth10` boolean
    - `ProcessingSeasonalMonth11` boolean
    - `ProcessingSeasonalMonth12` boolean
    - `MembershipPayments` boolean
    - `MembershipPaymentsPct` number, double
    - `PackageUsageTime` integer
    - `WhoManagesRecurringPayments` 'PayArcsVaultModule' | 'Other'
    - `RecurringPaymentProvider` string
    - `CaptureAVS` boolean
    - `CaptureAVSAction` 'Decline' | 'SendResponse'
    - `CaptureCVV` boolean
    - `PerformVerifiedByVisa` boolean
    - `DoPayArcFraudCheck` boolean
    - string
  - `TSQuestionery` object
    - `MerchantCurvPos` integer, required — Responsible for indicating if the merchant will use Curv tools or not. If CURV tools are not needed set 0.
    - `TerminalType` string[], required — with 0..2 items one is "emv" other is “3rdParty” this parameter allows you to select the type of the terminal to be used. If “3rdParty” makes sense to use “TerminalType3rdParty” of type string with max 256 chars as description of the terminal type.
    - `TerminalGatewaySetup` string, required — values “payarc” or “agent” indicates who is in charge to set-up the gateway.
    - `TerminalGateway` string, required — Values “ePay”, “nmi”, “payarc” and “authorize.net”. It is used to set the way terminal is comunicating. In case you must set USAePay you have to use value “ePay” as well not mandatory comment in “TerminalGatewayUSAePay“ of type string max 254 chars.
    - `TerminalPinDebit` string, required — with values ‘yes’, ‘no’ is responsible for Pin-debit Enabled (Customer will have to enter PIN) if set to ‘yes’.
    - `TerminalEbtFns` string, required — with values “yes”, “no”, if set to “yes” the the EBT number mist be provide in attribute “MerchantEbtFnsNumber” of type string max 254.
    - `TerminalPrimaryMethod` string, required — with values “wifi”, “ethernet” or “4g” determines the physical connection of a terminal.
    - `TerminalEmvQuantity` object — JSON object used to enumerate the physical devices. This object could have following attributes: "dejavoo", "dejavoo", "pax" representing the maker of the terminal, those attributes are JSON object as well consisting of attributes equal to the model of the terminal. Those attributes are int values that indicates the quantity of the teminals
      - `dejavoo` object — Maker of the terminal
        - `qd2` integer — Model
        - `qd3` integer — Model
        - `qd2wifi` integer — Model
        - `qd4` integer — Model
        - `qd5` integer — Model
        - `z11` integer — Model
        - `z8` integer — Model
        - `z9` integer — Model
      - `mobileReaders` object — Maker of the terminal
        - `b250` integer — Model
        - `bbpos` integer — Model
        - `idynamo5` integer — Model
      - `pax` object — Maker of the terminal
        - `a80` integer — Model
        - `a920` integer — Model
        - `a920pro` integer — Model
        - `sp30` integer — Model
        - `sp300` integer — Model
    - `TerminalPaxPos` string, required — with values “payarc”, “SwipeSimple”, “TSYSTransit” and “TSYSSierra” is responsible for pax pos method.
    - `TerminalDejavooPosDebit` string, required — with values “retail” and “restaurant” is responsible for debit type of dejavoo terminal
    - `TerminalDejavooPosCash` string, required — with values “retail” and “restaurant” is responsible for cash type of dejavoo terminal
    - `TerminalDejavooPosGift` string, required — with values “retail”, “valutec”, “gift” and “restaurant” is responsible for cash type of dejavoo terminal. If value is gift it is possible to add additional information as string max 254 for the following attributes: “TerminalDejavooPosGiftCid”, “TerminalDejavooPosGiftIAuth”, “TerminalDejavooPosGiftIPass”, “TerminalDejavooPosGiftLid”, “TerminalDejavooPosGiftTId”
    - `TerminalBatchAutoClose` string, required — with values “yes” and “no” is indicating the day closure batch. in case “no”, you will manually batch out every day. (WARNING: this may cause lost batches). In case of “yes” you have to specify the HH:MM when this will happen in attribute “TerminalBatchAutoTime”.
    - `TerminalOptionTip` string — with values “no”, “tips”, “both” and “custom” is responsible for allowing customers to leave tips. In case “custom” is selected it will be an empty line for the tip, if “both” also add suggested tip amounts (i.e., 15% = $##.##, 18%=$##.##, 20% = $##.##). If “tips” at time of sale with suggested tip amounts (i.e., 15% = $##.##, 18%=$##.##, 20%=$##.##), and= if “no” no tips are allowed.
    - `TerminalTrackClerks` string, required — with values “yes” and “no” will allow you to track servers/clerks that check out guests.
    - `TerminalOptionInvoice` string, required — with values “yes” and “no” give you ability to enter Invoice or Order numbers.
    - `TerminalOptionTax` string, required — with values “yes” and “no” allows you to add tax to the amount, tax could be city and state tax. Amounts are set with additional attributes “TerminalStateTaxPct” and “TerminalCityTaxPct”.
    - `TerminalCityTaxPct` number, float, required — with min 0.00 max 100.00 is representing the % of the city tax.
    - `TerminalStateTaxPct` number, float, required — with min 0.00 max 100.00 is representing the % of the state tax
    - `TerminalOptionSignature` string, required — with values “yes” and “no” is responsible for signature line in the receipt.
    - `TerminalHeader` string — max 50 chars is responsible for specific text in the header of the receipt. If no specific header is needed omit this property in the flow.
    - `TerminalFooter` string — max 50 chars is responsible for specific text in the footer of the receipt. If no specific footer is needed omit this property in the flow.
    - `TerminalDeployment` string, required — with values “agent”, “merchant” and “other” is responsible for indicating how the terminal will be delivered to merchant. If agent is selected the terminal(s) will be sent to agent's address if merchant is selected the terminal(s) will be sent to merchant's address. If other is selected the terminal will be sent to address compound of the following attributes: “TerminalShippingName”, “TerminalShippingContactName”, “TerminalShippingAddress”, “TerminalShippingCity” “TerminalShippingState”, “TerminalShippingZipCode”, “TerminalShippingPhoneNo”
    - `TerminalShippingName` string — max 50 chars is the addressee's name
    - `TerminalShippingContactName` string — max 100 chars is the addressee's contact name
    - `TerminalShippingAddress` string — max 32 chars is the address line 1
    - `TerminalShippingCity` string — max 13 chars is the destination city
    - `TerminalShippingState` string — max 2 chars is the state code, upper case
    - `TerminalShippingZipCode` string — max 6 chars is the zip code
    - `TerminalShippingPhoneNo` string — max 10 digits is the addressee’s phone.
    - `TerminalShippingPreferred` string — with values “ground” “2ndDay” and “saturday” is to determine Fedex Preferred Shipping mode.
    - `TerminalComments` string — max 254chars is responsble for additional comments you might need to add to terminal questionary

## Response `200`

200

- object
  - `data` object
    - `object` string
    - `id` string
    - `name` string
    - `industry` string
    - `isv_merchant_type` unknown
    - `isv_process_own_transactions` unknown
    - `merchant_category` unknown
    - `hubspot_record_id` unknown
    - `bank_account_type` unknown
    - `agent_name` string
    - `apply_pricing_template_id` unknown
    - `apply_pricing_template_name` string
    - `step` unknown
    - `is_copied` integer
    - `created_at` string
    - `updated_at` string
    - `status` string
    - `completed` integer
    - `lead_status` unknown
    - `status_id` integer
    - `signature_override` integer
  - `meta` object
    - `include` unknown[]
      - unknown
    - `custom` unknown[]
      - unknown

## Other responses

- `422` — 422

---

[API](https://skmtc.net/payarc/apis/payarc-sandbox.md) · [All operations](https://skmtc.net/payarc/apis/payarc-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payarc/payarc-sandbox/revisions/face82bdd778/schema)