Guides
Back to skipify.comContact Us
Start typing to search…

Get, Update, and Delete Configs

Use these methods to Get information on, Update or Delete Configs. Please work with your Implementation Engineer before implementing these methods.

GET All Configs

Overview

This allows you to get All Configuration details for a Merchant

API Request

👍

This endpoint uses API Key Authentication

Check out our API Key Authentication Section to learn more

To GET details of all configurations on a merchant account, send an API call to:

Staging: GET https://merchants.staging.skipify.com/merchants/{merchantId}?hydrate=true&include=configs

Production: GET https://merchants.skipify.com/merchants/{merchantId}?hydrate=true&include=configs

API Response

Response Body Example

{
  "merchantId": "23434068-96d1-45c8-ba95-614edf1abd3b",
  "name": "Merchant Business Name",
  "supportEmailVerified": false,
  "legacy": false,
  "externalCredentials": {
    "payment": "01439ea-f3ff-4f0b-a986-e94182e4bf2a",
    "ecommerce": "2f7c496-e234-4554-9f54-483f13e98ff7"},
  "partnerMerchantId": "359803324-ac67-46ba-923b-84478aabbe04",
  "industry": "Retail",
  "externalPlatformId": null,
  "topLevelMerchantId": "6548403324-ac67-46ba-923b-84478aabbe04",
  "apiKey": "90sdsds8fe9079c54b3c246",
  "schemas": {},
  "createdAt": "2024-01-10T17:33:10.880Z",
  "updatedAt": "2024-01-10T17:33:10.880Z",
  "configs": [
    {
      "merchantId": "215b4598-96d1-45c8-ba95-614edf1abd3b",
      "name": "NON_ACCEPTED_CARD_BRANDS",
      "value": {
        "nonAcceptedCardBrands": [
          "amex"
        ]
      },
      "type": "payment",
      "enabled": true,
      "configId": "34oioiw5f-a73c-4925-a227-0af8e9aff5d3",
      "createdAt": "2024-01-10T17:41:07.907Z",
      "updatedAt": "2024-01-10T17:41:07.907Z",
      "isInherited": false
    },
    {
      "merchantId": "265r9068-96d1-45c8-ba95-614edf1abd3b",
      "name": "AVS_DECLINE",
      "value": true,
      "type": "payment",
      "enabled": true,
      "configId": "bf9853764-51ff-4790-a272-651c28cd5dc1",
      "createdAt": "2025-01-10T17:55:34.069Z",
      "updatedAt": "2025-01-10T17:55:34.069Z",
      "isInherited": false
    },
    {
      "merchantId": "215b6548-96d1-45c8-ba95-614edf1abd3b",
      "name": "SETTLEMENT_TYPE",
      "value": "Sale",
      "type": "payment",
      "enabled": true,
      "configId": "35663c70-9412-436f-b2dc-5e3686f061e9",
      "createdAt": "2024-01-10T19:38:28.596Z",
      "updatedAt": "2024-01-10T19:38:28.596Z",
      "isInherited": false
    },
    {
      "merchantId": "21io8568-96d1-45c8-ba95-614edf1abd3b",
      "name": "NO_SHIPPING_REQUIRED",
      "value": true,
      "type": "order",
      "enabled": true,
      "configId": "d798723e-fe54-4f78-8e98-ba8780faab77",
      "createdAt": "2024-01-10T20:04:20.595Z",
      "updatedAt": "2024-01-10T20:04:20.595Z",
      "isInherited": false
    },
    {
      "merchantId": "214g6068-96d1-98sdc8-ba95-614edf1abd3b",
      "name": "TIPPING_PERCENTAGES",
      "value": [
        18,
        20,
        25
      ],
      "type": "order",
      "enabled": true,
      "configId": "53665sdv-8a7d-4399-b080-ac381ea1f0cf",
      "createdAt": "2024-01-10T20:07:44.359Z",
      "updatedAt": "2024-01-10T20:07:44.359Z",
      "isInherited": false
    },
    {
      "merchantId": "215b9068-96d1-45c8-ba95-614edf1abd3b",
      "name": "GENERAL_FEE",
      "value": {
        "style": "PERCENTAGE",
        "value": 3,
        "description": "Cleaning Fee",
        "feeType": "GENERAL_FEE"
      },
      "type": "order",
      "enabled": true,
      "configId": "bd8ec59a-fa7f-41c0-b72e-167c2f63d51f",
      "createdAt": "2024-02-10T20:15:56.564Z",
      "updatedAt": "2024-02-10T20:15:56.564Z",
      "isInherited": false
    },
    {
      "merchantId": "215b9068-96d1-65fd8-ba95-614edf1abd3b",
      "name": "SURCHARGE_FEE",
      "value": {
        "style": "PERCENTAGE",
        "value": 3,
        "description": "Surcharge",
        "feeType": "SURCHARGE_FEE"
      },
      "type": "order",
      "enabled": true,
      "configId": "9a0f3r0b-3aa4-4798-98e2-4f326b2bdfe8",
      "createdAt": "2024-03-10T20:24:11.328Z",
      "updatedAt": "2024-03-10T20:24:11.328Z",
      "isInherited": false
    },
    {
      "merchantId": "21479068-96d1-45c8-ba95-614edf1abd3b",
      "name": "MERCHANT_BRANDING",
      "value": {
        "displayName": "The Best Biz ever",
        "logoSrc": "https://www.google.com/url?sa=i&url=hsdsdF%2Fwww.skipify.com%2Ffaq&psig=AOvVaw3yZRp3XuxY6fUMpm_8D-mk&ust=1730919279583000&source=images&cd=vfe&opi=89978449&ved=0CBEQjRxqFwoTCNin1PjuxYkDFQAAAAAdAAAAABAE",
        "color": "#2596be",
        "useLogoForPurchaseDetails": true
      },
      "type": "checkout",
      "enabled": true,
      "configId": "e56cd86544-370c-477d-b77f-22a9f58cc062",
      "createdAt": "2023-01-10T20:28:27.222Z",
      "updatedAt": "2023-01-10T20:28:27.222Z",
      "isInherited": false
    },
    {
      "merchantId": "215b9068-34d1-45c8-ba95-614edf1abd3b",
      "name": "TERMS_LINKS",
      "value": {
        "privacyPolicy": {
          "url": "https://privacypolicyhere",
          "enabled": true,
          "complianceStatus": "APPROVED"
        },
        "termsOfUse": {
          "url": "https://termsofmybusiness.com",
          "enabled": true,
          "complianceStatus": "APPROVED"
        },
        "termsAndConditions": {
          "url": "https://yourtermshere.com",
          "enabled": true,
          "complianceStatus": "APPROVED"
        }
      },
      "type": "checkout",
      "enabled": true,
      "configId": "a4e8e802-re0d-4240-b62f-13703c6f4f3f",
      "createdAt": "2023-01-10T20:31:07.336Z",
      "updatedAt": "2023-01-10T20:35:11.207Z",
      "isInherited": false
    },
    {
      "merchantId": "215b9068-96d1-43c8-ba95-614edf1abd3b",
      "name": "DISALLOW_CART_EDITS",
      "value": true,
      "type": "cart",
      "enabled": true,
      "configId": "4435e298-a3e3-4537-9ca7-a122f654cde1",
      "createdAt": "2024-04-10T20:52:15.141Z",
      "updatedAt": "2024-04-10T20:52:15.141Z",
      "isInherited": false
    },
    {
      "merchantId": "45133324-ac67-46ba-923b-84478aabbe04",
      "name": "checkout-test-mode",
      "value": true,
      "type": "checkout",
      "enabled": true,
      "configId": "b7c193f9-13c7-4b9f-8571-744b16414ad5",
      "createdAt": "2024-04-24T23:30:56.778Z",
      "updatedAt": "2024-04-24T23:30:56.778Z",
      "isInherited": true
    },
    {
      "merchantId": "65683324-ac67-46ba-923b-84478aabbe04",
      "name": "SPLIT_PAYMENTS",
      "value": {
        "maxPayments": 2
      },
      "type": "payment",
      "enabled": true,
      "configId": "2a1bf1a9-a161-4a6f-ba28-93c3953039e7",
      "createdAt": "2024-11-04T20:07:54.458Z",
      "updatedAt": "2024-11-04T20:07:54.458Z",
      "isInherited": true
    }
  ],
  "directLineage": [
    "45698724-ac67-46ba-923b-84478aabbe04"
  ],
  "streamlinedFlowEligible": true
}

