triPOS REST API

AuthorizationRequest

The following routes are available for this service:
POST	/api/v1/authorization	Creates a new card authorization based on the passed in parameters	This creates a transaction used to hold funds when the total amount of the purchase is unknown. The Incremental Authorization HATEAOS link is supported for market codes that are supported by Express. Additionally, this endpoint supports QuickChip/PreRead functionality. See QuickChip/PreRead documentation for more information.

**AuthorizationRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Action	query	string	No	The action to perform with the authorization. This can either be 'store' or 'forward'.
RequestIdToForward	query	string	No	The request ID of the stored transaction to forward.
Address	body	Address	No	The cardholder address information for the transaction.
Configuration	body	AuthorizationRequestConfiguration	No	Any value included in this section will override the corresponding value set in the triPOS.config
ConvenienceFeeAmount	body	decimal	No	The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
EstimatedAmountIndicator	body	string	No	The 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
TipAmount	body	decimal	No	The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
TransactionAmount	body	string	No	The total transaction amount. This is the amount of funds to move on the card
SalesTaxAmount	body	decimal?	No	The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.
CommercialCardCustomerCode	body	string	No	The commercial card customer code for the transaction. This is for Level II.
RecurringPaymentType	body	RecurringPaymentType?	No	Recurring PaymentType,Intent of why the credentials are being stored. Allowable Values NotUsed Recurring Installment CardHolderInitiated CredentialsOnFile
SubmissionType	body	SubmissionType?	No	SubmissionType,Initial vs Subsequent Transaction. Allowable Values NotUsed Initial Subsequent Resubmission ReAuthorization DelayedCharges NoShow
NetworkTransactionID	body	string	No	The card brand specific transaction ID that should be stored by the integrator.
Healthcare	body	Healthcare	No	The healthcare section that contains all applicable healthcare-qualified amounts. more»
Lodging	body	LodgingAuthorization	No	The lodging parameters to be passed in for a lodging transaction. more»
AutoRental	body	AutoRentalBasic	No	The auto rental parameters to be passed in for an auto rental transaction. more»
InvokeManualEntry	body	bool	No	Invokes manual card entry.
DisplayTransactionAmount	body	bool	No	Display the transaction amount during card read.
QuickChip	body	bool	No	Flag indicating desire to process authorization as QuickChip (i.e. - Pre-Read has been previously performed) more».
PreRead	body	bool	No	Flag indicating desire to process authorization as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) more».
PreReadId	body	Guid	No	A unique ID for this request. This value should be a GUID.more».
NonFinancialExpected	body	bool	No	Non Financial Card read Expected. Only supported on unattended devices.
GetTokenType	body	string	No	To retrieve Token in the transaction. more» Allowable Values OmniToken
IsCscSupported	body	string	No	Invokes prompt for cardholder to enter card security code for manual keyed card entry.
CheckForPreReadId	body	bool?	No	Flag to support 'PreReadId feature in quick chip' transaction request. This will take precedence over triPOS.config flag.
CreditSurchargeAmount	body	decimal	No	The credit surcharge amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged. more»

**LaneRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CardHolderPresentCode	form	CardHolderPresentCode?	No	Defines 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
ClerkNumber	form	string	No	An optional clerk number for reference.
LaneId	form	int	No	Specifies which lane to use.
ReferenceNumber	form	string	No	A user defined reference number.
ShiftId	form	string	No	An optional shift id for reference.
TicketNumber	form	string	No	An optional ticket number.

**Address** Parameters:
Name	Parameter	Data Type	Required	Description
BillingAddress1	form	string	No	The street address used for billing purposes.
BillingAddress2	form	string	No	The street address used for billing purposes.
BillingCity	form	string	No	The name of the city used for billing purposes.
BillingEmail	form	string	No	The e-mail address used for billing purposes.
BillingName	form	string	No	The name used for billing purposes.
BillingPhone	form	string	No	The phone number used for billing purposes. The recommended format is (800)555-1212.
BillingPostalCode	form	string	No	The postal code used for billing purposes.
BillingState	form	string	No	The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
ShippingAddress1	form	string	No	The street address used for shipping purposes.
ShippingAddress2	form	string	No	The street address used for shipping purposes.
ShippingCity	form	string	No	The name of the city used for shipping purposes.
ShippingEmail	form	string	No	The e-mail address used for shipping purposes.
ShippingName	form	string	No	The name used for shipping purposes.
ShippingPhone	form	string	No	The phone number used for shipping purposes. The recommended format is (800)555-1212
ShippingPostalCode	form	string	No	The postal code used for shipping purposes.
ShippingState	form	string	No	The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.

