triPOS REST API

<back to all web services

ReversalRequest

The following routes are available for this service:
POST/api/v1/reversal/{transactionId}/{paymentType}Creates a new full reversal based on given transaction ID, payment type, and the passed in amounts
ReversalRequest Parameters:
NameParameterData TypeRequiredDescription
ConfigurationbodyTransactionIdRequestConfigurationNoAny value included in this section will override the corresponding value set in the triPOS.config
ConvenienceFeeAmountbodydecimalNoThe convenience fee amount.
PaymentTypepathstringYesThe original payment type.

Allowable Values

  • credit
  • debit
  • gift
TransactionAmountbodydecimalNoThe original transaction amount.
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.
TransactionIdpathstringYesThe ID of a previous transaction.
ReversalTypequerystringNoThe type of reversal.
EbtTypebodyEbtTypeSelection?NoEBT card type of the original transaction. This is required when payment type is EBT.

Allowable Values

  • None
  • FoodStamp
  • CashBenefit
StoreCardbodyStoreCardNoInformation necessary to process a StoreCard transaction.
GetTokenTypebodystringNoTo retrieve Token in the transaction.
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
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.
TransactionIdRequestConfiguration Parameters:
NameParameterData TypeRequiredDescription
MarketCodeformMarketCodeNoThe market code of the transaction.

Allowable Values

  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
StoreCard Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of a StoreCard.
PasswordformstringNoThe password of StoreCard.
ReversalResponse Parameters:
NameParameterData TypeRequiredDescription
CardLogoformstringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other
ConvenienceFeeAmountformdecimalNoThe convenience fee amount.
PaymentTypeformstringNoOriginal card payment type: Credit, Debit, Gift, EBT
TerminalIdformstringNoThe ID of the terminal used during the transaction
TotalAmountformdecimalNoThe total amount of the transaction.
AccountNumberformstringNoThe card account number.
BalanceAmountformdecimalNoThe balance of the gift card.
TokenIdformstringNoThe Token ID.
TokenProviderformstringNoThe Token Provider.
GiftPointsBalanceformstringNoThis field provides gift points balance for Valutec gift/loyalty cards.
GiftRewardLevelformstringNoThis field provides gift reward level for Valutec gift/loyalty cards.
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/ReversalRequest HTTP/1.1 
Host: triposqa.vantiv.com 
Content-Type: application/json
Content-Length: length

{"configuration":{"marketCode":"Default"},"convenienceFeeAmount":0,"paymentType":"None","transactionAmount":0,"recurringPaymentType":"NotUsed","submissionType":"NotUsed","networkTransactionID":"String","transactionId":"String","type":"String","ebtType":"None","storeCard":{"Id":"String","Password":"String"},"getToken":"String","giftProgramType":"gift","giftCardProgram":"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

{"cardLogo":"String","convenienceFeeAmount":0,"paymentType":"String","terminalId":"String","totalAmount":0,"accountNumber":"String","balanceAmount":0,"tokenId":"String","tokenProvider":"String","giftPointsBalance":"String","giftRewardLevel":"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"}]}