GET Config By ID

Overview

You may want to look up a Configuration for a number of reasons, like reviewing the details so you can modify it, or just to confirm its status.

API Request

👍

This endpoint uses HMAC

Check out our API Authentication to learn more

This endpoint references the configId of the Config, which was provided in the response body when you created the config.

To Lookup a Configuration, send an API Call to:

Staging: GET https://merchants.staging.skipify.com/merchants/{merchantId}/configs/{configId}

Production: GET https://merchants.skipify.com/merchants/{merchantId}/configs/{configId}

API Response

Response Body Parameters

The response body will include all of the elements that you passed to us when you created the Payment Request. It will also include the following:

Name

Type

Description

enabled

boolean

Is this Config currently enabled?

name

string

The name of this Config

value

array

An array of Values associated with this config

type

string

The Type of Config this is

configId

string

The unique identifier for this config

merchantId

string

The merchantID this config is associated with

createdAt

string, dateTime

The created date/time for this configuration
Ex: 2024-06-02T21:48:02Z

updatedAt

string, dateTime

The updated date/time for this configuration
Ex: 2024-06-02T21:48:02Z

Response Body Example

{
  "enabled": true,
  "name": "NO_SHIPPING_REQUIRED",
  "value": true,
  "type": "order",
  "configId": "d76543e-fe54-4f78-8e98-ba8780faab77",
  "merchantId": "236b4y68-96d1-45c8-ba95-614edf1abd3b",
  "createdAt": "2024-07-10T20:04:20.595Z",
  "updatedAt": "2024-07-10T20:04:20.595Z"
}