**AuthorizationRequestConfiguration** Parameters:
Name	Parameter	Data Type	Required	Description
PromptForSignature	form	BasicSignaturePromptOption	No	Specifies how the signature prompt should be handled for the request. If a value is not provided, Never will be used. See Signature Prompt. Allowable Values Always Never None
IsManualEntryAllowed	form	string	No	Use this parameter to allow manual entry of card account numbers on the PIN pad.
UserInputTimeout	form	string	No	Specifies the user input timeout.
ProvisionalAmount	form	string	No	Override provisional amount used for QC transactions, which is $1.00 by default
CardReadRetries	form	int?	No	Number of retries in case of bad card read. The default value is 1.

**RequestConfiguration** Parameters:
Name	Parameter	Data Type	Required	Description
AllowPartialApprovals	form	bool?	No	If set to false, partial approvals are not allowed
CheckForDuplicateTransactions	form	bool?	No	If set to true, enables duplicate checking logic for the transaction at the host.
MarketCode	form	MarketCode	No	The market code of the transaction. Allowable Values Default AutoRental DirectMarketing ECommerce FoodRestaurant HotelLodging Petroleum Retail Qsr

**Healthcare** Parameters:
Name	Parameter	Data Type	Required	Description
Total	form	decimal?	No	The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.
Clinic	form	decimal?	No	The total amount of healthcare-qualified goods that fall into the category of 'clinic'.
Dental	form	decimal?	No	The total amount of healthcare-qualified goods that fall into the category of 'dental'.
Prescription	form	decimal?	No	The total amount of healthcare-qualified goods that fall into the category of 'prescription'.
Vision	form	decimal?	No	The total amount of healthcare-qualified goods that fall into the category of 'vision'.

**LodgingAuthorization** Parameters:
Name	Parameter	Data Type	Required	Description
PrestigiousPropertyCode	form	LodgingPrestigiousPropertyCode	No	The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant. Allowable Values NonParticipant FiveHundredDollarLimit OneThousandDollarLimit OneThousandFiveHundredDollarLimit

**Lodging** Parameters:
Name	Parameter	Data Type	Required	Description
Duration	form	int	No	The number of hotel stay days. Set to 1 for no show.

**AutoRentalBasic** Parameters:
Name	Parameter	Data Type	Required	Description
Duration	form	int	No	The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.

**AuthorizationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
QuickChipMessage	form	string	No	The message unique to QuickChip pre-read functionality only.
ApprovedAmount	form	decimal	No	The amount approved by the processor. This is the actual amount that will be charged or credited.
ConvenienceFeeAmount	form	decimal	No	The convenience fee added to the transaction
SubTotalAmount	form	decimal	No	The original amount sent for the transaction.
TipAmount	form	decimal	No	The tip amount added to the transaction.
Emv	form	Emv	No	The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.
FsaCard	form	string	No	Indicates whether the card used was a FSA card. Note: Maybe = No BIN entry to determine if FSA. Allowable Values NotApplicable No Yes Maybe
IsCardInserted	form	bool	No	Indicates whether the EMV card was still inserted into the payment device when the transaction completed.
NetworkTransactionId	form	string	No	The card brand specific transaction ID that should be stored by the integrator.
NonFinancialCard	form	NonFinancialCard	No	Non Financial data.
TokenId	form	string	No	The Token ID.
TokenProvider	form	string	No	The Token Provider.
CreditSurchargeAmount	form	decimal	No	The surcharge amount that was added to the transaction.
TransactionStored	form	bool	No	Indicates the transaction was not able to be processed online and was stored instead. This is currently only applicable for Mobile device.

