triPOS REST API

<back to all web services

UpdateTransactionConfigurationRequest

The following routes are available for this service:
PUT/api/v1/configuration/transactionUpdate transaction settings.
UpdateTransactionConfigurationRequest Parameters:
NameParameterData TypeRequiredDescription
AllowPartialApprovalsbodybool?NoIf set to true, partial approvals are allowed.
ConfirmOriginalAmountbodybool?NoIf set to true, the original transaction amount will be confirmed after card information is obtained.
CreditAvsEntryConditionbodyCreditAvsEntryConditionTypes?NoSet to true when AVS entry (billing postal code entry) should be prompted for credit transactions.

Allowable Values

  • Always
  • Never
  • Keyed
CheckForDuplicateTransactionsbodybool?NoIf set to true, enables duplicate checking logic for the transaction at the host. This can be overridden on a per request basis.
CurrencyCodebodyCurrencyCode?NoThe currency code that will be used for all transactions.

Allowable Values

  • None
  • Cad
  • Usd
  • Eur
IsCashBackAllowedbodybool?NoSet to true to allow cashback.
IsDebitSupportedbodybool?NoSet to true to allow debit only cards to be used. The credit functionality of check cards will still work if this is set to false.
IsEmvSupportedbodybool?NoSet to true to enable your application to accept EMV transactions. Set to false to not allow EMV transactions.
IsGiftSupportedbodybool?NoSet to true to allow gift only cards to be used. The credit functionality of check cards will still work if this is set to false.
IsConvenienceFeeAllowedbodybool?NoSet to true to allow convenience fees to be added.
IsTipAllowedbodybool?NoSet to true to allow tips to be added.
CashBackSelectionsbodyint[]NoEnter whole numbers separated by commas for the cashback amounts to select from.
OtherCashBackSelectionbodyboolNoEnter true if you would like "Other" option to show up on cashback selection screen.
CashBackIncrementbodyint?NoIncrements you want customers to be able to get back. Common values include, 1, 5, 10 and 20.
MarketCodebodyMarketCode?NoThe market code specific to the type of transaction being submitted. This global value can be set, but it can be overridden on a per request basis.

Allowable Values

  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
MaximumCashbackAmountbodyint?NoThe maximum cashback amount you want to allow cardholders to get back
PercentageTipSelectionsbodydouble[]NoEnter decimal numbers to be used as percent values for tip amounts. This means { 10, 15.5, 20.0 } will become the following tip selections (10%, 15.5%, 20%). If percent values are provided for tip amounts then decimal tip amounts will be ignored.
DecimalTipSelectionsbodydouble[]NoEnter decimal numbers for tip amounts. If percent values were provided for tip amounts then these values will be ignored.
NoneTipSelectionbodyboolNoEnter true to show "None" on the PIN pad during tip selection. If false is entered "Other" will be shown instead.
DebitSurchargebodydouble?NoEnter a decimal amount to add to debit transactions. Please read the credit / debit card surcharge statutes as they pertain to your state of business: 'http://www.ncsl.org/research/financial-services-and-commerce/credit-or-debit-card-surcharges-statutes.aspx'
CreditSaleSignatureThresholdAmountbodydouble?NoLeave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be surpassed before asking for a signature, such as 25.00
SignatureFormatbodySignatureFormat?NoThe format which signature data should come back as.

Allowable Values

  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
EmvFallbackAllowedbodyEmvFallback?NoAllow Emv Fallback.

Allowable Values

  • NeverAllow
  • AllowAfterChipError
IsHealthcareSupportedbodyboolNoIf set to true, Healthcare fields are allowed.
UpdateTransactionConfigurationResponse Parameters:
NameParameterData TypeRequiredDescription
TransactionSettingsUpdatedbodyboolNoTrue is transaction settings were updated successfully and false otherwise.
BaseTransactionConfigurationResponse Parameters:
NameParameterData TypeRequiredDescription
AllowPartialApprovalsbodybool?NoIf set to true, partial approvals are allowed.
ConfirmOriginalAmountbodybool?NoIf set to true, the PIN Pad will prompt the cardholder to confirm the original amount.
CreditAvsEntryConditionbodyCreditAvsEntryConditionTypes?NoSet to true when AVS entry (billing postal code entry) should be prompted for credit transactions.

Allowable Values

  • Always
  • Never
  • Keyed
CheckForDuplicateTransactionsbodybool?NoIf set to true, enables duplicate checking logic for the transaction at the host. This can be overridden on a per request basis.
CurrencyCodebodyCurrencyCode?NoThe currency code that will be used for all transactions.

Allowable Values

  • None
  • Cad
  • Usd
  • Eur
