triPOS REST API

<back to all web services

SaleRequest

The following routes are available for this service:
POST/api/v1/saleCreates a new card sale based on the passed in amounts.Review this document for information on requiring the PIN pad to prompt for the cardholder to accept the convenienceFeeAmount. Additionally, this endpoint supports QuickChip/PreRead functionality. See QuickChip/PreRead documentation for more information.
DO NOT use as a regular-interval health status check.
SaleRequest Parameters:
NameParameterData TypeRequiredDescription
ActionquerystringNoThe action to perform with the sale. This can either be 'store' or 'forward'. More information on Store and Forward here.
RequestIdToForwardquerystringNoThe request ID of the stored transaction to forward.
AddressbodyAddressNoThe cardholder address information for the transaction.
ConfigurationbodySaleRequestConfigurationNoAny value included in this section will override the corresponding value set in the triPOS.config
RequestedCashbackAmountbodydecimalNoThe requested cashback amount of the transaction. If the card used is cashback capable, this amount will be added to the total amount of the transaction. If the card is not cashback capable, the transaction will decline. More information on RequestedCashbackAmount here.
ConvenienceFeeAmountbodydecimalNoThe convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged. more»
TipAmountbodydecimalNoThe tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
TransactionAmountbodystringNoThe total transaction amount. This is the amount of funds to move on the card
SalesTaxAmountbodydecimal?NoThe amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.
CommercialCardCustomerCodebodystringNoThe commercial card customer code for the transaction. This is for Level II.
RecurringPaymentTypebodyRecurringPaymentType?NoIntent of why the credentials are being stored.

Allowable Values

  • NotUsed
  • Recurring
  • Installment
  • CardHolderInitiated
  • CredentialsOnFile
SubmissionTypebodySubmissionType?NoInitial vs Subsequent Transaction.

Allowable Values

  • NotUsed
  • Initial
  • Subsequent
  • Resubmission
  • ReAuthorization
  • DelayedCharges
  • NoShow
NetworkTransactionIDbodystringNoThe card brand specific transaction ID that should be stored by the integrator.
EbtTypebodyEbtTypeSelection?NoEbtType may be FoodStamp or CashBenefit

Allowable Values

  • None
  • FoodStamp
  • CashBenefit
FoodStampAmountbodydecimalNoIf POS app sends FoodStampAmount, then replace OriginalAmount with FoodStampAmount for EBT FoodStamp transactions
PinlessPosConversionIndicatorbodystringNoFlag indicating desire to convert Credit card Sale transaction to a PINless Debit Card transaction. more»

Allowable Values

  • false (Do not request PINless Debit Conversion)
  • true (Request PINless Debit Conversion if possible)
HealthcarebodyHealthcareNoThe healthcare section that contains all applicable healthcare-qualified amounts. more»
LodgingbodyLodgingTransactionCompletionNoThe lodging parameters to be passed in for a lodging transaction. more»
AutoRentalbodyAutoRentalNoThe auto rental parameters to be passed in for an auto rental transaction. more»
EstimatedAmountIndicatorbodystringNoThe EstimatedAmountIndicator can be used by merchants/integrators to define the TransactionAmount submitted to Express either as an Estimated Amount (i.e. amount to charge cardholder may change) or a Final Amount (i.e. amount to charge cardholder will not change). It will be a 1-character request field supporting the following request settings:

Allowable Values

  • (0 or empty/missing) = Default/Unknown
  • 1 = Estimated Amount
  • 2 = Final Amount
StoreCardbodyStoreCardNoInformation necessary to process a StoreCard transaction.
InvokeManualEntrybodyboolNoInvoke manual entry card read.
DisplayTransactionAmountbodyboolNoDisplay the transaction amount during card read.
NonFinancialExpectedbodyboolNoNon Financial Card read Expected. Only supported on unattended devices.
QuickChipbodyboolNoFlag indicating desire to process sale as QuickChip (i.e. - Pre-Read has been previously performed) more».
PreReadbodyboolNoFlag indicating desire to process sale as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) more».
PreReadIdbodyGuidNoThe preReadId returned in the pre-read response. This value should be a GUID.more».
CurrencyCodebodystringNoThe currency code used in the transaction.

Allowable Values

  • None
  • Cad
  • Gbp
  • Usd
GetTokenTypebodystringNoTo retrieve Token in the transaction. more»

Allowable Values

  • OmniToken
IsCscSupportedbodystringNoInvokes prompt for cardholder to enter card security code for manual keyed card entry.
GiftProgramTypebodyGiftProgramTypesNoThis field is for Valutec gift/loyalty card type. The value 0 is for gift and 1 for loyalty