**BaseCardResponse** Parameters:
Name	Parameter	Data Type	Required	Description
AccountNumber	form	string	No	The card account number.
BinValue	form	string	No	The BIN entry that matched the account number.
CardHolderName	form	string	No	The cardholder name.
CardLogo	form	string	No	The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
CurrencyCode	form	CurrencyCode	No	The currency code used in the transaction. Allowable Values None Cad Gbp Usd
CountryCode	form	CountryCode?	No	The country code used in the transaction. Allowable Values Can Gbr Usa
Language	form	LanguageCode?	No	The language used in the transaction. Allowable Values English French Spanish
DebitAccountType	form	DebitAccountType?	No	The account type selected and used in the transaction. Allowable Values None Checking Savings
EntryMode	form	string	No	Description of how card was entered. Allowable Values Unknown Swiped Keyed ContactIcc ContactlessIcc ContactlessMsd
ExpirationYear	form	string	No	The card's expiration year
ExpirationMonth	form	string	No	The card's expiration month
NetworkLabel	form	string	No	Label that shows the network where the transaction was routed for authorization
PaymentType	form	PaymentType	No	Description of payment type utilized. Allowable Values None Credit Debit Gift Ebt
PinVerified	form	bool	No	True if the PIN was verified, false if not verified or undetermined.
Signature	form	Signature	No	The signature data.
TerminalId	form	string	No	The ID of the terminal used during the transaction
TotalAmount	form	decimal	No	The total amount of the transaction.
EBTType	form	EbtTypeSelection?	No	The type of the EBT card
BalanceAmount	form	decimal?	No	The balance of the gift card.
BalanceCurrencyCode	form	CurrencyCode?	No	The balance currency code.
PreReadId	form	Guid	No	Unique ID. If checkForPreReadId field is true, then this ID will be required for the Quick Chip portion of the transaction to be successful.
ForeignCurrencyCode	form	string	No	Currency code of the foreign currency.
ForeignTransactionAmount	form	string	No	Transaction amount shown in the foreign currency.
ConversionRate	form	string	No	Conversion rate for the ForeignCurrencyCode.
Odometer	form	string	No	Fleet Odometer Input On The Device
FleetUserID	form	string	No	Fleet UserID Input On The Device
FleetJobNumber	form	string	No	Fleet Job Number Input On The Device
PurchaseDeviceSequenceNumber	form	string	No	Fleet Purchase Device Sequence Number from the card
VehicleID	form	string	No	Fleet Vehicle ID Input On The Device
BinAttributes	form	Dictionary<string, bool>	No	Available binAttributes of card. more»
DriverID	form	string	No	Fleet DriverID Input On The Device
IsFleetOdometerPrint	form	bool	No	is Fleet Odometer value Print On the Receipt or not

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ApprovalNumber	form	string	No	Approval number from the processor. Depending on card type and processor an approval number might not be returned.
IsApproved	form	bool	No	Set to true if the host approved the transaction.
Processor	form	Processor	No	Response information from the processor.
StatusCode	form	TransactionFlowStatus	No	The 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
TransactionDateTime	form	string	No	Transaction date/time in ISO8601 format
TransactionId	form	string	No	The transaction ID from the processor
MerchantId	form	string	No	The Merchant used to process the transaction.
IsOffline	form	bool	No	A boolean value indicating whether triPOS is disconnected from the host.

**ApiResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Errors	form	List<ApiError>	No	A list of errors that occurred.
HasErrors	form	bool	No	Indicates if there are errors.
Links	form	IEnumerable<ApiLink>	No	A list of resource links
Logs	form	List<string>	No	A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
Type	form	string	No	The type of object held in the result.
Warnings	form	List<ApiWarning>	No	A list of warnings that occurred.

**ApiError** Parameters:
Name	Parameter	Data Type	Required	Description
UserMessage	form	string	No	An error message targeted at the end user of the integrated business application.
DeveloperMessage	form	string	No	An error message targeted at the developer of the integrated business application.
ErrorType	form	string	No	Code associated with the error if it exists.
ExceptionMessage	form	string	No	The body of the exception message.
ExceptionTypeFullName	form	string	No	The full name of the exception.
ExceptionTypeShortName	form	string	No	The short name of the exception.

**ApiLink** Parameters:
Name	Parameter	Data Type	Required	Description
Href	form	string	No	A target (a URI)
Method	form	string	No	The HTTP method to access the HREF target
Relation	form	string	No	The relation aka. 'rel' (the name of the link)

**ApiWarning** Parameters:
Name	Parameter	Data Type	Required	Description
DeveloperMessage	form	string	No	A warning message targeted at the developer of the integrated business application.
UserMessage	form	string	No	A warning message targeted at the end user of the integrated business application.

