triPOS REST API

<back to all web services

PaymentAccountSaleRequest

The following routes are available for this service:
POST/api/v1/sale/{paymentAccountId}Creates a new payment account sale based on the passed in amounts
PaymentAccountSaleRequest Parameters:
NameParameterData TypeRequiredDescription
PaymentAccountIdpathstringYesThe payment account ID.
AddressbodyAddressNoThe cardholder address information for the transaction.
ConfigurationbodyRequestConfigurationNoAny value included in this section will override the corresponding value set in the triPOS.config
ConvenienceFeeAmountbodydecimalNoThe convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
TipAmountbodydecimalNoThe tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
TransactionAmountbodydecimalNoThe total transaction amount. This is the amount of funds to move on the card
LaneIdbodyintNoSpecifies which lane to use for the card sale.
ClerkNumberbodystringNoAn optional clerk number for reference.
ReferenceNumberbodystringNoA user defined reference number.
ShiftIdbodystringNoAn optional shift id for reference.
TicketNumberbodystringNoAn optional ticket number.
HealthcarebodyHealthcareNoThe healthcare section that contains all applicable healthcare-qualified amounts. more»
CreditSurchargeAmountbodydecimalNoThe credit surcharge amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
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.
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
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'.
PaymentAccountSaleResponse Parameters:
NameParameterData TypeRequiredDescription
PaymentAccountIdformstringNoThe payment account ID.
PaymentAccountReferenceNumberformstringNoThe payment account reference number.
AvsResponseCodeformstringNoThe AVS response code.
ApprovedAmountformdecimalNoThe amount approved by the processor. This is the actual amount that will be charged or credited.
CardLogoformstringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
ConvenienceFeeAmountformdecimalNoThe convenience fee added to the transaction
SubTotalAmountformdecimalNoThe original amount sent for the transaction.
TipAmountformdecimalNoThe tip amount added to the transaction.
TerminalIdformstringNoThe ID of the terminal used during the transaction
TotalAmountformdecimalNoThe total amount of the transaction.
ReferenceNumberformstringNoThe reference number.
CreditSurchargeAmountformdecimalNoThe credit surcharge added to the transaction
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

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/PaymentAccountSaleRequest HTTP/1.1 
Host: triposqa.vantiv.com 
Content-Type: application/json
Content-Length: length

{"paymentAccountId":"String","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":{"allowPartialApprovals":false,"checkForDuplicateTransactions":false,"marketCode":"Default"},"convenienceFeeAmount":0,"tipAmount":0,"transactionAmount":0,"laneId":0,"clerkNumber":"String","referenceNumber":"String","shiftId":"String","ticketNumber":"String","healthcare":{"total":0,"clinic":0,"dental":0,"prescription":0,"vision":0},"creditSurchargeAmount":0}

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

{"paymentAccountId":"String","paymentAccountReferenceNumber":"String","avsResponseCode":"String","approvedAmount":0,"cardLogo":"String","convenienceFeeAmount":0,"subTotalAmount":0,"tipAmount":0,"terminalId":"String","totalAmount":0,"referenceNumber":"String","creditSurchargeAmount":0,"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"}]}