Allowable Values

  • 0
  • 1
GiftCardProgrambodystringNoThis field is for Valutec gift/loyalty card program.
'01' = Original Gift Card Program
'02' = Promotional Gift Card Program
'03' = Original Combo Card Program
'04' = Auto Rewards LPR Card Program
'05' = Original Loyalty Card Program

Allowable Values

  • 01
  • 02
  • 03
  • 04
  • 05
CheckForPreReadIdbodybool?NoFlag to support 'PreReadId feature in quick chip' transaction request. This will take precedence over triPOS.config flag.
CreditSurchargeAmountbodydecimalNoThe credit surcharge amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged. more»
FleetbodyFleetNoThe fleet section that contains all applicable fleet. more»
LaneRequest Parameters:
NameParameterData TypeRequiredDescription
CardHolderPresentCodeformCardHolderPresentCode?NoDefines whether the cardholder is present at the transaction. This value is optional, but recommended to be set. If this value is not set in the request, it will be automatically set based on the market code.

Allowable Values

  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
ClerkNumberformstringNoAn optional clerk number for reference.
LaneIdformintNoSpecifies which lane to use.
ReferenceNumberformstringNoA user defined reference number.
ShiftIdformstringNoAn optional shift id for reference.
TicketNumberformstringNoAn optional ticket number.
Address Parameters:
NameParameterData TypeRequiredDescription
BillingAddress1formstringNoThe street address used for billing purposes.
BillingAddress2formstringNoThe street address used for billing purposes.
BillingCityformstringNoThe name of the city used for billing purposes.
BillingEmailformstringNoThe e-mail address used for billing purposes.
BillingNameformstringNoThe name used for billing purposes.
BillingPhoneformstringNoThe phone number used for billing purposes. The recommended format is (800)555-1212.
BillingPostalCodeformstringNoThe postal code used for billing purposes.
BillingStateformstringNoThe name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
ShippingAddress1formstringNoThe street address used for shipping purposes.
ShippingAddress2formstringNoThe street address used for shipping purposes.
ShippingCityformstringNoThe name of the city used for shipping purposes.
ShippingEmailformstringNoThe e-mail address used for shipping purposes.
ShippingNameformstringNoThe name used for shipping purposes.
ShippingPhoneformstringNoThe phone number used for shipping purposes. The recommended format is (800)555-1212
ShippingPostalCodeformstringNoThe postal code used for shipping purposes.
ShippingStateformstringNoThe name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
SaleRequestConfiguration Parameters:
NameParameterData TypeRequiredDescription
AllowDebitformbool?NoUse this parameter to allow debit more».
ConfirmOriginalAmountformstringNoUse this parameter to confirm the sale original amount more».
CashbackOptionsformCashbackOptionsNoUse this section to specify cashback options for each request more».
TipOptionsformTipOptionsNoIf these tip options are sent in, they will override the tip options that are currently set in the triPOS.config. To disable tip, send this section up with empty values. To use the values from the triPOS.config, do not include this section in your request more».
PromptForSignatureformCreditSaleSignaturePromptOptionNoSpecifies how the signature prompt should be handled for the request. If a value is not provided, UseThreshold will be used. See Signature Prompt.

Allowable Values

  • Always
  • Never
  • UseThreshold
  • None
ThresholdAmountformdecimal?NoSpecifies the threshold value to use. If included, will override the value in the triPOS.config when promptForSignature is UseThreshold. See Signature Prompt.
IsManualEntryAllowedformstringNoUse this parameter to allow manual entry of card account numbers on the PIN pad.
IsGiftSupportedformstringNoUse this parameter to allow Vantiv & Valutec gift cards to be used.
UserInputTimeoutformstringNoSpecifies the user input timeout.
ProcessUSMaestroDebitOffLinePinCvmAsDebitformstringNoUse this parameter to allow Maestro Debit Aids to be processed as Debit if the CVM is Offline PIN
ProvisionalAmountformstringNoOverride provisional amount used for QC transactions, which is $1.00 by default
AllowedPaymentTypesformstring[]NoPass in either or both values. If a single value is passed then no AID option will be presented for cardholder to select and automatic AID selection will happen, assuming only one credit/debit AID is available on a card. In case, multiple credit AIDs or multiple debit AIDs are available on a card, then choice will be given to choose among the filtered list of credit/debit AIDs.more»

Allowable Values

  • Credit
  • Debit
