Paysafe Instore 2019 API Partner Communication

Overview

In order to submit new applications to Paysafe Instore, new packages have been created with the field changes listed below. Existing packages will continue to be supported for a limited time during the transition time, but will not board to Instore. The new packages will be tentatively available in the development sandbox by XXXX XX.

One of the most significant changes is that Paysafe Instore has a new equipment catalog. While many of the devices in the catalog are the same as in the old iPayment equipment catalog, it’s necessary to keep those catalogs separate.

Fortunately, we were able to do that without changing the shape of the JSON you send to describe the equipment. However, the equipment in the Paysafe Instore catalog must have different IDs, even for identical equipment, and the SectionIDs, GroupIDs, FieldIDs and the values of those fields need to be different.

For those of you that deploy your own equipment, we acknowledge that this is an inconvenience, but it is necessary to integrate with the Paysafe Instore back-office system.

Here are the specific changes you’ll need to accommodate:

Field Changes

The following field changes are required to successfully submit an application.



CategorySub-categoryActionNameDescriptionFieldIDRequired?Additional Notes
Payment ProcessorBackEndAddBack EndPayment Processor / Processor / Backend489A219C-B1BF-4DB8-A048-34DD379A4213
  • Always 8FD5B3DB-E080-4A11-9B9F-1402FA57790B (Omaha) until other backend support is added
