triPOS REST API

<back to all web services

VoidRequest

The following routes are available for this service:
POST/api/v1/void/{transactionId}Voids the previous transaction with the passed in transaction ID.
VoidRequest Parameters:
NameParameterData TypeRequiredDescription
ConfigurationbodyTransactionIdRequestConfigurationNoAny value included in this section will override the corresponding value set in the triPOS.config
TransactionIdpathstringYesThe ID of a previous transaction.
LaneRequest Parameters:
NameParameterData TypeRequiredDescription
CardHolderPresentCodebodyCardHolderPresentCode?NoDefines whether the card holder 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
ClerkNumberbodystringNoAn optional clerk number for reference.
LaneIdbodyintNoSpecifies which lane to use.
ReferenceNumberbodystringNoA user defined reference number. This reference number is returned in the response
ShiftIdbodystringNoAn optional shift id for reference.
TicketNumberbodystringNoAn optional ticket number.
TransactionIdRequestConfiguration Parameters:
NameParameterData TypeRequiredDescription
MarketCodebodyMarketCodeNoThe market code of the transaction.

Allowable Values

  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
VoidResponse Parameters:
NameParameterData TypeRequiredDescription
CardLogobodystringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other
TerminalIdbodystringNoThe ID of the terminal used during the transaction
AccountNumberbodystringNoThe Account Number returned by the host
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ApprovalNumberbodystringNoApproval number from the processor. Depending on card type and processor an approval number might not be returned.
IsApprovedbodyboolNoSet to true if the host approved the transaction.
ProcessorbodyProcessorNoResponse information from the processor.
StatusCodebodyTransactionFlowStatusNoThe 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
TransactionDateTimebodystringNoTransaction date/time in ISO8601 format
TransactionIdbodystringNoThe transaction ID from the processor
MerchantIdbodystringNoThe Merchant used to process the transaction.

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/VoidRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/json
Content-Length: length

{"configuration":{"marketCode":"Default"},"transactionId":"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","terminalId":"String","accountNumber":"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"},"statusCode":"None","transactionDateTime":"String","transactionId":"String","merchantId":"String","_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"}]}