CardReadRetriesformint?NoNumber of retries in case of bad card read. The default value is 1.
RequestConfiguration Parameters:
NameParameterData TypeRequiredDescription
AllowPartialApprovalsformbool?NoIf set to false, partial approvals are not allowed
CheckForDuplicateTransactionsformbool?NoIf set to true, enables duplicate checking logic for the transaction at the host.
MarketCodeformMarketCodeNoThe market code of the transaction.

Allowable Values

  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
CashbackOptions Parameters:
NameParameterData TypeRequiredDescription
SelectionAmountsformstringNoThe cashback amounts to display on the PIN pad's selection buttons (i.e. 5,10,20,50).
ManualEntryformCashbackManualEntryNoConfigurable settings for allowing a cashback choice through manual entry.
CashbackManualEntry Parameters:
NameParameterData TypeRequiredDescription
AmountIncrementformintNoThe PIN pad will only accept a cashback amount in the provided increment (i.e. Set to 5 to only allow cashback amounts in increments of $5.00).
MaximumAmountformintNoThe PIN pad will only accept a cashback amount that does not exceed the provided maximum.
TipOptions Parameters:
NameParameterData TypeRequiredDescription
TipSelectionsformstringNoCSV tip amount selections.
TypeformstringNoType of tip entry: Amount selection, Percentage selection, or Prompt for custom value entry. Note: The Prompt value overrides the otherOption and tipSelections, skipping directly to Tip Amount entry screen.

Allowable Values

  • Amount
  • Percentage
  • Prompt
OtherOptionformstringNoOther option to show to select tip.

Allowable Values

  • Other
  • None
  • OtherNone
  • NoneOther
Healthcare Parameters:
NameParameterData TypeRequiredDescription
Totalformdecimal?NoThe total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.
Clinicformdecimal?NoThe total amount of healthcare-qualified goods that fall into the category of 'clinic'.
Dentalformdecimal?NoThe total amount of healthcare-qualified goods that fall into the category of 'dental'.
Prescriptionformdecimal?NoThe total amount of healthcare-qualified goods that fall into the category of 'prescription'.
Visionformdecimal?NoThe total amount of healthcare-qualified goods that fall into the category of 'vision'.
LodgingTransactionCompletion Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringNoThe lodging customer name.
AgreementNumberformstringNoThe lodging agreement number.
CheckInDateformstringNoThe check-in date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.
CheckOutDateformstringNoThe check-out date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.
RoomAmountformdecimalNoThe nightly rate for one room.
NoShowformboolNoSet to true to indicate no show. Otherwise, value defaults to false.
ExtraChargesDetailformLodgingExtraChargesDetail[]NoPass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NotUsed.

Allowable Values

  • NotUsed
  • Reserved
  • Restaurant
  • GiftShop
  • MiniBar
  • Telephone
  • Other
  • Laundry
PrestigiousPropertyCodeformLodgingPrestigiousPropertyCodeNoThe lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.

Allowable Values

  • NonParticipant
  • FiveHundredDollarLimit
  • OneThousandDollarLimit
  • OneThousandFiveHundredDollarLimit
SpecialProgramCodeformLodgingSpecialProgramCodeNoThe lodging special program code. For an empty or invalid value, this parameter defaults to Default.

Allowable Values

  • Default
  • Sale
  • NoShow
  • AdvanceDeposit
ChargeTypeformLodgingChargeTypeNoThe lodging charge type. For an empty or invalid value, this parameter defaults to Default.

Allowable Values

  • Default
  • Restaurant
  • GiftShop
Lodging Parameters:
NameParameterData TypeRequiredDescription
DurationformintNoThe number of hotel stay days. Set to 1 for no show.
AutoRental Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringNoCustomer Name.
AgreementNumberformstringNoAgreement number.
VehicleClassCodeformAutoRentalVehicleClassCode?NoClassification of rental vehicle

Allowable Values

  • Unused
  • Mini
  • Subcompact
  • Economy
  • Compact
  • Midsize
  • Intermediate
  • Standard
  • Fullsize
  • Luxury
  • Premium
  • Minivan
  • Van12Passenger
  • MovingVan
  • Van15Passenger
  • CargoVan
  • Truck12Foot
  • Truck20Foot
  • Truck24Foot
  • Truck26Foot
  • Moped
  • Stretch
  • Regular
  • Unique
  • Exotic
  • TruckSmallMedium
  • TruckLarge
  • SUVSmall
  • SUVMedium
  • SUVLarge
  • SUVExotic
  • FourWheelDrive
  • Special
  • Miscellaneous
NoShowIndicatorformAutoRentalNoShowIndicator?NoNo show indicator. Indicates whether rental vehicle was reserved, but not actually rented.

Allowable Values

  • NotApplicable
  • NoShow
