| GET | /api/v1/configuration/transaction | Retrieve transaction settings. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowPartialApprovals | body | bool? | No | If set to true, partial approvals are allowed. |
| ConfirmOriginalAmount | body | bool? | No | If set to true, the PIN Pad will prompt the cardholder to confirm the original amount. |
| CreditAvsEntryCondition | body | CreditAvsEntryConditionTypes? | No | Set to true when AVS entry (billing postal code entry) should be prompted for credit transactions.Allowable Values
|
| CheckForDuplicateTransactions | body | bool? | No | If set to true, enables duplicate checking logic for the transaction at the host. This can be overridden on a per request basis. |
| CurrencyCode | body | CurrencyCode? | No | The currency code that will be used for all transactions.Allowable Values
|
| IsCashBackAllowed | body | bool? | No | Set to true to allow cashback. |
| IsDebitSupported | body | bool? | No | Set 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. |
| IsEmvSupported | body | bool? | No | Set to true to enable your application to accept EMV transactions. Set to false to not allow EMV transactions. |
| IsGiftSupported | body | bool? | No | Set 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. |
| IsConvenienceFeeAllowed | body | bool? | No | Set to true to allow convenience fees to be added. |
| IsTipAllowed | body | bool? | No | Set to true to allow tips to be added. |
| CashBackSelections | body | string | No | Enter whole numbers separated by commas for the cashback amounts to select from. |
| CashBackIncrement | body | string | No | Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20. |
| MarketCode | body | MarketCode? | No | The market code specific to the type of transaction being submitted. Can be overridden on a per request basis.Allowable Values
|
| MaximumCashbackAmount | body | int? | No | The maximum cashback amount you want to allow cardholders to get back |
| TipSelections | body | string | No | Enter 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 |
| DebitSurcharge | body | double? | No | Enter 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' |
| CreditSaleSignatureThresholdAmount | body | double? | No | Leave 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 |
| SignatureFormat | body | SignatureFormat? | No | The format which signature data should come back as.Allowable Values
|
| EmvFallbackAllowed | body | EmvFallback | No | Allow Emv Fallback.Allowable Values
|
| IsHealthcareSupported | body | bool | No | If 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/GetTransactionConfigurationRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/xml
Content-Length: length
<getTransactionConfigurationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<getTransactionConfigurationResponse 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>
</getTransactionConfigurationResponse>