Business InformationApplication TypeAddApplication TypeBusiness Information / Application Type / Application Type637627F4-1604-41B7-9F61-6F4D371BCBA2
  • Expressed an integer value
  • Options:
    • 1 (New Account)
    • 2 (Additional Location)
    • 3 (Ownership Change)
    Business InformationApplication TypeAddMain Location MIDBusiness Information / Main Location MID / Main Location MID9C52CFA0-804B-4C58-A078-7BD9EC37C50D  
    Business InformationApplication TypeAddPrevious Owners MIDBusiness Information / Previous Owners MID / Previous Owner's MID4795959F-C0DA-48C7-8B90-AFE336D743D1  
    Business Information AddMonths with previous processorBusiness Information / Prior Merchant Account / Months with previous processor53f6ae01-27d9-485c-a777-6fb271b137b3Conditionally, see notes
    • Required if "Have you processed credit cards before?" is true
    Business Information AddYears with previous processorBusiness Information / Prior Merchant Account / Years with previous processor12f54718-809e-4c5c-a5f2-db0ed3f4d27cConditionally, see notes
    • Required if "Have you processed credit cards before?" is true
    Business InformationBusiness AddressRemoveLocationCountyBusiness Information / Business Address / CountyAB964D29-EDCE-4C8E-B74A-7BDFEF049ADC  
    Business InformationBusiness AddressRemoveYearsAtAddressBusiness Information / Business Address / Years at Address465F1216-EAB1-46C8-819F-19BD8D281599  
    Business InformationBusiness AddressRemoveMonthsAtAddressBusiness Information / Business Address / Months at AddressAA19BF78-74E2-4405-A871-282C04CAB7A5  
    Business InformationBusiness DetailsChangeNumberOfLocationsBusiness Information / Business Details / Number of Locations621BF71F-0B39-4157-9425-2C7E137C48ED
    • Previously optional
    Business InformationBusiness DetailsRemoveBusinessHoursBusiness Information / Business Details / Business Hours00005C01-89EC-45B0-B711-8216F49B5F3F  
    Business InformationBusiness DetailsRemoveYearsInBusinessBusiness Information / Business Details / Years in BusinessB2EC8880-BB1B-412C-B92D-98691272A5E0  
    Business InformationBusiness DetailsRemoveMonthsInBusinessBusiness Information / Business Details / Months in Business229898D1-2F6A-4465-9A7A-2BF9F6263183  
    Business InformationBusiness To BusinessRemoveIsB2BBusiness Information / Business To Business / Business to Business73DC6303-9D31-4E57-9877-B9ED221DB3D4  
    Business InformationBusiness To BusinessRemoveB2BPercentBusiness Information / Business To Business / B2B %1FA263B8-04C6-428A-9DBD-271E8C0B855D  
    Business InformationBusiness To BusinessRemoveB2CPercentBusiness Information / Business To Business / B2C %BB8453F5-68CE-456D-A353-E27DA93D8B31  
    Business InformationContact InformationRemoveMainEmailNotProvidedBusiness Information / Contact Information / Don't have email054528E5-A118-4D0D-B819-D37E59BDC225  
    Business InformationPrior Merchant Account ClosureRemoveCreditCardProcessorPriorClosureExplainationBusiness Information / Prior Merchant Account Closure / Explanation for prior closure74F78779-A5C0-4611-B41F-7A83929ED19B  
    Business InformationPrior Merchant Account ClosureRemoveHasCreditCardProcessorPriorClosureBusiness Information / Prior Merchant Account Closure / Have you ever been terminated from a processor before?76345FA9-5798-45C2-88A1-E3A8589512A5  
    Business InformationPrior Merchant Account ClosureRemoveCreditCardProcessorPriorClosureWhomBusiness Information / Prior Merchant Account Closure / If Yes, by whom?D182E305-AEF1-432D-B2D4-EA873C4EB04C  
    Business InformationSales Transaction SettlementRemoveIs MasterCard Visa Amex Discover SalesTransactions SettledBusiness Information / Sales Transaction Settlement / MasterCard/Visa sales transactions are settled3895802A-071E-465C-9A70-CD55CDFF3BDA  
    Business InformationSales Transaction SettlementRemoveMasterCard Visa Amex Discover SalesTransactions Settled DescriptionBusiness Information / Sales Transaction Settlement / Sales Transaction Settlement Description65C6A776-AD41-42D1-9A8A-DBF7255D08E0  
    Business InformationSite SurveyRemoveTypeOfBuildingBusiness Information / Site Survey / Type of Building5536CF2B-E42D-4E54-919B-0A8C5108FDAD  
    Business InformationSite SurveyRemoveInspectorCommentsBusiness Information / Site Survey / Inspectors Comments5FCE0264-C4D9-4BFC-8A04-68D789ABB03D  
    Business InformationSite SurveyRemoveSquareFootageBusiness Information / Site Survey / Square FootageB501A5DA-4CDD-4FEC-8DBB-DE594B4DF3C5  
    Business InformationThird Party Cardholder Data Service UsageRemoveUsesThirdPartyDataBusiness Information / Third Party Cardholder Data Service Usage / Merchant Uses Third Party Cardholder Data ServiceBE63217E-9A2A-4826-BFF7-B3EE39D9E3AF  
    Business InformationThird Party Cardholder Data Service UsageRemoveThirdPartyInformationVerbiage / Third Party InformationE6C4C39F-F178-4172-B6AB-95BB63FA3B54  
    Business InformationThird Party Cardholder Data Service UsageRemoveThirdPartyDataNameBusiness Information / Third Party Cardholder Data Service Usage / NameF24CC1BE-8AD1-4811-9EE0-D0067B07B0E0  
    Business InformationThird Party Cardholder Data Service UsageRemoveThirdPartyDataAddressBusiness Information / Third Party Cardholder Data Service Usage / Address843D2C2A-3898-493D-8298-52E10FA54D28  
    Business InformationThird Party Cardholder Data Service UsageRemoveThirdPartyDataPhoneBusiness Information / Third Party Cardholder Data Service Usage / PhoneC9C748FA-4341-4B0D-B6E3-43E5590F8C80  
    Business InformationThird Party Cardholder Data Service UsageRemoveThirdPartyDataSoftwareBusiness Information / Third Party Cardholder Data Service Usage / Software Used by Third Party1EFAB3E4-E685-4FFE-9E42-71D503D62243  
    Business InformationThird Party Cardholder Data Service UsageRemoveThirdPartyDataCityBusiness Information / Third Party Cardholder Data Service Usage / CityDA8F3406-65D7-4C4E-8069-A02304AAB0C8  
    Business InformationThird Party Cardholder Data Service UsageRemoveThirdPartyDataStateBusiness Information / Third Party Cardholder Data Service Usage / StateACD7C570-D55D-47D4-952D-D5EBEDE9B1CA  
    Business InformationThird Party Cardholder Data Service UsageRemoveThirdPartyDataZipBusiness Information / Third Party Cardholder Data Service Usage / ZipDC89EBF8-777C-43A0-80BF-E65C9E4FF09D  
    Business InformationThird Party Cardholder Data Service UsageRemoveThirdPartyDataSoftwareVersionBusiness Information / Third Party Cardholder Data Service Usage / Software Version7C38CF0C-D33F-4DE8-869A-0C2A84CBA43E  
    Business InformationDelivery ScheduleAddPercentDepositOrFutureBusiness Information / Delivery Schedule / Percentage of Business Deposits / Future ServicesEEB6D76C-8746-4439-A118-D6E4515B3ED7  
    Business InformationDelivery ScheduleAddPercentDepositRequiredBusiness Information / Delivery Schedule / Percentage Deposit RequiredFAFA043D-109B-49B4-BAA2-295D5507644E  
    Business InformationDelivery ScheduleAddIncrementalPaymentsBusiness Information / Delivery Schedule / Incremental Payments (Percentages)A4EAC6C4-EC13-4796-956F-FEEE5080BE6E  
    Business InformationDelivery ScheduleAddIncrementalPayment1Business Information / Delivery Schedule / 1st Payment4C94EEBD-FB51-4650-9BE7-7D53517FDCFD  
    Business InformationDelivery ScheduleAddIncrementalPayment2Business Information / Delivery Schedule / 2nd Payment6E6B48A8-D752-4CEF-BF37-C32CFEC0C0A0  
    Business InformationDelivery ScheduleAddIncrementalPayment3Business Information / Delivery Schedule / 3rd PaymentC220E57D-758A-4E3F-87D9-59D51AC64D2E  
    Business InformationDelivery ScheduleAddIncrementalPayment4Business Information / Delivery Schedule / 4th Payment3A2EDC07-5C5F-45EB-911B-BA56BA6C63D9  
    Business InformationBusiness DetailsAddDateBusinessStartedBusiness Information / Business Details / Date Business Started3FB604BC-DD65-4E18-823B-C934240D38C3  
    Business InformationReturn PolicyChangeCustomerReturnPolicyBusiness Information / Return Policy / Customer Return Policy31AEB8BB-C0D2-4670-9B79-4496B17A2ADE 
    • New option added:
      • Refundwithin7Days (Refund within 7 days)
    Business InformationOwnershipChangeBusinessLocationTypeBusiness Information / Ownership / Business Location8020A5B0-ADAC-44BC-AC49-008DC9474578 
    • New option added:
      • Warehouse (Warehouse)
    Business InformationProcessing LimitsAddMonthlyAmexVolumeBusiness Information / Processing Limits / Monthly Amex Volume1C8B0F0B-27EB-41EE-AD7C-8D55D4A891BDConditional, see notes
    • Required if application includes Amex
    Business InformationSeasonal MerchantAddSeasonalMonthStart Business Information / Seasonal Merchant / Seasonal Month Start547EC0FC-8834-4AF7-B339-A5783D192638 
    • Value is full month name (ie. January, March, October)
    Business InformationSeasonal MerchantAddSeasonalMonthEnd Business Information / Seasonal Merchant / Seasonal Month End32599727-1F21-4C16-9F8E-F678A54E8607 
    • Value is full month name (ie. January, March, October)
    Other InformationSite SurveyAddAreaZonesBusiness Information / Site Survey / Area Zones1D60B370-CB20-45A0-87E2-794670A5EDD2 
    • Options:
      • Commercial
      • Industrial
      • Residential
    Other InformationSite SurveyAddPermanentSignageBusiness Information / Site Survey / Permanent Signage?4053CE8D-3024-4B50-ADB3-2A711ED83442 
    • boolean value
    Other InformationSite SurveyAddIsBusinessLegitimateBusiness Information / Site Survey / Is business legitimate?EDADE85C-9DE2-47B6-989D-19B061C951E5 
    • boolean value
    Other InformationSite SurveyAddInventoryConsistentWithbusinessBusiness Information / Site Survey / Inventory consistent with business?DC1E105E-8020-4658-B816-9419E24AB4FC 
    • boolean value
    Other InformationSite SurveyAddBusinessLocationBusiness Information / Site Survey / Business LocationE98FAAF9-FC47-4F08-B11F-2DFF361151AF 
    • Options:
      • Leased
      • Owned
    Product, Advertising, Sales and DeliveryInternational CardsAddInternationalCardTransactionPercentageBusiness Information / International Cards / What percentage of sales transactions are with international cards4736F796-89FC-4B3F-B94A-B0F78EEACB56  
    Product, Advertising, Sales and DeliveryProduct OwnershipAddProductOwnerProduct, Advertising, Sales and Delivery / Product Ownership / Who owns the product?3514A5A6-3E6A-45D6-908B-0C535DFB291F 
    • Options:
      • Merchant
      • Vendor
    Product, Advertising, Sales and DeliveryProduct OwnershipAddPrimaryProductVendorNameProduct, Advertising, Sales and Delivery / Product Ownership / Primary Product Vendor Name7FD3A255-D15A-459E-883C-FCFE944F5C92Conditional, see notes
    • Required if ProductOwner is Vendor
    Product, Advertising, Sales and DeliveryProduct OwnershipAddPrimaryProductVendorCityProduct, Advertising, Sales and Delivery / Product Ownership / Primary Product Vendor CityCFEDC6CC-28E2-408A-A06C-61C538662C60Conditional, see notes
    • Required if ProductOwner is Vendor
    Product, Advertising, Sales and DeliveryProduct OwnershipAddPrimaryProductVendorStateProduct, Advertising, Sales and Delivery / Product Ownership / Primary Product Vendor StateEF04F0D7-0991-4D1C-8834-B0F7F4E3BEC7Conditional, see notes
    • Required if ProductOwner is Vendor
    Product, Advertising, Sales and DeliveryProduct OwnershipAddSecondaryProductVendorNameProduct, Advertising, Sales and Delivery / Product Ownership / Secondary Product Vendor Name7A7A9D28-2168-4191-B1F5-81F4BAA41D0E  
    Product, Advertising, Sales and DeliveryProduct OwnershipAddSecondaryProductVendorCityProduct, Advertising, Sales and Delivery / Product Ownership / Secondary Product Vendor City29057AD5-5636-480E-989B-9748225C666B  
    Product, Advertising, Sales and DeliveryProduct OwnershipAddSecondaryProductVendorStateProduct, Advertising, Sales and Delivery / Product Ownership / Secondary Product Vendor State204EA4F5-D90F-4C82-806B-3B5E100104EB  
    Bank InformationBank InformationAddAccountTypeBank Information / Bank Information / Account Type776222CA-936D-4DFA-AEFC-851F8AC52F32
    • Options:
      • Checking
      • Savings
      • General Ledger
    Bank InformationAlternate DDAAddAlternateAccountTypeBank Information / Alternate DDA / Alternate Account Type3D51C0E0-2A15-4180-89E5-908B83A29CBBConditional
    • Required if alternate bank account number is provided
    • Options:
      • Checking
      • Savings
      • General Ledger
    Bank InformationBank InformationRemoveBankStateBank Information / Bank Information / State7E9239A0-A4AD-4E75-A86A-94DE5D9C5E4F  
    Bank InformationBank InformationRemoveBankAddressBank Information / Bank Information / Bank Address937BFED3-EC92-404C-B47B-2F755DE1AA85  
    Bank InformationBank InformationRemoveBankBranchPhoneBank Information / Bank Information / Bank Phone430E9C4F-F081-41A9-A492-62C05268AD81  
    Bank InformationBank InformationRemoveBankBranchBank Information / Bank Information / BranchD4643737-4124-41D0-9F45-60F16F8A7553  
    Bank InformationBank InformationRemoveBankCityBank Information / Bank Information / City2122D5D1-2937-4996-A6EF-0738159FDDF1  
    Bank InformationBank InformationRemoveBankContactNameBank Information / Bank Information / Contact Name91C44687-2957-4586-B3F3-C1ECD7B6C396  
    Bank InformationBank InformationRemoveBankZipBank Information / Bank Information / ZipC4D30B9F-CF86-41BC-B511-E4D1C409F47A  
    Bank InformationAlternate DDARemoveAlternateBankBranchBank Information / Alternate DDA / Branch059462F7-4205-4977-8B6C-2F2413A87C3C  
    Bank InformationAlternate DDARemoveAlternateBankAddressBank Information / Alternate DDA / Bank Address990DD0F2-A829-4ECC-A1EB-8A67A606BBBD  
    Bank InformationAlternate DDARemoveAlternateBankCityBank Information / Alternate DDA / City08D1AE40-731D-46F8-A508-E226560E95DF  
    Bank InformationAlternate DDARemoveAlternateBankStateBank Information / Alternate DDA / StateB9D97CE7-CFF6-4B02-9CAF-A66D5EE9595E  
    Bank InformationAlternate DDARemoveAlternateBankZipBank Information / Alternate DDA / ZipA9A2E49D-228F-4E60-B916-A795622E5291  
    Bank InformationAlternate DDARemoveAlternateBankBranchPhoneBank Information / Alternate DDA / Bank Phone6B6C5A57-CD0D-491C-BA5F-DCDEDC4AE84A  
    Bank InformationAlternate DDARemoveAlternateBankContactNameBank Information / Alternate DDA / Contact NameA9F5D270-4319-4FB4-BBBF-3C9AE6BF4433  
    Bank InformationFunding InformationAddDiscountMethodBank Information / Bank Information / Discount Method6DC6F0B7-172C-4AAA-9247-0D8AFB6A597B
    • Replaces month-end discount field (see Card Acceptance section)
    • Options:
      • Daily
      • Monthly
    Bank InformationFunding InformationAddDepositTimeFrameBank Information / Funding Information / Deposit Time Frame59939529-EB4A-49C0-AEA8-51576D92EE38
    • Options:
      • Standard
      • AlternateFunding
    Principal # InformationPrincipalRemovePrincipalRunCreditReportPrincipal # Information / Principal / Run Credit Report?05AB4381-0161-437B-B997-81E24706C588  
    Principal # InformationPrincipalAddPrincipalCellPhonePrincipal # Information / Principal / Cell Phone0AB20B1C-412C-4D11-A252-A9A9294070A5  
    Principal Information AddBusinessTitlePrincipal # Information / Principal / Business Title33512D7E-F245-436F-AB24-E17CB5603934
    • Lookup field, see options in the Appendix
    • Replaces PrincipalTitle
    Principal Information RemovePrincipalTitlePrincipal # Information / Principal / Business TitleC16FAB40-476C-4F02-A3D2-64EBFF1A4FCA  
    Fee InformationMiscellaneous FeesChangeReserve Maintenance FeeFee Information / Miscellaneous Fees / Security Research Fee45750227-60A5-4BDF-B500-567060786418 
    • Renamed to "Security Research Fee"
    Fee Information Miscellaneous Fees Change iAccessFee* Fee Information / Miscellaneous Fees / iAccess Fee * 3B926C15-3026-4699-8083-4D29AF1C5CB1 D74FC3CB-E75E-4C64-9AFF-63C92CC58C65 C4A773DB-B75E-4E5B-ACF4-FB86B90BDFB6 3A59826B-3F5B-434D-9D21-76059F77D064 461B5DE1-89CD-44D0-A407-7712B3E59D99  
    • Renamed all to "Online Acceess Fee"
    Fee Information Change *SettledTransactionFee* 4D74FC2A-5CEA-4443-9067-92ECBB81528A AC9E865E-CC4E-417C-9F12-A672D38737C7 45750227-60A5-4BDF-B500-567060786418 7EC43ECB-7278-4FD8-AC4A-F193AE4DBFF7 E956D606-B680-4E5C-93C5-9D7EF3EFA24F 98E2F317-1621-4956-B889-36716B7EA6B6 28046CD1-B03D-45D9-8DC9-12599D4A6442 EC209001-1121-48D1-8007-432AD714FDBC BECB8C5C-D635-4C55-B6BF-20BE8A4CC037 1760CA25-B573-43F4-8702-7F0155F754B4 11C6D3C6-4750-4254-B8FB-A143EB6BD5B5 817A4D32-D4EF-4EC0-AAF3-7E6E02BA5665 8B4A5E73-2F8C-4527-94F6-0418DC0164B2  
    • Renamed all to "Other Item Fee"
    EquipmentEquipment ItemsAddOwnershipEquipment / Equipment / Ownership059534b0-19ac-46b4-9ea3-effa8ee4b788
    • Use equipmentownershiptypes lookup to get values
    EquipmentEquipment ItemsAddIndustryEquipment / Equipment / Industry92DC70DC-0E61-487A-8497-E30970A0A3EA
    • Use Industries lookup to get values
    • Must be valid for the selected merchant type
    EquipmentShipping/PaymentAddPaymentMethodEquipment / Shipping & Payment / Payment Methodf041082b-1f4c-41eb-ab6f-fbd3562b35b0Conditionally, see notes
    • Required if the "Ownership" type is "Purchase" and must NOT be passed for any other value
    • Options:
      • Merchant ACH
      • Agent ACH
      • Residual (if enabled)
      • Free Equipment (if enabled)
    EquipmentShipping/PaymentAddShippingMethodEquipment / Shipping & Payment / Shipping Method83791e2a-20f6-4b8e-982b-1e7152f0d104Conditionally, see notes
    • Required if the "Ownership" type is "Purchase" and must NOT be passed for any other value
    • Options:
      • Express Saver_Ground
      • 2 or 3 Day
      • Priority Overnight
      • Standard Overnight
      • Saturday Delivery
    EquipmentShipping/PaymentAddShipToEquipment / Shipping & Payment / Ship Tob2163e66-a8bf-453a-8aca-107fa1aeafbeConditionally, see notes
    • Required if the "Ownership" type is "Purchase" and must NOT be passed for any other value
    • Options:
      • Merchant Physical
      • Merchant Corporate
      • Agent Office
    EquipmentAccessoriesAddTypeEquipment / Peripherals / Type5577026d-444d-4e46-8b98-5c4e89605168
    • Field is required for all accessories added
    EquipmentAccessoriesAddItemEquipment / Peripherals / Item7406cbf3-4a9e-4441-bf6d-889431848d96
    • Field is required for all accessories added
    • The type/item combination must be valid
    • The item must be allowed for the selected device
    EquipmentAccessoriesAddQtyAccessory / Accessory / Qty6cf03ccb-e586-4970-9990-7cf87cbd6c86
    • Field is required for all accessories added
    • Qty must be >= 1
    Equipment*Remove    
    • Remove all equipment fields specific to Terminal, Gateway, or Software. See full list in the Appendix below.
    EquipmentAccessoriesRemove    
    • Remove all fields currently populating in ApplicationEquipmentPeripheral.FieldValue. See full list in the Appendix below.
    Card AcceptanceAdditional Setup RequirementsRemoveMonthEndDiscountCard Acceptance / Additional Setup Requirements / Month-End Discount Requested7E082B90-10F6-4CA8-9BFE-3B6A538BBAA6  
    Fee Information3-Tier Offline Debit Discount FeesChangeOfflineDebitSettledTransactionFeeFee Information / 3-Tier Offline Debit Discount Fees / Other Item Fee4D74FC2A-5CEA-4443-9067-92ECBB81528A 
    • PublicName renamed to "Other Item Fee"
    • PublicClassification updated to "Fee Information / 3-Tier Offline Debit Discount Fees / Other Item Fee"
    Fee Information3-Tier Credit Card Discount FeesChangeCreditCardSettledTransactionFeeFee Information / 3-Tier Credit Card Discount Fees / Other Item FeeAC9E865E-CC4E-417C-9F12-A672D38737C7 
    • PublicName renamed to "Other Item Fee"
    • PublicClassification updated to "Fee Information / 3-Tier Credit Card Discount Fees / Other Item Fee"
    Fee InformationAmerican Express Opt Blue 3-Tier RatesChangeAmericanExpressSettledTransactionFeeFee Information / American Express Opt Blue 3-Tier Rates / Other Item Fee7EC43ECB-7278-4FD8-AC4A-F193AE4DBFF7 
    • PublicName renamed to "Other Item Fee"
    • PublicClassification updated to "Fee Information / American Express Opt Blue 3-Tier Rates / Other Item Fee"
    Fee InformationInterchange Passthru FeesChangePassthruSettledTransactionFeeFee Information / Interchange Passthru Fees / Pass-Thru Other Item FeeE956D606-B680-4E5C-93C5-9D7EF3EFA24F 
    • PublicName renamed to "Pass-Thru Other Item Fee"
    • PublicClassification updated to "Fee Information / Interchange Passthru Fees / Pass-Thru Other Item Fee"
    Fee InformationAmerican Express Opt Blue Interchange RatesChangeAmericanExpressOptBlueInterchangePassthroughSettledTransactionFeeFee Information / American Express Opt Blue Interchange Rates / Other Item Fee98E2F317-1621-4956-B889-36716B7EA6B6 
    • PublicName renamed to "Other Item Fee"
    • PublicClassification updated to "Fee Information / American Express Opt Blue Interchange Rates / Other Item Fee"
    Fee InformationInterchange Passthru FeesChangePassthruCreditSettledTransactionFeeFee Information / Interchange Passthru Fees / Credit Other Item Fee28046CD1-B03D-45D9-8DC9-12599D4A6442 
    • PublicName renamed to "Credit Other Item Fee"
    • PublicClassification updated to "Fee Information / Interchange Passthru Fees / Credit Other Item Fee"
    Fee InformationInterchange Passthru FeesChangePassthruOfflineDebitSettledTransactionFeeFee Information / Interchange Passthru Fees / Offline-Debit Other Item FeeEC209001-1121-48D1-8007-432AD714FDBC 
    • PublicName renamed to "Offline-Debit Other Item Fee"
    • PublicClassification updated to "Fee Information / Interchange Passthru Fees / Offline-Debit Other Item Fee"
    Fee InformationERR (Enhanced Reduced Recovery) FeesChangeERRCreditSettledTransactionFeeFee Information / ERR (Enhanced Reduced Recovery) Fees / Credit Other Item FeeBECB8C5C-D635-4C55-B6BF-20BE8A4CC037 
    • PublicName renamed to "Credit Other Item Fee"
    • PublicClassification updated to "Fee Information / ERR (Enhanced Reduced Recovery) Fees / Credit Other Item Fee"
    Fee InformationERR (Enhanced Reduced Recovery) FeesChangeERROfflineDebitSettledTransactionFeeFee Information / ERR (Enhanced Reduced Recovery) Fees / Offline-Debit Other Item Fee1760CA25-B573-43F4-8702-7F0155F754B4 
    • PublicName renamed to "Offline-Debit Other Item Fee"
    • PublicClassification updated to "Fee Information / ERR (Enhanced Reduced Recovery) Fees / Offline-Debit Other Item Fee"
    Fee InformationAmerican Express Opt Blue ERR RatesChangeAmericanExpressERRSettledTransactionFeeFee Information / American Express Opt Blue ERR Rates / Other Item Fee11C6D3C6-4750-4254-B8FB-A143EB6BD5B5 
    • PublicName renamed to "Other Item Fee"
    • PublicClassification updated to "Fee Information / American Express Opt Blue ERR Rates / Other Item Fee"
    Fee InformationERR (Enhanced Reduced Recovery) FeesChangeERRSettledTransactionFeeFee Information / ERR (Enhanced Reduced Recovery) Fees / Other Item Fee817A4D32-D4EF-4EC0-AAF3-7E6E02BA5665 
    • PublicName renamed to "Other Item Fee"
    • PublicClassification updated to "Fee Information / ERR (Enhanced Reduced Recovery) Fees / Other Item Fee"
    Fee Information3-Tier Discount FeesChangeDiscountRateSettledTransactionFeeFee Information / 3-Tier Discount Fees / Other Item Fee8B4A5E73-2F8C-4527-94F6-0418DC0164B2 
    • PublicName renamed to "Other Item Fee"
    • PublicClassification updated to "Fee Information / 3-Tier Discount Fees / Other Item Fee"
    Product, Advertising, Sales and DeliveryProduct OwnershipChangeSecondaryProductVendorStateProduct, Advertising, Sales and Delivery / Product Ownership / Secondary Product Vendor State204EA4F5-D90F-4C82-806B-3B5E100104EB 
    • PublicName renamed to "Secondary Product Vendor State"
    • PublicClassification updated to "Product, Advertising, Sales and Delivery / Product Ownership / Secondary Product Vendor State"


    Products and Services Lookup

    The list of acceptable products & services for an app are now tied to the merchant type and card type. To prevent validation errors, we recommend using the products & services lookup endpoint to retrieve this list prior to submission.

    lookups/productandservices?merchantType={merchantType:string}&excludeAmexProhibited={bool}

    New optional parameters:

    The list and description of American Express prohibited products/services is available here for reference.

    Equipment Catalog

    The existing endpoints for getting information from the equipment catalog will not change and will continue to only return information from the old iPayment equipment catalog (except that lookups/equipmenttypes and lookups/peripheraltypes will show types for both catalogs).

    There are new endpoints for getting information from the new Paysafe Instore catalog. See the Swagger documentation for details about calling these endpoints.

    Note carefully that previously, because iPayment only supported one back-end processor, the ProcessorID property for each Equipment object corresponded to a ProcessorID found in a Terminal, Gateway, or Software object from the package. Because Paysafe Instore supports multiple back-end processors (though this API will be adding that support at a later date), the new package equipment search endpoint will need to be called to find the available back-end/front-end combinations available for the equipment and then the new payment processors lookup endpoint will need to be called to find the ProcessorID corresponding to that combination. (Of course, the results of these calls can be cached, but please refresh your cache at least nightly.)

    New equipment info endpoints

    Lookups
    Package Equipment (including Accessories [a.k.a. Peripherals])

    Public API Equipment Search

    See Swagger for “Equipment Search” endpoint API specification.

    This endpoint provides the ability to search for allowed combinations of the following fields:

    Each filter parameter allows search options:

    The response will include a filtered list of the allowed combinations, including only the data requested.

    Appendix

    Removed Equipment Fields

    The following terminal, software, and gateway fields have been removed and replaced with those listed above:

    Terminal
    • TerminalAdditionalFeatures
    • TerminalAdditionalServiceProvider
    • TerminalAdditionalTerminals
    • TerminalApplicationType
    • TerminalMobileInformationWirelessCarrier
    • TerminalMobileInformationWirelessCarrierDescription
    • TerminalMobileInformationCellPhoneNumber
    • TerminalPrinterShouldDeploy
    • TerminalShippingDeploymentDoneBy
    • TerminalEquipmentLocation
    • TerminalFrontEnd
    • TerminalIsReprogram
    • TerminalLoadHeldBy
    • TerminalLoadInstructions
    • TerminalMobileInformationManufacturer
    • TerminalMobileInformationModel
    • TerminalMultiMerchantTiedToMerchantNumber
    • TerminalNotes
    • TerminalPhoneDialOutCode
    • TerminalPhoneDialOutCodeDescription
    • TerminalPrinterModel
    • TerminalShipToType
    • TerminalShipTo_AlternateAddress_Address
    • TerminalShipTo_AlternateAddress_City
    • TerminalShipTo_AlternateAddress_FirstName
    • TerminalShipTo_AlternateAddress_LastName
    • TerminalShipTo_AlternateAddress_PhoneNumber
    • TerminalShipTo_AlternateAddress_State
    • TerminalShipTo_AlternateAddress_Zip
    • TerminalShippingService
    • TerminalSpecialPrompts
    • TerminalIsAutomaticClose
    • TerminalAutomaticCloseTime
    • TerminalAutomaticCloseTimeZone
    • TerminalBrand
    • TerminalModel
    • TerminalWirelessTcpIpGateway
    • TerminalWirelessType
    • TerminalBrandSummary
    • TerminalModelSummary
    • TerminalCheckReaderModelSummary
    • TerminalPinpadModelSummary
    • TerminalFrontEndSummary
    • TerminalMultiMerchant
    • TerminalApplicationTypeDescription
    • TerminalFrontEndDescription
    • TerminalAdditionalFeaturesCheckServiceProvider
    • IsFreeTerminal
    • TerminalConnectionType
    • TerminalServiceFee
    • TerminalPriceUnit
    • TerminalDeploymentFee
    • TerminalSwapFee
    • TerminalRestockingFee
    • TerminalConnectsTo
    • TerminalQuantity
    • TerminalSerialNumber
    • TerminalSerialNumberDisclaimer
    • TerminalConnectsToSoftware
    • TerminalConnectsToGateway
    Gateway
    • GatewayGatewayType
    • GatewayFrontEnd
    • GatewayFrontEndDescription
    • GatewayNotes
    • GatewayAdditionalServiceProvider
    • GatewayPrinterModel
    • GatewayPrinterShouldDeploy
    • GatewayPinPadModel
    • GatewayPinPadShouldDeploy
    • GatewayCheckReaderModel
    • GatewayCheckReaderShouldDeploy
    • GatewayCardReaderModel
    • GatewayCardReaderShouldDeploy
    • GatewayNameSummary
    • GatewayFrontEndSummary
    • GatewayBrandSummary
    • GatewayMobileInformationWirelessCarrier
    • GatewayMobileInformationWirelessCarrierDescription
    • GatewayMobileInformationCellPhoneNumber
    • GatewayMobileInformationManufacturer
    • GatewayMobileInformationModel
    • Shopping Cart
    • GatewayBrand
    Software
    • SoftwareName
    • SoftwareVersion
    • SoftwareIsTcpIpConnectionRequired
    • SoftwareFrontEnd
    • SoftwareNotes
    • SoftwareFrontEndDescription
    • SoftwareGateway
    • SoftwareVersionDescription
    • SoftwareNameSummary
    • SoftwareVersionSummary
    • SoftwareTcpIpGatewaySoftwareSummary
    • SoftwareFrontEndSummary
    • SoftwareBrandSummary
    • SoftwarePrinterModel
    • SoftwarePrinterShouldDeploy
    • SoftwarePinPadModel
    • SoftwarePinPadShouldDeploy
    • SoftwareCheckReaderModel
    • SoftwareCheckReaderShouldDeploy
    • SoftwareCardReaderModel
    • SoftwareCardReaderShouldDeploy
    • SoftwareDownload
    • SoftwareMultiMerchant
    • SoftwareMultiMerchantTiedToMerchantNumber
    • SoftwareBrand

    Removed Peripheral Fields

    The following peripheral/accessory have been removed from ApplicationEquipmentPeripheral.FieldValue and replaced with those listed above:

    • AccessoryBrand
    • AccessoryModel
    • AccessoryShouldDeploy
    • AccessoriesDeploymentFee
    • AccessoriesPricePerUnit
    • AccessoriesSwapFee
    • AccessoriesReStockingFee
    • AccessoriesInjectionFee
    • AccessoryQuantity

    Business Title Options

    The following are allowed for the new BusinessTitle field:

    • CEO_CFO
    • Chairman
    • Co-Owner
    • Controller_Comptroller
    • Director
    • General Manager
    • Office Manager
    • Owner
    • Partner
    • President
    • Treasurer
    • Vice President