AdjustmentDataformAutoRentalAdjustmentDataNoData related to any auto rental adjustments.
PickupDataformAutoRentalPickupDataNoData related to autorental pickup.
ReturnDataformAutoRentalReturnDataNoData related to autorental return.
DailyRentalRateformdecimalNoRate charged per day Visa/MC – Daily rate required for Corp T&E rate III.
WeeklyRentalRateformdecimalNoRate charged per week Visa/MC – Weekly rate required for Corp T&E rate III.
InsuranceChargesformdecimalNoIf insurance is charged, the insurance amount should be provided.
AutoRentalBasic Parameters:
NameParameterData TypeRequiredDescription
DurationformintNoThe number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.
AutoRentalAdjustmentData Parameters:
NameParameterData TypeRequiredDescription
AmountformdecimalNoAdjustment amount.
CodeformAutoRentalAuditAdjustmentCode?NoIndicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.

Allowable Values

  • NoAdjustments
  • MultipleAdjustments
  • OneAdjustmentCardmemberNotified
  • OneAdjustmentCardmemberNotNotified
ExtraChargesDetailformAutoRentalExtraChargesDetail[]NoPass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.

Allowable Values

  • NoExtraCharge
  • Gasoline
  • ExtraMileage
  • LateReturn
  • OneWayServiceFee
  • ParkingOrMovingViolation
AutoRentalPickupData Parameters:
NameParameterData TypeRequiredDescription
CityformstringNoAuto rental pickup city.
CountryCodeformstringNoCountry code where vehicle was picked up. For US, use 840.
DateformstringNoreturn date in yyyy-MM-ddTHH:mm:ss format.
LocationformstringNoName of business where vehicle was picked up.
StateformstringNoAbbreviation of state, province, or other country subdivision where vehicle was picked up.
AutoRentalReturnData Parameters:
NameParameterData TypeRequiredDescription
CityformstringNoAuto rental return city.
CountryCodeformstringNoCountry code where vehicle was returned. For US, use 840.
DateformstringNoreturn date in yyyy-MM-ddTHH:mm:ss format.
LocationIdformstringNoAuto Rental location ID where vehicle was returned.
StateformstringNoAuto rental return state.
DistanceformintNoNumeric distance traveled during rental period.
DistanceUnitformAutoRentalDistanceUnit?NoUnit of measurement applicable to distance traveled.

Allowable Values

  • 0 = Unused
  • 1 = Miles
  • 2 = Kilometers
StoreCard Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of a StoreCard.
PasswordformstringNoThe password of StoreCard.
Fleet Parameters:
NameParameterData TypeRequiredDescription
SummaryCommodityCodeformstringNoInternational description code of overall goods or services.
DiscountAmountformstringNoDiscount amount applied to the line item total. This field should be 0.00 if the unit cost reflects a discount price or if no line item discount applies.
DestinationZipCodeformstringNoPostal/Zip Code of the address to where the purchased goods are being shipped. Recommend using merchant zip code for card-present.
ShipFromZipCodeformstringNoPostal/Zip Code of the address to where the purchased goods are being shipped. Recommend using merchant zip code for card-present.
DestinationCountryCodeformCountryCodeNoCountry code where goods are being shipped.

Allowable Values

  • Can
  • Gbr
  • Usa
OrderDateformstringNoPurchase order date. YYYYMMDD
LineItemCountformstringNoNumber of line items included in transaction. Fleet supports 1 to 7 line items.
LineItemDetailformFleetLineItemDetailNoLineItemDetail includes the required Level III LineItem fields to be submitted.
FleetLineItemDetail Parameters:
NameParameterData TypeRequiredDescription
FleetLineItemsformList<FleetLineItem>NolineItem that required Level III LineItem fields to be submitted.
FleetLineItem Parameters:
NameParameterData TypeRequiredDescription
ItemCommodityCodeformstringNoInternational description code of the individual good or service being supplied. Recommend using numeric NACS code.
ItemDescriptionformstringNoItem Description.
ProductCodeformstringNoNumeric NACS code.
Quantityformdecimal?NoQuantity of the item. NNNNN.DDD
UnitOfMeasureformstringNoCode for units of measurement.
UnitCostformdecimal?NoUnit cost of the item. DDDDD.CC
LineItemVatAmountformstringNoAmount of any sales or value added taxes associated with the item. Recommend 0.00. DDDDDDDDD.CC
LineItemVatRateformstringNoTax rate used to calculate LineItemVATAmount. Submitted as a percentage. Two-digit implied string. Recommend 0. For example, if 10.42%, submit 1042
LineItemDiscountAmountformdecimal?NoDiscount amount applied to the line item. This field should be 0.00 if the unit cost reflects a discount price or if no line item discount applies. DDDDDDDDD.CC
LineItemTotalAmountformdecimal?NoTotal full amount associated with the line item (UnitCost * Quantity) - LineItemDiscountAmount for that item. DDDDDDDDD.CC
AlternateTaxIdentifierformstringNoTax identification number of the merchant reporting the alternate tax amount. Not applicable for US merchants. (tag must be present, but can be empty)
VatTypeformstringNoType of value added taxes being used. Not applicable for US merchants. (tag must be present, but can be empty)
DiscountCodeformFleetDiscountCode?NoIndicates whether discount was applied to the purchase price of the item. Recommend 0.