Update by Config Id

Overview

This method allows you to update/change a configuration that was previously been created.

API Request

👍

This endpoint uses HMAC

Check out our API Authentication to learn more

This endpoint references the configId of the Config, which was provided in the response body when you created the config.

To Update a Configuration, send an API Call to:

Staging: PATCH https://merchants.staging.skipify.com/merchants/{merchantId}/configs/{configId}

Production: PATCH https://merchants.skipify.com/merchants/{merchantId}/configs/{configId}

Request Body Parameters

Parameter NameRequiredTypeDescription/Value
nameyesstringThe name of the config you are updating i.e. - 'NO_SHIPPING_REQUIRED'
enabledyesbooleanIf you want the config to be enabled or not via this update
valueyesbooleanThe value you want to set the config to

Request Body Example

{
  "name": "string",
  "enabled": false,
  "value": false
}

API Response

Response Body Parameters

Parameter Name

Type

Description

enabled

boolean

The current status of the configuration

name

string

The Name of the Configuration

value

array, integers

The values of tipping percentages configured

type

string, nullable

The Type of configuration if applicable

configId

string

the Id of this configuration

merchantId

string

The Skipify Merchant Identifier

createdAt

string, dateTime

The created date/time for this configuration
Ex: 2024-06-02T21:48:02Z

updatedAt

string, dateTime

The date/time this configuration was last updated
Ex: 2024-06-02T21:48:02Z

Response Body Example

{
  "enabled": false,
  "name": "PARTIAL_AUTHORIZATIONS",
  "value": false,
  "type": "payment",
  "configId": "c9de72b3-b4f3-5b87-9e64-bccdae2fa22d",
  "merchantId": "265b9068-96d1-45c8-ba95-614edf1abd3b",
  "createdAt": "2024-01-10T22:43:05.898Z",
  "updatedAt": "2024-06-09T22:44:06.528Z"
}

Delete a Config

Overview

This method allows you to delete a configuration on a merchant account. Please confirm with your Skipify Implementation Engineer before deleting any configurations as there could be unintended consequences.

API Request

👍

This endpoint uses HMAC

Check out our API Authentication to learn more

This endpoint references the configId of the Config, which was provided in the response body when you created the config.

To Delete a Configuration, send an API call to:

Staging: DELETE https://merchants.staging.skipify.com/merchants/{merchantId}/configs/{configId}

Production: DELETE https://merchants.skipify.com/merchants/{merchantId}/configs/{configId}

API Response

200 OK

Updated about 1 month ago