IsCashBackAllowedbodybool?NoSet to true to allow cashback.
IsDebitSupportedbodybool?NoSet to true to allow debit only cards to be used. The credit functionality of check cards will still work if this is set to false.
IsEmvSupportedbodybool?NoSet to true to enable your application to accept EMV transactions. Set to false to not allow EMV transactions.
IsGiftSupportedbodybool?NoSet to true to allow gift only cards to be used. The credit functionality of check cards will still work if this is set to false.
IsConvenienceFeeAllowedbodybool?NoSet to true to allow convenience fees to be added.
IsTipAllowedbodybool?NoSet to true to allow tips to be added.
CashBackSelectionsbodystringNoEnter whole numbers separated by commas for the cashback amounts to select from.
CashBackIncrementbodystringNoIncrements you want customers to be able to get back. Common values include, 1, 5, 10 and 20.
MarketCodebodyMarketCode?NoThe market code specific to the type of transaction being submitted. Can be overridden on a per request basis.

Allowable Values

  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
MaximumCashbackAmountbodyint?NoThe maximum cashback amount you want to allow cardholders to get back
TipSelectionsbodystringNoEnter decimal numbers for tip amounts. Add percent sign after the number to display calculated percentages (i.e. 10%, 15%, 20%). If any value is a percentage, it is assumed that all values are percentages. Add 'none' to show 'None' on the pin pad, otherwise 'Other' will always be shown on the pin pad
DebitSurchargebodydouble?NoEnter a decimal amount to add to debit transactions. Please read the credit / debit card surcharge statutes as they pertain to your state of business: 'http://www.ncsl.org/research/financial-services-and-commerce/credit-or-debit-card-surcharges-statutes.aspx'
CreditSaleSignatureThresholdAmountbodydouble?NoLeave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be surpassed before asking for a signature, such as 25.00
SignatureFormatbodySignatureFormat?NoThe format which signature data should come back as.

Allowable Values

  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
EmvFallbackAllowedbodyEmvFallbackNoAllow Emv Fallback.

Allowable Values

  • NeverAllow
  • AllowAfterChipError
IsHealthcareSupportedbodyboolNoIf set to true, Healthcare fields are allowed.

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

<updateTransactionConfigurationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <allowPartialApprovals>false</allowPartialApprovals>
  <cashBackIncrement>0</cashBackIncrement>
  <cashbackSelections xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </cashbackSelections>
  <checkForDuplicateTransactions>false</checkForDuplicateTransactions>
  <confirmOriginalAmount>false</confirmOriginalAmount>
  <creditAvsEntryCondition>Always</creditAvsEntryCondition>
  <creditSaleSignatureThresholdAmount>0</creditSaleSignatureThresholdAmount>
  <currencyCode>None</currencyCode>
  <debitSurcharge>0</debitSurcharge>
  <decimalTipSelections xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:double>0</d2p1:double>
  </decimalTipSelections>
  <emvFallbackAllowed>NeverAllow</emvFallbackAllowed>
  <isCashBackAllowed>false</isCashBackAllowed>
  <isConvenienceFeeAllowed>false</isConvenienceFeeAllowed>
  <isDebitSupported>false</isDebitSupported>
  <isEmvSupported>false</isEmvSupported>
  <isGiftSupported>false</isGiftSupported>
  <isHealthcareSupported>false</isHealthcareSupported>
  <isTipAllowed>false</isTipAllowed>
  <marketCode>Default</marketCode>
  <maximumCashbackAmount>0</maximumCashbackAmount>
  <noneTipSelection>false</noneTipSelection>
  <otherCashbackSelection>false</otherCashbackSelection>
  <percentTipSelections xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:double>0</d2p1:double>
  </percentTipSelections>
  <signatureFormat>PointsLittleEndian</signatureFormat>
</updateTransactionConfigurationRequest>

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

<updateTransactionConfigurationResponse 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>
    <link>
      <href>/api/v1/configuration/transaction</href>
      <method>GET</method>
      <rel>transactionConfiguration</rel>
    </link>
    <link>
      <href>/api/v1/configuration/transaction</href>
      <method>PUT</method>
      <rel>transactionConfiguration</rel>
    </link>
  </_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>
  <allowPartialApprovals>false</allowPartialApprovals>
  <cashBackIncrement>String</cashBackIncrement>
  <cashBackSelections>String</cashBackSelections>
  <checkForDuplicateTransactions>false</checkForDuplicateTransactions>
  <confirmOriginalAmount>false</confirmOriginalAmount>
  <creditAvsEntryCondition>Always</creditAvsEntryCondition>
  <creditSaleSignatureThresholdAmount>0</creditSaleSignatureThresholdAmount>
  <currencyCode>None</currencyCode>
  <debitSurcharge>0</debitSurcharge>
  <emvFallbackAllowed>NeverAllow</emvFallbackAllowed>
  <isCashBackAllowed>false</isCashBackAllowed>
  <isConvenienceFeeAllowed>false</isConvenienceFeeAllowed>
  <isDebitSupported>false</isDebitSupported>
  <isEmvSupported>false</isEmvSupported>
  <isGiftSupported>false</isGiftSupported>
  <isHealthcareSupported>false</isHealthcareSupported>
  <isTipAllowed>false</isTipAllowed>
  <marketCode>Default</marketCode>
  <maximumCashbackAmount>0</maximumCashbackAmount>
  <signatureFormat>PointsLittleEndian</signatureFormat>
  <tipSelections>String</tipSelections>
  <transactionUpdated>false</transactionUpdated>
</updateTransactionConfigurationResponse>