Allowable Values

  • NotSupported
  • AmountIsDiscounted
  • AmountIsNotDiscounted
NetGrossCodeformFleetNetGrossCode?NoIndicates whether extended item amount included the tax. Recommend 0.

Allowable Values

  • NotSupported
  • ItemAmountIncludesTaxAmount
  • ItemAmountDoesNotIncludeTaxAmount
ExtendedItemAmountformstringNoAmount of the item (unit price multiplied by quantity only). DDDDDDDDD.CC
DebitCreditCodeformFleetDebitCreditCode?NoIndicates whether extendedItemAmount is a Credit (taking away from the total amount of the sale) or Debit (adding to the total amount of the sale). Recommend 0

Allowable Values

  • NotSupported
  • ExtendedItemAmountIsCredit
  • ExtendedItemAmountIsDebit
ItemDiscountRateformstringNoDiscount rate for the line item. Submitted as a percentage. Two-digit implied string. Recommend 0. For example, if 10.42%, submit 1042
SaleResponse Parameters:
NameParameterData TypeRequiredDescription
CashbackAmountformdecimalNoThe cashback amount the cardholder wants.
GiftPointsBalanceformstringNoThis field provides gift points balance for Valutec gift/loyalty cards.
GiftRewardLevelformstringNoThis field provides gift reward level for Valutec gift/loyalty cards.
PinlessPosConversionIndicatorformstringNoIndicates whether the Credit card Sale transaction converted to a PINless Debit Card transaction.

Allowable Values

  • Y = Converted to PINless Debit
  • N = Not converted
AuthorizationResponse Parameters:
NameParameterData TypeRequiredDescription
QuickChipMessageformstringNoThe message unique to QuickChip pre-read functionality only.
ApprovedAmountformdecimalNoThe amount approved by the processor. This is the actual amount that will be charged or credited.
ConvenienceFeeAmountformdecimalNoThe convenience fee added to the transaction
SubTotalAmountformdecimalNoThe original amount sent for the transaction.
TipAmountformdecimalNoThe tip amount added to the transaction.
EmvformEmvNoThe fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.
FsaCardformstringNoIndicates whether the card used was a FSA card.
Note: Maybe = No BIN entry to determine if FSA.

Allowable Values

  • NotApplicable
  • No
  • Yes
  • Maybe
IsCardInsertedformboolNoIndicates whether the EMV card was still inserted into the payment device when the transaction completed.
NetworkTransactionIdformstringNoThe card brand specific transaction ID that should be stored by the integrator.
NonFinancialCardformNonFinancialCardNoNon Financial data.
TokenIdformstringNoThe Token ID.
TokenProviderformstringNoThe Token Provider.
CreditSurchargeAmountformdecimalNoThe surcharge amount that was added to the transaction.
TransactionStoredformboolNoIndicates the transaction was not able to be processed online and was stored instead. This is currently only applicable for Mobile device.
BaseCardResponse Parameters:
NameParameterData TypeRequiredDescription
AccountNumberformstringNoThe card account number.
BinValueformstringNoThe BIN entry that matched the account number.
CardHolderNameformstringNoThe cardholder name.
CardLogoformstringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
CurrencyCodeformCurrencyCodeNoThe currency code used in the transaction.

Allowable Values

  • None
  • Cad
  • Gbp
  • Usd
CountryCodeformCountryCode?NoThe country code used in the transaction.

Allowable Values

  • Can
  • Gbr
  • Usa
LanguageformLanguageCode?NoThe language used in the transaction.

Allowable Values

  • English
  • French
  • Spanish
DebitAccountTypeformDebitAccountType?NoThe account type selected and used in the transaction.

Allowable Values

  • None
  • Checking
  • Savings
EntryModeformstringNoDescription of how card was entered.

Allowable Values

  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
