| PUT | /api/v1/configuration/transaction | Update 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 original transaction amount will be confirmed after card information is obtained. |
| 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 | int[] | No | Enter whole numbers separated by commas for the cashback amounts to select from. |
| OtherCashBackSelection | body | bool | No | Enter true if you would like "Other" option to show up on cashback selection screen. |
| CashBackIncrement | body | int? | 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. This global value can be set, but it 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 |
| PercentageTipSelections | body | double[] | No | Enter 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. |
| DecimalTipSelections | body | double[] | No | Enter decimal numbers for tip amounts. If percent values were provided for tip amounts then these values will be ignored. |
| NoneTipSelection | body | bool | No | Enter true to show "None" on the PIN pad during tip selection. If false is entered "Other" will be shown instead. |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransactionSettingsUpdated | body | bool | No | True is transaction settings were updated successfully and false otherwise. |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/UpdateTransactionConfigurationRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{"allowPartialApprovals":false,"confirmOriginalAmount":false,"creditAvsEntryCondition":"Always","checkForDuplicateTransactions":false,"currencyCode":"None","isCashBackAllowed":false,"isDebitSupported":false,"isEmvSupported":false,"isGiftSupported":false,"isConvenienceFeeAllowed":false,"isTipAllowed":false,"cashbackSelections":[0],"otherCashbackSelection":false,"cashBackIncrement":0,"marketCode":"Default","maximumCashbackAmount":0,"percentTipSelections":[0],"decimalTipSelections":[0],"noneTipSelection":false,"debitSurcharge":0,"creditSaleSignatureThresholdAmount":0,"signatureFormat":"PointsLittleEndian","emvFallbackAllowed":"NeverAllow","isHealthcareSupported":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"transactionUpdated":false,"allowPartialApprovals":false,"confirmOriginalAmount":false,"creditAvsEntryCondition":"Always","checkForDuplicateTransactions":false,"currencyCode":"None","isCashBackAllowed":false,"isDebitSupported":false,"isEmvSupported":false,"isGiftSupported":false,"isConvenienceFeeAllowed":false,"isTipAllowed":false,"cashBackSelections":"String","cashBackIncrement":"String","marketCode":"Default","maximumCashbackAmount":0,"tipSelections":"String","debitSurcharge":0,"creditSaleSignatureThresholdAmount":0,"signatureFormat":"PointsLittleEndian","emvFallbackAllowed":"NeverAllow","isHealthcareSupported":false,"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[{"href":"/api/v1/configuration/transaction","method":"GET","rel":"transactionConfiguration"},{"href":"/api/v1/configuration/transaction","method":"PUT","rel":"transactionConfiguration"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}