triPOS REST API

<back to all web services

IncrementalAuthorizationRequest

The following routes are available for this service:
POST/api/v1/authorization/{transactionId}/incremental[BETA] Increases a previous card authorization by the given transactionAmount.This increments the original authorization by the given transactionAmount. The transactionId is the value returned by the original authorization. More»
IncrementalAuthorizationRequest Parameters:
NameParameterData TypeRequiredDescription
ConfigurationbodyTransactionIdRequestConfigurationNoApplicable configuration values that can be set per request.
TransactionIdpathstringYesThe ID of a previous authorization transaction.
TransactionAmountbodydecimalNoThe amount by which to increase the authorization amount.
LodgingbodyLodgingIncrementalAuthorizationNoThe lodging parameter to be passed in for a lodging transaction. more»
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
LodgingIncrementalAuthorization Parameters:
NameParameterData TypeRequiredDescription
DurationbodyintNoThe number of hotel stay days. Set to 1 for no show.
IncrementalAuthorizationResponse Parameters:
NameParameterData TypeRequiredDescription
TransactionIdbodystringNoThe transaction ID from the processor
TotalAmountbodydecimalNoThe total amount of the transaction.
AccountNumberbodystringNoThe card account number.
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
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
MerchantIdbodystringNoThe Merchant used to process the transaction.
ReferenceNumberbodystringNoThe transaction's reference number.
MarketCodebodystringNoThe transaction's reference number.
ApiResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsbodyList<ApiError>NoA list of errors that occurred.
HasErrorsbodyboolNoIndicates if there are errors.
LinksbodyIEnumerable<ApiLink>NoA list of resource links
LogsbodyList<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.
TypebodystringNoThe type of object held in the result.
WarningsbodyList<ApiWarning>NoA list of warnings that occurred.
Processor Parameters:
NameParameterData TypeRequiredDescription
ProcessorLogsbodyList<string>No[DEPRECATED] Use logs.
ProcessorRawResponsebodystringNo[DEPRECATED] Use rawResponse.
ProcessorReferenceNumberbodystringNo[DEPRECATED] Use the same reference number passed in the request.
ProcessorRequestFailedbodyboolNo[DEPRECATED] Use top level properties (e.g. hasErrors).
ProcessorRequestWasApprovedbodyboolNo[DEPRECATED] Use top level properties (e.g isApproved).
ProcessorResponseCodebodyProcessorResponseCodeNo[DEPRECATED] Use expressResponseCode.

Allowable Values

  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
ProcessorResponseMessagebodystringNo[DEPRECATED] Use expressResponseMessage.
ExpressResponseCodebodystringNoThe response code received from Express.
ExpressResponseMessagebodystringNoThe response message received from Express.
HostResponseCodebodystringNoThe response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
HostResponseMessagebodystringNoThe response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
LogsbodyList<string>NoA list of messages pertaining processing the transaction.
RawResponsebodystringNoThe raw processor response. In the case of Express, this is the raw XML returned by the Express platform.

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

HTTP + XML

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

POST /xml/reply/IncrementalAuthorizationRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/xml
Content-Length: length

<incrementalAuthorizationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <cardHolderPresentCode>Default</cardHolderPresentCode>
  <clerkNumber>String</clerkNumber>
  <laneId>0</laneId>
  <referenceNumber>String</referenceNumber>
  <shiftId>String</shiftId>
  <ticketNumber>String</ticketNumber>
  <configuration>
    <marketCode>Default</marketCode>
  </configuration>
  <lodging>
    <duration>0</duration>
  </lodging>
  <transactionAmount>0</transactionAmount>
  <transactionId>String</transactionId>
</incrementalAuthorizationRequest>

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

<incrementalAuthorizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <_errors>
    <error>
      <developerMessage>String</developerMessage>
      <errorType>String</errorType>
      <exceptionMessage>String</exceptionMessage>
      <exceptionTypeFullName>String</exceptionTypeFullName>
      <exceptionTypeShortName>String</exceptionTypeShortName>
      <userMessage>String</userMessage>
    </error>
  </_errors>
  <_hasErrors>true</_hasErrors>
  <_links />
  <_logs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </_logs>
  <_type>String</_type>
  <_warnings>
    <warning>
      <developerMessage>String</developerMessage>
      <userMessage>String</userMessage>
    </warning>
  </_warnings>
  <_processor>
    <expressResponseCode>String</expressResponseCode>
    <expressResponseMessage>String</expressResponseMessage>
    <hostResponseCode>String</hostResponseCode>
    <hostResponseMessage>String</hostResponseMessage>
    <logs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </logs>
    <processorLogs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </processorLogs>
    <processorRawResponse>String</processorRawResponse>
    <processorReferenceNumber>String</processorReferenceNumber>
    <processorRequestFailed>false</processorRequestFailed>
    <processorRequestWasApproved>false</processorRequestWasApproved>
    <processorResponseCode>Unknown</processorResponseCode>
    <processorResponseMessage>String</processorResponseMessage>
    <rawResponse>String</rawResponse>
  </_processor>
  <accountNumber>String</accountNumber>
  <approvalNumber>String</approvalNumber>
  <cardLogo>String</cardLogo>
  <isApproved>false</isApproved>
  <marketCode>String</marketCode>
  <merchantId>String</merchantId>
  <referenceNumber>String</referenceNumber>
  <statusCode>None</statusCode>
  <terminalId>String</terminalId>
  <totalAmount>0</totalAmount>
  <transactionDateTime>String</transactionDateTime>
  <transactionId>String</transactionId>
</incrementalAuthorizationResponse>