ExpirationYearformstringNoThe card's expiration year
ExpirationMonthformstringNoThe card's expiration month
NetworkLabelformstringNoLabel that shows the network where the transaction was routed for authorization
PaymentTypeformPaymentTypeNoDescription of payment type utilized.

Allowable Values

  • None
  • Credit
  • Debit
  • Gift
  • Ebt
PinVerifiedformboolNoTrue if the PIN was verified, false if not verified or undetermined.
SignatureformSignatureNoThe signature data.
TerminalIdformstringNoThe ID of the terminal used during the transaction
TotalAmountformdecimalNoThe total amount of the transaction.
EBTTypeformEbtTypeSelection?NoThe type of the EBT card
BalanceAmountformdecimal?NoThe balance of the gift card.
BalanceCurrencyCodeformCurrencyCode?NoThe balance currency code.
PreReadIdformGuidNoUnique ID. If checkForPreReadId field is true, then this ID will be required for the Quick Chip portion of the transaction to be successful.
ForeignCurrencyCodeformstringNoCurrency code of the foreign currency.
ForeignTransactionAmountformstringNoTransaction amount shown in the foreign currency.
ConversionRateformstringNoConversion rate for the ForeignCurrencyCode.
OdometerformstringNoFleet Odometer Input On The Device
FleetUserIDformstringNoFleet UserID Input On The Device
FleetJobNumberformstringNoFleet Job Number Input On The Device
PurchaseDeviceSequenceNumberformstringNoFleet Purchase Device Sequence Number from the card
VehicleIDformstringNoFleet Vehicle ID Input On The Device
BinAttributesformDictionary<string, bool>NoAvailable binAttributes of card. more»
DriverIDformstringNoFleet DriverID Input On The Device
IsFleetOdometerPrintformboolNois Fleet Odometer value Print On the Receipt or not
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ApprovalNumberformstringNoApproval number from the processor. Depending on card type and processor an approval number might not be returned.
IsApprovedformboolNoSet to true if the host approved the transaction.
ProcessorformProcessorNoResponse information from the processor.
StatusCodeformTransactionFlowStatusNoThe status code for the transaction.

Allowable Values

  • None
  • Success
  • Declined
  • Approved
  • Restart
  • Failed
  • HostError
  • Timeout
  • FailedVerification
  • CardError
  • UnknownCard
  • UnsupportedCard
  • DeviceError
  • Cancelled
  • ChipError
  • PinPadError
  • PinPadTimeout
  • InvalidLane
  • SwipedCardIsChipCapable
  • ApprovedByMerchant
  • ChipReaderError
  • UseChipReader
  • UseMagneticStripe
  • CardRemoved
  • CardBlocked
  • CardNotSupported
  • BadCard
  • CandidateListEmpty
  • IssuerAuthenticationFailed
  • CardDataEncryptionNotEnabled
  • ApprovedExceptCashback
  • ApplicationBlocked
  • PreReadSuccessful
  • ContactlessMsdDisabled
  • ContactlessEmvDisabled
  • ContactlessMsdNotSupported
  • ProgrammaticallyCancelled
  • DccRequested
TransactionDateTimeformstringNoTransaction date/time in ISO8601 format
TransactionIdformstringNoThe transaction ID from the processor
MerchantIdformstringNoThe Merchant used to process the transaction.
IsOfflineformboolNoA boolean value indicating whether triPOS is disconnected from the host.
ApiResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsformList<ApiError>NoA list of errors that occurred.
HasErrorsformboolNoIndicates if there are errors.
LinksformIEnumerable<ApiLink>NoA list of resource links
LogsformList<string>NoA list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
TypeformstringNoThe type of object held in the result.
WarningsformList<ApiWarning>NoA list of warnings that occurred.
ApiError Parameters:
NameParameterData TypeRequiredDescription
UserMessageformstringNoAn error message targeted at the end user of the integrated business application.
DeveloperMessageformstringNoAn error message targeted at the developer of the integrated business application.
ErrorTypeformstringNoCode associated with the error if it exists.
ExceptionMessageformstringNoThe body of the exception message.
ExceptionTypeFullNameformstringNoThe full name of the exception.
ExceptionTypeShortNameformstringNoThe short name of the exception.
ApiLink Parameters:
NameParameterData TypeRequiredDescription
HrefformstringNoA target (a URI)
MethodformstringNoThe HTTP method to access the HREF target
RelationformstringNoThe relation aka. 'rel' (the name of the link)
ApiWarning Parameters:
NameParameterData TypeRequiredDescription
DeveloperMessageformstringNoA warning message targeted at the developer of the integrated business application.
UserMessageformstringNoA warning message targeted at the end user of the integrated business application.
Processor Parameters:
NameParameterData TypeRequiredDescription
ProcessorLogsformList<string>No[DEPRECATED] Use logs.
ProcessorRawResponseformstringNo[DEPRECATED] Use rawResponse.
ProcessorReferenceNumberformstringNo[DEPRECATED] Use the same reference number passed in the request.
ProcessorRequestFailedformboolNo[DEPRECATED] Use top level properties (e.g. hasErrors).
ProcessorRequestWasApprovedformboolNo[DEPRECATED] Use top level properties (e.g isApproved).
ProcessorResponseCodeformProcessorResponseCodeNo[DEPRECATED] Use expressResponseCode.

