Create Merchant Configs - Payments
Use these endpoints to set Payments & Processing configurations.
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 Settlement Type Config
Request Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | SETTLEMENT_TYPE |
| enabled | yes | boolean | true |
| value | yes | string | Sale or AuthCapture^ |
^Note - Setting Settlement type to 'AuthCapture', requires you to Capture/Finalize/Settle transactions directly with your PSP. Skipify will Authorize transactions only. Please confirm which configuration you should be using with your Skipify Implementation Engineer.
Request Body Example
{
"name": "SETTLEMENT_TYPE",
"enabled": true,
"value": "string" //Sale or AuthCapture
}
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 | string | The Value of the Configuration Sale or AuthCapture |
| 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": true,
"name": "SETTLEMENT_TYPE",
"value": "Sale",
"type": "payment",
"configId": "36363c70-8574-436f-b2dc-5e3686f061e9",
"merchantId": "215b9068-55d1-45c8-ba95-614edf1abd3b",
"createdAt": "2024-06-10T19:38:28.596Z",
"updatedAt": "2024-06-10T19:38:28.596Z"
}
Create Non Accepted Card Brands Config
Request Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | NON_ACCEPTED_CARD_BRANDS |
| enabled | yes | boolean | true |
| value | no | array | Send Card Brands merchant is not accepting in an array |
Note* - This Configuration only needs to be set if a Merchant is not accepting one of the major 4 card brands, i.e. Amex. All Card Brands will be enabled by Default.
Request Body Example
{
"name": "NON_ACCEPTED_CARD_BRANDS",
"enabled": true,
"value":{
"nonAcceptedCardBrands": ["amex"] // Optional Defaults to empty array and can contain amex, visa, mastercard, discover
}
}
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 | Object/array | Name of config and values "nonAcceptedCardBrands" |
| type | string | 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": true,
"name": "NON_ACCEPTED_CARD_BRANDS",
"value": {
"nonAcceptedCardBrands": [
"amex"
]
},
"type": "payment",
"configId": "3446575f-a73c-9547-a227-0af8e9aff5d3",
"merchantId": "234g5068-96d1-45c8-ba95-614edf1abd3b",
"createdAt": "2024-06-10T17:41:07.907Z",
"updatedAt": "2024-06-10T17:41:07.907Z"
}
Create AVS Decline Config
Request Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | AVS_DECLINE |
| enabled | yes | boolean | true |
| value | yes | boolean | Send Card Brands merchant is not accepting in an array |
Request Body Example
{
"name": "AVS_DECLINE",
"enabled": true,
"value": true
}
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 | boolean | The Value of the Configuration |
| 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": true,
"name": "AVS_DECLINE",
"value": true,
"type": "payment",
"configId": "bfc53764-51kg-4790-a375-651c28cd5dc1",
"merchantId": "435b9068-96d1-45c8-ba95-614edf1abd3b",
"createdAt": "2024-06-10T17:55:34.069Z",
"updatedAt": "2024-06-10T17:55:34.069Z"
}
Updated 11 days ago
What’s Next