Configurations

Configurations return merchant-level settings.

These are settings that other endpoints depend on, rather than records a merchant creates or edits directly. Because these values shape what other endpoints accept, checking this configuration first can prevent avoidable errors. For example, such as attempting a tip adjustment when isTipsEnabled is false.

Two endpoints make up this group. Both are read-only; there is no way to create, update, or delete a configuration through the API itself.

GET /pay-api/v1/configurations/contact-infos. The contact-infos endpoint returns the merchant's address, phone number, and card details, information that can be reused elsewhere, such as when creating an invoice.
GET /pay-api/v1/configurations/payments. The payments endpoint returns the settings that govern how transactions are processed for the merchant account. This includes tipping is enabled, the available currencies, card types, and transaction types, and the list of configured payment processors, each with its own settlement batch time slots. It also reports defaults such as the surcharge rate, cash discount rate, and dual pricing rate, along with AVS options and the maximum allowed transaction amount.

Operations

Lists payments configuration

Request

GET {{baseURL}}/pay-api/v1/configurations/payments

This endpoint returns a list of payment configurations.

See Also:
To retrieve a merchant's contact information, see GET /pay-api/v1/configurations/contact-infos.

Security

Bearer

curl -i -X GET \
  https://developer.flute.com/_mock/api-reference/pay-api/v1/configurations/payments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

zeroCostProcessingOptionIdinteger, (int32)

Identifies the zero cost processing option.

Possible values:

Id	Type
1	None
2	CashDiscount
3	DualPricing
4	Surcharge

Example: 3

Example:3

zeroCostProcessingOptionstring or null

Zero cost processing option name.

Possible values:

Id	Value
None	1
CashDiscount	2
DualPricing	3
Surcharge	4

Example: DualPricing

Example:"DualPricing"

defaultTipsOptionsArray of numbers or null

Identifies an array of default, or preselected, tip options.

These values could be displayed on a receipt as preselected tip value options. The client's app and UX needs to support that display. They are presented as a percent alongside the actual money amount. The intent is to present these values from which clients can quickly select a tip amount. They are suggestions presented only as a convenience to the client. The client should be able to select any value, a custom value, or no value.

These values are configured by the merchant.

Example: [10, 15.25, 20.5]

Example:

[
  10,
  15.25,
  20.5
]

isTipsEnabledboolean

Indicates tips are enabled.

If true, tips are enabled.
If false, tips are not enabled. Transactions with tip values will fail with a 400 response. This also includes the one-step transaction POST {{baseURL}}/pay-api/v1/transactions/sale.

Tips are enabled or disabled in the Sandbox Merchant dashboard.

Example: true

Example:true

defaultSurchargeRatenumber or null, (double)

Identifies the default surcharge rate.

This value is configured by the merchant.

Example: 3.5

Example:3.5

defaultCashDiscountRatenumber or null, (double)

Identifies the default cash discount rate.

This value is configured by the merchant.

Example: 3.5 (as 3.5%)

Example:3.5

defaultDualPricingRatenumber or null, (double)

Identifies the default dual pricing rate.

Dual pricing is when the merchant displays two prices for the same product. For example, for cash or credit card. The dual pricing rate is the additional charge for the other price, such as with a credit card.

This value is configured by the merchant.

Example: 3.5 (as 3.5%)

Example:3.5

availableCurrenciesArray of objects or null

Identifies the available currencies

availableCardTypesArray of objects or null

Available card types.

availableTransactionTypesArray of objects or null

Indicates available transactions types.

availablePaymentProcessorsArray of objects or null

Available payment processors.

avsobject

Indicates the merchant's AVS (address verification service) configuration.

isCustomerCardSavingByTerminalEnabledboolean

Indicates the terminal saves the customer's card after the transaction is processed.

If true, the customer's card is saved.
If false, the customer's card is not saved.

Example: true

Example:true

companyNamestring or null

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

Example: Peppared Street Cafe

Example:"Peppared Street Cafe"

mccCodestring or null

Indicates the MCC (merchant category code).

Example: 28

Example:"28"

mccCodeDescriptionstring or null

Indicates the merchant category code description.

Example: Hospitals

Example:"Hospitals"

currencyIdinteger, (int32)

Indicates the currency identifier.

Possible values can be found in AvailableCurrencies.

Example: 1 (for USD)

Example:1

currencyIsoCodestring or null

Indicates the currency (in ISO 4217 alpha-3 currency code format).

Example: USD

Example:"USD"

maxTransactionAmountnumber or null, (double)

Indicates the maximum transaction amount limit.

Example: 32000

Example:32000

Response

{
  "zeroCostProcessingOptionId": 1,
  "zeroCostProcessingOption": null,
  "defaultTipsOptions": null,
  "defaultSurchargeRate": null,
  "defaultCashDiscountRate": null,
  "defaultDualPricingRate": null,
  "availableCurrencies": [
    {
      "id": 1,
      "name": "USD"
    }
  ],
  "availableCardTypes": [
    {
      "id": 0,
      "name": "Unknown"
    },
    {
      "id": 1,
      "name": "Visa"
    },
    {
      "id": 2,
      "name": "MasterCard"
    },
    {
      "id": 3,
      "name": "AmericanExpress"
    },
    {
      "id": 4,
      "name": "DinersClub"
    },
    {
      "id": 5,
      "name": "Discover"
    },
    {
      "id": 6,
      "name": "JCB"
    }
  ],
  "availableTransactionTypes": [
    {
      "id": 2,
      "name": "Sale"
    },
    {
      "id": 3,
      "name": "Capture"
    },
    {
      "id": 5,
      "name": "Refund"
    },
    {
      "id": 4,
      "name": "Void"
    },
    {
      "id": 6,
      "name": "CardAuthentication"
    },
    {
      "id": 7,
      "name": "RefundWORef"
    },
    {
      "id": 8,
      "name": "TipAdjustment"
    }
  ],
  "isTipsEnabled": true,
  "availablePaymentProcessors": [
    {
      "id": "9e8d7c6b-5a4f-4e3d-b2c1-0a9b8c7d6e14",
      "name": "TSYS",
      "isDefault": true,
      "typeId": 0,
      "type": null,
      "settlementBatchTimeSlots": [
        {
          "hours": 2,
          "minutes": 10,
          "timezoneName": "America/New_York"
        }
      ]
    }
  ],
  "avs": {
    "isEnabled": true,
    "profileId": 1,
    "profile": "Strict"
  },
  "isCustomerCardSavingByTerminalEnabled": false,
  "companyName": null,
  "mccCode": null,
  "mccCodeDescription": null,
  "currencyId": 1,
  "currencyIsoCode": null,
  "maxTransactionAmount": null
}

Configurations

Lists payments configuration

Request

Responses

Was this helpful?