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 HMAC
Check out our API Authentication to learn more
To GET details of all configurations on a merchant account, send an API call to:
Staging: GET https://stage-merchants.skipify.com/merchants/{MerchantId}?hydrate=true&include=configs
Production: GET https://merchants.skipify.com/merchants/{MerchantId}?hydrate=true&include=configs
API Response
Response Body Parameters
| Parameter Name | Type | Description |
|---|---|---|
| _id | string | The id of this request |
| merchantId | string | The Skipify Merchant Identifier |
| name | string | The Name of the Configuration |
| external_Credentials | array, string | The type and value of external credentials |
| apiKey | string | The Skipify APIKey for this merchant |
| partnerMerchantId | string, nullable | The Parent (partner) MerchantId associated with this merchant |
| schemaVersion | integer | The version of the schema |
| industry | boolean | The industry/market set on this merchant's account |
| topLevelMerchantId | string | The highest level hierarchy ID associated with this merchant |
| schemaVersion | integer | version of the current schema for this merchant |
| isDeleted | boolean | false |
| configs | Object/array | An Object containing of all the configs (in their own arrays) for this merchant |
Response Body Example
{
"_id": "string",
"merchantId": "string",
"name": "string",
"externalCredentials": {
"ecommerce": "string"
},
"apiKey": "string",
"partnerMerchantId": null,
"industry": "Professional_Services",
"externalPlatformId": "string",
"topLevelMerchantId": "string",
"schemaVersion": integer,
"isDeleted": false,
"configs": [
{
"_id": "string",
"merchantId": "string",
"configId": "string",
"name": "PAYMENT_PROCESSOR",
"type": null,
"value": "string",
"enabled": true,
"isDeleted": false
},
{
"_id": "string",
"merchantId": "string",
"name": "DISALLOW_CART_EDITS",
"configId": "string",
"enabled": true,
"isDeleted": false,
"type": "cart",
"value": true
},
{
"_id": "string",
"merchantId": "string",
"name": "NO_SHIPPING_REQUIRED",
"value": false,
"type": null,
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"configId": "string",
"createdAt": "2024-04-24T23:09:35.330Z",
"updatedAt": "2024-04-24T23:36:41.525Z",
"__v": 0
},
{
"_id": "string",
"merchantId": "string",
"name": "AVS_DECLINE",
"value": true,
"type": null,
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"configId": "string",
"createdAt": "2024-04-24T23:24:36.479Z",
"updatedAt": "2024-04-24T23:24:36.479Z",
"__v": 0
},
{
"_id": "string",
"merchantId": "string",
"name": "checkout-test-mode",
"value": true,
"type": null,
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"configId": "string",
"createdAt": "2024-04-24T23:30:56.778Z",
"updatedAt": "2024-04-24T23:30:56.778Z",
"__v": 0
},
{
"_id": "string",
"merchantId": "string",
"name": "TIPPING_PERCENTAGES",
"value": [
18,
20,
25
],
"type": null,
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"configId": "string",
"createdAt": "2024-04-26T19:54:07.050Z",
"updatedAt": "2024-04-26T19:54:07.050Z",
"__v": 0
},
{
"_id": "string",
"merchantId": "string",
"name": "SURCHARGE_FEE",
"value": {
"value": 3,
"style": "PERCENTAGE",
"feeType": "SURCHARGE_FEE",
"description": "Surcharge"
},
"type": "order",
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"configId": "string",
"createdAt": "2024-04-26T21:13:17.167Z",
"updatedAt": "2024-04-26T21:13:17.167Z",
"__v": 0
},
{
"merchantId": "string",
"name": "MERCHANT_BRANDING",
"type": null,
"isDeleted": false,
"configId": "",
"value": {
"logoSrc": "URI"
},
"enabled": true,
"schemaVersion": 0,
"isInherited": false
}
],
"directLineage": []
}
}
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 look up a PayLink, send an API call to:
Staging:GET https://stage-merchants.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": "MERCHANT_BRANDING",
"value": {
"displayName": "string",
"logoSrc": "https://URL.com",
"color": "#000000",
"useLogoForPurchaseDetails": true
},
"type": "checkout",
"configId": "c6f93d52-3756-41ac-a83c-e5c30dc14d72",
"merchantId": "1bdc8b60-5ght-4126-88e1-c9e5b570f1a0",
"createdAt": "2024-04-26T21:13:17.167Z",
"updatedAt": "2024-04-26T21:13:17.167Z",
}
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://stage-merchants.skipify.com/merchants/{merchantId}/configs/{configId}
Production:`PATCH https://merchants.skipify.com/merchants/{merchantId}/configs/{configId}
Request Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | The name of the config you are updating i.e. - 'NO_SHIPPING_REQUIRED' |
| enabled | yes | boolean | If you want the config to be enabled or not via this update |
| value | yes | boolean | The value you want to set the config to |
Request Body Example
{
"merchantId": "string",
"name": "string",
"enabled": true,
"value": true
}
API Response
Response Body Parameters
| Parameter Name | Type | Description |
|---|---|---|
| _id | string | The id of this request |
| 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 |
| 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 |
Response Body Example
{
"_id": "string",
"merchantId": "string",
"name": "NO_SHIPPING_REQUIRED",
"value": true,
"type": null,
"enabled": true,
"schemaVersion": 1,
"isDeleted": false,
"configId": "string",
"createdAt": "2024-04-24T23:09:35.330Z",
"updatedAt": "2024-04-29T22:08:30.241Z",
"__v": 0
}
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://stage-merchants.skipify.com/merchants/{merchantId}/configs/{configId}
Production:`DELETE https://merchants.skipify.com/merchants/{merchantId}/configs/{configId}
API Response
200 OK
Updated about 2 months ago