Create Merchant Configs - Order Preferences
Use these endpoints to set Configs related to Order Preferences
This endpoint uses HMAC with SHA-256
Check out our API Authentication section to learn more
To Add Merchant Configurations to a Skipify Merchant Account, send an API call to:
Staging: POST https://stage-merchants.skipify.com/merchants/{MerchantId}/configs
Production: POST https://merchants.skipify.com/merchants/{MerchantId}/configs
Create No Shipping Required Config
Request Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | NO_SHIPPING_REQUIRED |
| enabled | yes | boolean | true |
| value | yes | boolean | true |
Request Body Example
{
"name": "NO_SHIPPING_REQUIRED",
"enabled": true,
"value": true
}
API Response
Response Body Parameters (WIP)
| Parameter Name | Type | Description |
|---|---|---|
| merchantId | string | The Skipify Merchant identifier |
| name | integer | The name of the configuration |
| value | boolean | true |
| type | boolean, nullable | null |
| enabled | string, nullable | |
| schemaVersion | integer | The version of the schema |
| isDeleted | boolean | false |
| _id | string | The ID of this request |
| configId | string | The ID of this configuration |
| createdAt | string, dateTime | The date/time this configuration was created Ex: `2024-06-02T21:48:02Z |
| updatedAt | string, dateTime | The date/time this configuration was last updated Ex: `2024-06-02T21:48:02Z |
| _v | strgin | reserved for future use |
Response Body Example
{
"merchantId": "string",
"name": "NO_SHIPPING_REQUIRED",
"value": true,
"type": null,
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"_id": "string",
"configId": "string",
"createdAt": "2024-05-06T19:02:13.133Z",
"updatedAt": "2024-05-06T19:02:13.133Z",
"__v": 0
}
Create Tipping Percentages Config
Request Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | TIPPING_PERCENTAGES |
| enabled | yes | boolean | true |
| value | yes | array/integers | Send Tipping percentage prompts to be displayed to Shopper |
Note* - This Configuration is only applicable to merchants that accept tips/gratuities in service-based establishments.
Request Body Example
{
"name": "TIPPING_PERCENTAGES",
"enabled": true,
"value": [
18,
20,
25
]
}
API Response
Response Body Parameters
| Parameter Name | Type | Description |
|---|---|---|
| merchantId | string | The Skipify Merchant Identifier |
| 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 |
| enabled | boolean | The current status of the configuration |
| schemaVersion | integer | The version of the schema |
| isDeleted | boolean | Is this configuration active or not |
| _id | string | The id of this request |
| configId | string | the Id of this configuration |
| 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 |
| _v | integer | 0 |
Response Body Example
{
"merchantId": "string",
"name": "TIPPING_PERCENTAGES",
"value": [
18,
20,
25
],
"type": null,
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"_id": "string",
"configId": "string",
"createdAt": "2024-04-26T19:54:07.050Z",
"updatedAt": "2024-04-26T19:54:07.050Z",
"__v": 0
}
Create General Fee Config
The General Fee Configuration allows you to set a Flat $ amount or Percentage % fee to be applied to all orders, shown to the shopper and added to the order total for payment processing.
Request Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | GENERAL_FEE |
| enabled | yes | boolean | true |
| value | yes | array (integer, string) | Send in array parameters: "Value" (integer) and "Style" - FLAT or PERCENTAGE |
Note* - This Configuration is only applicable to merchants that accept tips/gratuities in service-bases establishments.
Request Body Example
{
"name": "GENERAL_FEE",
"enabled": true,
"value": {
"value": Integer
"style": "string" // Should be FLAT or PERCENTAGE
}
}
API Response
Response Body Parameters (WIP)
| Parameter Name | Type | Description |
|---|---|---|
| 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 |
| enabled | boolean | The current status of the configuration |
| schemaVersion | integer | The version of the schema |
| isDeleted | boolean | Is this configuration active or not |
| _id | string | The id of this request |
| configId | string | the Id of this configuration |
| 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 |
| _v | integer | 0 |
Response Body Example (WIP)
{
"name": "TIPPING_PERCENTAGES",
"value": [
18,
20,
25
],
"type": null,
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"_id": "string",
"configId": "string",
"createdAt": "2024-04-26T19:54:07.050Z",
"updatedAt": "2024-04-26T19:54:07.050Z",
"__v": 0
}
Create Surcharge Fee Config
The Surcharge Fee Configuration allows you to set a Flat $ amount or Percentage % fee to be applied to orders with a credit card. Skipify performs a BIN check in the background to ensure this fee is not applied to Debit card transactions.
Request Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | SURCHARGE_FEE |
| enabled | yes | boolean | true |
| value | yes | array | See next table for parameters in value obje |
Value array Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| value | yes | integer | The Value of the surcharge as a percentage (if style=percentage), or minor units (if style=flat) |
| style | yes | string | enums: PERCENTAGE, FLAT |
| feeType | yes | string | SURCHARGE_FEE |
| description | yes | string | The description of the fee that will appear to the Shopper during checkout |
Note* - Please check with your Implementation Engineer before setting this Configuration in production
Request Body Example
{
"name": "SURCHARGE_FEE",
"enabled": true,
"value": {
"value": 3, //PERCENTAGE: 3% FLAT: $0.03
"style": "PERCENTAGE", // PERCENTAGE OR FLAT
"feeType": "SURCHARGE_FEE",
"description": "Surcharge"
}
}
API Response
Response Body Parameters
| Parameter Name | Type | Description |
|---|---|---|
| name | string | The Name of the Configuration |
| value | array | The an array of the surcharge values |
| type | string | The Type of configuration if applicable |
| enabled | boolean | The current status of the configuration |
| schemaVersion | integer | The version of the schema |
| isDeleted | boolean | Is this configuration active or not |
| _id | string | The id of this request |
| configId | string | the Id of this configuration |
| 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 |
| _v | integer | 0 |
Response Body Example
{
"name": "SURCHARGE_FEE",
"value": {
"value": 3,
"style": "PERCENTAGE",
"feeType": "SURCHARGE_FEE",
"description": "Surcharge"
},
"type": "order",
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"_id": "string",
"configId": "2a109d6d-d9a1-4cab-acaf-e4cb44f39412",
"createdAt": "2024-04-26T21:13:17.167Z",
"updatedAt": "2024-04-26T21:13:17.167Z",
"__v": 0
}
Updated about 1 month ago
What’s Next