**Processor** Parameters:
Name	Parameter	Data Type	Required	Description
ProcessorLogs	form	List<string>	No	[DEPRECATED] Use logs.
ProcessorRawResponse	form	string	No	[DEPRECATED] Use rawResponse.
ProcessorReferenceNumber	form	string	No	[DEPRECATED] Use the same reference number passed in the request.
ProcessorRequestFailed	form	bool	No	[DEPRECATED] Use top level properties (e.g. hasErrors).
ProcessorRequestWasApproved	form	bool	No	[DEPRECATED] Use top level properties (e.g isApproved).
ProcessorResponseCode	form	ProcessorResponseCode	No	[DEPRECATED] Use expressResponseCode. Allowable Values Unknown Approved PartialApproval Decline ExpiredCard Duplicate PickUpCard ReferralCallIssuer InvalidData ApprovedExceptCashback NotAllowed
ProcessorResponseMessage	form	string	No	[DEPRECATED] Use expressResponseMessage.
ExpressResponseCode	form	string	No	The response code received from Express.
ExpressResponseMessage	form	string	No	The response message received from Express.
HostResponseCode	form	string	No	The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
HostResponseMessage	form	string	No	The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
Logs	form	List<string>	No	A list of messages pertaining processing the transaction.
RawResponse	form	string	No	The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
RawRequest	form	string	No
ProcessorName	form	ProcessorName	No

**Signature** Parameters:
Name	Parameter	Data Type	Required	Description
SignatureData	form	byte[]	No	The byte array of the signature in the format specified by Format.
SignatureFormat	form	string	No	The format of the signature. Allowable Values PointsLittleEndian PointsBigEndian Ascii3Byte
SignatureStatusCode	form	SignatureStatusCode	No	Indicates why a signature is or is not present. Allowable Values Unknown SignatureRequired SignaturePresent SignatureRequiredCancelledByCardholder SignatureRequiredNotSupportedByPinPad SignatureRequiredPinPadError SignatureNotRequiredByThresholdAmount SignatureNotRequiredByPaymentType SignatureNotRequiredByTransactionType SignatureRequiredButPromptSuppressedByMerchant SignatureNotRequiredByUnattendedPinPad

**Emv** Parameters:
Name	Parameter	Data Type	Required	Description
ApplicationIdentifier	form	string	No	The 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.
ApplicationLabel	form	string	No	Mnemonic 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.
ApplicationPreferredName	form	string	No	Preferred 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.
ApplicationTransactionCounter	form	string	No	The application transaction counter.
Cryptogram	form	string	No	The 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.
Tags	form	List<Tag>	No	A name value collection of additional EMV tags that are required to appear on the receipt.
IssuerCodeTableIndex	form	string	No	Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.
PinBypassed	form	bool	No

**Tag** Parameters:
Name	Parameter	Data Type	Required	Description
Key	form	string	No
Value	form	string	No

**NonFinancialCard** Parameters:
Name	Parameter	Data Type	Required	Description
Track1	form	string	No	Track 1 of the non-financial card
Track2	form	string	No	Track 2 of the non-financial card
Track3	form	string	No	Track 3 of the non-financial card
CardEntryMode	form	TransactionDataEntryModeDto?	No	Card 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/AuthorizationRequest 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":{"promptForSignature":"Always","userInputTimeout":"String","provisionalAmount":"String","cardReadRetries":0,"allowPartialApprovals":false,"checkForDuplicateTransactions":false,"marketCode":"Default"},"convenienceFeeAmount":0,"estimatedAmountIndicator":"String","tipAmount":0,"transactionAmount":"String","salesTaxAmount":0,"commercialCardCustomerCode":"String","recurringPaymentType":"NotUsed","submissionType":"NotUsed","networkTransactionID":"String","healthcare":{"total":0,"clinic":0,"dental":0,"prescription":0,"vision":0},"lodging":{"prestigiousPropertyCode":"NonParticipant","duration":0},"autoRental":{"Duration":0},"invokeManualEntry":false,"displayTransactionAmount":false,"quickChip":false,"preRead":false,"preReadId":"00000000000000000000000000000000","nonFinancialExpected":false,"getToken":"String","isCscSupported":"String","checkForPreReadId":false,"creditSurchargeAmount":0,"cardHolderPresentCode":"Default","clerkNumber":"String","laneId":0,"referenceNumber":"String","shiftId":"String","ticketNumber":"String"}

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

{"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"}]}

triPOS REST API

AuthorizationRequest

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + JSON