Allowable Values

  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
  • NotAllowed
ProcessorResponseMessageformstringNo[DEPRECATED] Use expressResponseMessage.
ExpressResponseCodeformstringNoThe response code received from Express.
ExpressResponseMessageformstringNoThe response message received from Express.
HostResponseCodeformstringNoThe response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
HostResponseMessageformstringNoThe response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
LogsformList<string>NoA list of messages pertaining processing the transaction.
RawResponseformstringNoThe raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
RawRequestformstringNo
ProcessorNameformProcessorNameNo
Signature Parameters:
NameParameterData TypeRequiredDescription
SignatureDataformbyte[]NoThe byte array of the signature in the format specified by Format.
SignatureFormatformstringNoThe format of the signature.

Allowable Values

  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
SignatureStatusCodeformSignatureStatusCodeNoIndicates why a signature is or is not present.

Allowable Values

  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad
Emv Parameters:
NameParameterData TypeRequiredDescription
ApplicationIdentifierformstringNoThe Application Identifier also known as the AID. Identifies the application as described in ISO/IEC 7816-5. Printed receipts are required to contain the AID as hexadecimal characters.
ApplicationLabelformstringNoMnemonic associated with the AID according to ISO/IEC 7816-5. If the Application Preferred Name is not available or the Issuer code table index is not supported, then the Application Label should be used on the receipt instead of the Application Preferred Name.
ApplicationPreferredNameformstringNoPreferred mnemonic associated with the AID. When the Application Preferred Name is present and the Issuer code table index is supported, then this data element is mandatory on the receipt.
ApplicationTransactionCounterformstringNoThe application transaction counter.
CryptogramformstringNoThe EMV cryptogram type and value. It is a preferred best practice to include this data element on the receipt, but is not mandatory. This field contains cryptogram type followed by the cryptogram value.
TagsformList<Tag>NoA name value collection of additional EMV tags that are required to appear on the receipt.
IssuerCodeTableIndexformstringNoIndicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.
PinBypassedformboolNo
Tag Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ValueformstringNo
NonFinancialCard Parameters:
NameParameterData TypeRequiredDescription
Track1formstringNoTrack 1 of the non-financial card
Track2formstringNoTrack 2 of the non-financial card
Track3formstringNoTrack 3 of the non-financial card
CardEntryModeformTransactionDataEntryModeDto?NoCard entry mode

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/SaleRequest HTTP/1.1 
Host: triposqa.vantiv.com 
Content-Type: application/json
Content-Length: length

