Lists payment configuration

Request

GET {{baseURL}}/v2/settings/payment-configuration

This endpoint lists the payment configuration settings.

It returns the merchant's processor setup, zero cost processing options, tip settings, supported currencies and card types, and terminal profile identifiers. Call it at startup to learn which payment features are available for the authenticated merchant.

pricingType is only meaningful for merchants configured for Dual Pricing. It tells whether the merchant currently prices in card or cash terms.

This endpoint requires a merchant API token. A partner API token is rejected with a 403 response, even if the partner has the GeneralConfigurations permission. This endpoint only runs for merchant-scoped tokens. A merchant API token managed by a partner also requires that partner's account to have the GeneralConfigurations permission. Otherwise, the request returns a 403 response.

See Also:
To retrieve the merchant's locations, see GET /v2/settings/locations.
To retrieve the transaction autofill settings, see GET /v2/settings/transaction-autofill.
To update the transaction autofill settings, see PATCH /v2/settings/transaction-autofill.

[ Response body ]

Security

Bearer

// Language is not supported.

Responses

Bodyapplication/json

merchantIdstring, (UUID)

Identifies the authenticated merchant.

Example: 195c89de-b0f8-4768-a421-da07f71b1a7f

Example:"195c89de-b0f8-4768-a421-da07f71b1a7f"

merchantCompanyNamestring or null, <= 100 characters

Indicates the name of the merchant's company or organization.

This is a free-formed name that is convenient for the merchant to recognize.

Example: Peppared Street Cafe

Example:"Peppared Street Cafe"

currencyCodestring

Indicates the available currency (in uppercase ISO 4217 currency code).

Example: USD

Value:"USD"

Example:"USD"

mccCodestring or null

Indicates the MCC (merchant category code).

Example: 5411

Example:"5411"

mccDescriptionstring or null

Indicates the MCC (merchant category code) description.

Example: Grocery Stores, Supermarkets

Example:"Grocery Stores, Supermarkets"

maxTransactionAmountnumber or null, (double)

Indicates the maximum transaction amount limit.

Example: 10000

Example:10000

zeroCostProcessingOptionstring

Indicates the zero cost processing option.

Zero cost processing is a pricing strategy that the merchant passes the cost of credit card processing fees on to the customer. The result is that the merchant pays little to no fees.

Valid values are:

Type	Meaning
CashDiscount	Customers paying with cash receive a discount off the posted price.
DualPricing	Two prices are displayed side by side. This is a cash price and a card price. The customer chooses which to pay.
None	The merchant absorbs the processing fees themselves.
Surcharge	A fee is added to the transaction when a customer pays by credit card. The surcharge amount covers the processing cost.

Example: DualPricing

Enum:"None""CashDiscount""DualPricing""Surcharge"

Example:"DualPricing"

pricingTypestring or null

Identifies the type of pricing.

This value is required only when Dual Pricing is enabled.

Valid values are:

Status	Explanation
Card	The transaction uses the card price, which may include a surcharge.
Cash	The transaction uses the cash price, which may include a cash discount.

Example: Card

Enum:"Card""Cash"

Example:"Card"

defaultSurchargeRatenumber or null, (double)

Indicates the default surcharge rate.

Examples:
1.5 (as 1.5%)
5 (as 5%)
22 (as 22%)

Example:1.5

defaultCashDiscountRatenumber or null, (double)

Indicates the cash discount rate.

Examples:
1.5 (as 1.5%)
5 (as 5%)
20 (as 20%)

Example:1.5

defaultDualPricingRatenumber or null, (double)

Indicates the default dual pricing rate.

Examples:
1.8 (as 1.8%)
5 (as 5%)
20 (as 20%)

Example:1.8

isTipsEnabledboolean

Indicates tips are enabled.

If true, tips are enabled.
If false, tips are not enabled.

Example: true

Example:true

defaultTipOptionsArray of numbers, (double)

Indicates the default tip percentage suggestion options.

This is an array of percentage values that display at the time of purchase. They offer preselected tip percentage suggestions as a convenience for the purchasers.

It is empty when the merchant has not configured any tip options.

Example: [ 15, 18, 20 ] (as 15%, 18%, and 20%)

Example:

availableCurrenciesArray of strings

Indicates the available currencies (in uppercase ISO 4217 currency code).

Example: USD

Example:

[
  "USD"
]

availableCardTypesArray of strings

Indicates the available card types.

Example: [ "Visa", "MasterCard", "AmericanExpress" ]

Example:

[
  "Visa",
  "MasterCard",
  "AmericanExpress"
]

availableTransactionTypesArray of strings

Indicates the available transaction types.

Example: [ "Authorization", "Sale", "Refund" ]

Example:

[
  "Authorization",
  "Sale",
  "Refund"
]

addressVerificationobject or null

Indicates the merchant's Address Verification Service settings.

Returned as null when AVS is not configured for the merchant.

tapToPayAppleProfileIdstring or null

Indicates the Apple Tap to Pay terminal profile identifier, used by the Flute Mobile SDK for iOS.

Example: ttp-ios-profile-123

Example:"ttp-ios-profile-123"

availablePaymentProcessorsArray of objects

Indicates the available payment processors.

Response

A restaurant that takes cards and ACH, with tips enabled and no zero cost processing.

{
  "merchantId": "746ba4dd-b1b4-47c3-a034-72aa55007e86",
  "merchantCompanyName": "Peppared Street Cafe",
  "currencyCode": "USD",
  "mccCode": "5812",
  "mccDescription": "Eating Places and Restaurants",
  "maxTransactionAmount": 5000,
  "zeroCostProcessingOption": "None",
  "pricingType": "Card",
  "defaultSurchargeRate": null,
  "defaultCashDiscountRate": null,
  "defaultDualPricingRate": null,
  "isTipsEnabled": true,
  "defaultTipOptions": [
    15,
    18,
    20
  ],
  "availableCurrencies": [
    "USD"
  ],
  "availableCardTypes": [
    "Visa",
    "MasterCard",
    "AmericanExpress",
    "Discover",
    "JCB"
  ],
  "availableTransactionTypes": [
    "AchCancel",
    "AchCredit",
    "AchDebit",
    "AchHold",
    "AchRefund",
    "AchUnHold",
    "Authorization",
    "Capture",
    "CardAuthentication",
    "Refund",
    "RefundWORef",
    "Sale",
    "TipAdjustment",
    "Void"
  ],
  "addressVerification": {
    "isEnabled": true,
    "profile": "Moderate"
  },
  "tapToPayAppleProfileId": "ttp-ios-5812-peppared",
  "availablePaymentProcessors": [
    {
      "paymentProcessorId": "36e0e61e-3614-4c68-a919-1bffc8bdb7b6",
      "processorName": "Primary card processor",
      "processorType": "Tsys",
      "isDefault": true,
      "settlementBatchSchedule": [
        {
          "scheduledHour": 2,
          "scheduledMinute": 0,
          "timezoneId": "America/Los_Angeles"
        }
      ]
    },
    {
      "paymentProcessorId": "8932c37e-9ae0-46ed-8da4-e70eb9458596",
      "processorName": "ACH processor",
      "processorType": "Ach",
      "isDefault": false,
      "settlementBatchSchedule": [
        {
          "scheduledHour": 17,
          "scheduledMinute": 30,
          "timezoneId": "America/Los_Angeles"
        }
      ]
    }
  ]
}