triPOS REST API

<back to all web services

PaymentAccountRefundRequest

The following routes are available for this service:
POST/api/v1/refund/{paymentAccountId}Creates a new payment account refund based on the passed in parameters.
PaymentAccountRefundRequest Parameters:
NameParameterData TypeRequiredDescription
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
PaymentAccountIdpathstringYesThe payment account ID.
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. 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
PaymentAccountRefundResponse Parameters:
NameParameterData TypeRequiredDescription
ConvenienceFeeAmountbodydecimalNoThe convenience fee added to the transaction
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
TotalAmountbodydecimalNoThe total amount of the transaction.
PaymentAccountIdbodystringNoThe payment account ID.
PaymentAccountReferenceNumberbodystringNoThe payment account reference number.
ReferenceNumberbodystringNoThe reference number.
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 .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/PaymentAccountRefundRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/xml
Content-Length: length

<paymentAccountRefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <clerkNumber>String</clerkNumber>
  <configuration>
    <allowPartialApprovals>false</allowPartialApprovals>
    <checkForDuplicateTransactions>false</checkForDuplicateTransactions>
    <currencyCode>None</currencyCode>
    <marketCode>Default</marketCode>
  </configuration>
  <convenienceFeeAmount>0</convenienceFeeAmount>
  <laneId>0</laneId>
  <paymentAccountId>String</paymentAccountId>
  <referenceNumber>String</referenceNumber>
  <shiftId>String</shiftId>
  <ticketNumber>String</ticketNumber>
  <transactionAmount>0</transactionAmount>
</paymentAccountRefundRequest>

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

<paymentAccountRefundResponse 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>
  <cardLogo>String</cardLogo>
  <convenienceFeeAmount>0</convenienceFeeAmount>
  <paymentAccountId>String</paymentAccountId>
  <paymentAccountReferenceNumber>String</paymentAccountReferenceNumber>
  <referenceNumber>String</referenceNumber>
  <terminalId>String</terminalId>
  <totalAmount>0</totalAmount>
</paymentAccountRefundResponse>