{"action":"String","requestIdToForward":"00000000000000000000000000000000","address":{"billingAddress1":"String","billingAddress2":"String","billingCity":"String","billingEmail":"String","billingName":"String","billingPhone":"String","billingPostalCode":"String","billingState":"String","shippingAddress1":"String","shippingAddress2":"String","shippingCity":"String","shippingEmail":"String","shippingName":"String","shippingPhone":"String","shippingPostalCode":"String","shippingState":"String"},"configuration":{"allowDebit":false,"confirmOriginalAmount":"String","cashbackOptions":{"selectionAmounts":"String","manualEntry":{"amountIncrement":0,"maximumAmount":0}},"tipOptions":{"tipSelections":"String","type":"String","otherOption":"String"},"promptForSignature":"Always","thresholdAmount":0,"userInputTimeout":"String","provisionalAmount":"String","allowedPaymentTypes":["String"],"cardReadRetries":0,"allowPartialApprovals":false,"checkForDuplicateTransactions":false,"marketCode":"Default"},"requestedCashbackAmount":0,"convenienceFeeAmount":0,"tipAmount":0,"transactionAmount":"String","salesTaxAmount":0,"commercialCardCustomerCode":"String","recurringPaymentType":"NotUsed","submissionType":"NotUsed","networkTransactionID":"String","ebtType":"FoodStamp","foodStampAmount":0,"pinlessPosConversionIndicator":"String","healthcare":{"total":0,"clinic":0,"dental":0,"prescription":0,"vision":0},"lodging":{"customerName":"String","agreementNumber":"String","checkInDate":"String","checkOutDate":"String","roomAmount":0,"noShow":false,"extraChargesDetail":["NotUsed"],"prestigiousPropertyCode":"NonParticipant","specialProgramCode":"Default","chargeType":"Default","duration":0},"autoRental":{"CustomerName":"String","AgreementNumber":"String","VehicleClassCode":"Unused","NoShowIndicator":"NotApplicable","AdjustmentData":{"Amount":0,"Code":"NoAdjustments","ExtraChargesDetail":["NoExtraCharge"]},"PickupData":{"City":"String","CountryCode":"String","Date":"String","Location":"String","State":"String"},"ReturnData":{"City":"String","CountryCode":"String","Date":"String","LocationId":"String","State":"String","Distance":0,"DistanceUnit":"Unused"},"DailyRentalRate":0,"WeeklyRentalRate":0,"InsuranceCharges":0,"Duration":0},"estimatedAmountIndicator":"String","storeCard":{"Id":"String","Password":"String"},"invokeManualEntry":false,"displayTransactionAmount":false,"nonFinancialExpected":false,"quickChip":false,"preRead":false,"preReadId":"00000000000000000000000000000000","currencyCode":"String","getToken":"String","isCscSupported":"String","giftProgramType":"gift","giftCardProgram":"String","checkForPreReadId":false,"creditSurchargeAmount":0,"fleet":{"summaryCommodityCode":"String","discountAmount":"String","destinationZipCode":"String","shipfromZipCode":"String","destinationCountryCode":"Can","orderDate":"String","lineItemCount":"String","lineItemDetail":{"lineItem":[{"itemCommodityCode":"String","itemDescription":"String","productCode":"String","quantity":0,"unitOfMeasure":"String","unitCost":0,"lineItemVatAmount":"String","lineItemVatRate":"String","lineItemDiscountAmount":0,"lineItemTotalAmount":0,"alternateTaxIdentifier":"String","vatType":"String","discountCode":"NotSupported","netGrossCode":"NotSupported","extendedItemAmount":"String","debitCreditCode":"NotSupported","itemDiscountRate":"String"}]}},"cardHolderPresentCode":"Default","clerkNumber":"String","laneId":0,"referenceNumber":"String","shiftId":"String","ticketNumber":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"cashbackAmount":0,"giftPointsBalance":"String","giftRewardLevel":"String","pinlessPosConversionIndicator":"String","quickChipMessage":"String","approvedAmount":0,"convenienceFeeAmount":0,"subTotalAmount":0,"tipAmount":0,"emv":{"applicationIdentifier":"String","applicationLabel":"String","applicationPreferredName":"String","applicationTransactionCounter":"String","cryptogram":"String","tags":[{"key":"String","value":"String"}],"issuerCodeTableIndex":"String","pinBypassed":false},"fsaCard":"String","isCardInserted":false,"networkTransactionId":"String","nonFinancialData":{"track1":"String","track2":"String","track3":"String","cardEntryMode":"Unknown"},"tokenId":"String","tokenProvider":"String","creditSurchargeAmount":0,"transactionStored":false,"accountNumber":"String","binValue":"String","cardHolderName":"String","cardLogo":"String","currencyCode":"None","countryCode":"0","language":"English","accountType":"None","entryMode":"String","expirationYear":"String","expirationMonth":"String","networkLabel":"String","paymentType":"None","pinVerified":false,"signature":{"data":"AA==","format":"String","statusCode":"Unknown"},"terminalId":"String","totalAmount":0,"ebtType":"None","balanceAmount":0,"balanceCurrencyCode":"None","foreignCurrencyCode":"String","foreignTransactionAmount":"String","conversionRate":"String","odometer":"String","fleetUserID":"String","fleetJobNumber":"String","purchaseDeviceSequenceNumber":"String","vehicleID":"String","binAttributes":{"String":false},"driverID":"String","approvalNumber":"String","isApproved":false,"_processor":{"processorLogs":["String"],"processorRawResponse":"String","processorReferenceNumber":"String","processorRequestFailed":false,"processorRequestWasApproved":false,"processorResponseCode":"Unknown","processorResponseMessage":"String","expressResponseCode":"String","expressResponseMessage":"String","hostResponseCode":"String","hostResponseMessage":"String","logs":["String"],"rawResponse":"String","rawRequest":"String","processorName":"Unknown"},"statusCode":"None","transactionDateTime":"String","transactionId":"String","merchantId":"String","isOffline":false,"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}