triPOS REST API

<back to all web services

ReturnRequest

The following routes are available for this service:
POST/api/v1/return/{transactionId}/{paymentType}Creates a new card return based on the passed in parameters.Creates a new card return based on the passed in parameters. More»
POST/api/v1/sale/{transactionId}/return/{paymentType}[Deprecated] Use /api/v1/return/{transactionId}/{paymentType} instead.
ReturnRequest Parameters:
NameParameterData TypeRequiredDescription
ConfigurationbodyRequestConfigurationNoAny value included in this section will override the corresponding value set in the triPOS.config
PaymentTypepathstringYesThe original payment type.

Allowable Values

  • credit
  • gift
TransactionAmountbodydecimalNoThe total transaction amount. This is the amount of funds to move on the card
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.
RequestConfiguration Parameters:
NameParameterData TypeRequiredDescription
AllowPartialApprovalsbodybool?NoIf set to true, partial approvals are allowed
CheckForDuplicateTransactionsbodybool?NoIf set to true, enables duplicate checking logic for the transaction at the host.
CurrencyCodebodyCurrencyCode?NoThe currency code of the transaction.

Allowable Values

  • None
  • Cad
  • Usd
  • Eur
MarketCodebodyMarketCodeNoThe market code of the transaction.

Allowable Values

  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
BaseCardResponse Parameters:
NameParameterData TypeRequiredDescription
AccountNumberbodystringNoThe card account number.
BinValuebodystringNoThe BIN entry that matched the account number.
CardHolderNamebodystringNoThe card holder name.
CardLogobodystringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
CurrencyCodebodyCurrencyCodeNoThe currency code used in the transaction.

Allowable Values

  • None
  • Cad
  • Usd
  • Eur
EntryModebodystringNoDescription of how card was entered.

Allowable Values

  • 
  • 
  • 
  • 
  • 
ExpirationYearbodystringNoThe card's expiration year
ExpirationMonthbodystringNoThe card's expiration month
PaymentTypebodyPaymentTypeNoDescription of payment type utilized.

Allowable Values

  • None
  • Credit
  • Debit
  • Gift
PinVerifiedbodyboolNoTrue if the PIN was verified, false if not verified or undetermined.
SignaturebodySignatureNoThe signature data.
TerminalIdbodystringNoThe ID of the terminal used during the transaction
TotalAmountbodydecimalNoThe total amount of the transaction.

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

<returnRequest 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>
    <allowPartialApprovals>false</allowPartialApprovals>
    <checkForDuplicateTransactions>false</checkForDuplicateTransactions>
    <currencyCode>None</currencyCode>
    <marketCode>Default</marketCode>
  </configuration>
  <paymentType>None</paymentType>
  <transactionAmount>0</transactionAmount>
  <transactionId>String</transactionId>
</returnRequest>

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

<returnResponse 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>
  <approvalNumber>String</approvalNumber>
  <isApproved>false</isApproved>
  <merchantId>String</merchantId>
  <statusCode>None</statusCode>
  <transactionDateTime>String</transactionDateTime>
  <transactionId>String</transactionId>
  <accountNumber>String</accountNumber>
  <binValue>String</binValue>
  <cardHolderName>String</cardHolderName>
  <cardLogo>String</cardLogo>
  <currencyCode>None</currencyCode>
  <entryMode>String</entryMode>
  <expirationMonth>String</expirationMonth>
  <expirationYear>String</expirationYear>
  <paymentType>None</paymentType>
  <pinVerified>false</pinVerified>
  <signature>
    <data>AA==</data>
    <format>String</format>
    <statusCode>Unknown</statusCode>
  </signature>
  <terminalId>String</terminalId>
  <totalAmount>0</totalAmount>
</returnResponse>