Overview

The Create Merchant call allows Merchants and Partners to create new child accounts on the Skipify Platform. You can use this method to create a new account, add configurations and assign PSP Credentials.

Your Skipify Implementation Engineer will create your parent account and provide the MerchantID and APIKey for it.

Please work with your Skipify Implementation Engineer to confirm which configurations and PSP Credentials are needed for your account.

👍
This endpoint uses HMAC with SHA-256
Check out our API Authentication section to learn more

Staging: POST https://stage-merchants.skipify.com/merchants

Production: POST https://merchants.skipify.com/merchants

Request Body Parameters

Parameter Name	Required	Type	Description
name	yes	string	New Merchant's Business Name (DBA)
partnerMerchantId	yes	string	The Partner (Parent) MerchantID to associate the new merchant with
industry	no	string	The merchant's industry if different than parent. Inherited from Parent (partner) merchantId. Accepted values: Bill_Pay Restaurant Retail Transportation Sporting_Goods
configs	no	object	An object containing one or many Skipify name value pairs for configurations
credentials	no	object	An object containing the name value pairs for Skipify Credentials

Configs Object Parameters

Parameter Name	Required	Type	Description/Value
name	yes	string	the name of the Configuration
enabled	yes	boolean	set to true when creating to enable it
value	yes	string	the value you want set with the configuration

Credentials Object Parameters

Parameter Name	Required	Type	Description
credentialType	yes	string	The type of credential being assigned, for this use case the value is 'payment'
systemOfOrigin	yes	string	The PSP system of Origin the credentials belong to. i.e. - Express
data	yes	object	an object containing the name values pairs for PSP Credentials *The parameters within the data object will vary by PSP. Please review the data object table below and confirm your PSP with your Implementation Specialist

Data Object Parameters within Credentials object*

systemOfOrigin/PSP	Parameters	Type	Example
Express	"acceptor_id" "acount_id" "account_token" "terminal_id"	string	..."credentialType": "payment", "systemOfOrigin": "Express", "data": { "acceptor_id": "123468934", "account_id": "98764", "account_token": "AN#54gf", "terminal_id": "001" } }
RAFT	"merchant_id" "bank_id" "bank_terminal_id"	string	..."credentialType": "payment", "systemOfOrigin": "RAFT", "data": { "merchant_id": "0001234", "bank_id": "9876", "bank_terminal_id": "6543" } }
Payrix	"api_key" "merchant_id"	string	..."credentialType": "payment", "systemOfOrigin": "Payrix", "data": { "api_key": "po_ereft", "merchant_id": "56731323" } }
VAP	"merchant_id" "username" "password"	string	... "credentialType": "payment", "systemOfOrigin": "VAP", "data": { "merchant_id": "1234", "username": "test", "password": "password" } }
Stripe	"connect_id"	string	... "credentialType": "payment", "systemOfOrigin": "Stripe", "data": { "connect_id": "acct_1235343" } }
Adyen	"api_key" "merchant_account"	string	..."credentialType": "payment", "systemOfOrigin": "Adyen", "data": { "api_key": "mockAPIkey", "merchant_account": "merchant" } }
Braintree	"private_key" "public_key" "merchant_account_id"	string	..."credentialType": "payment", "systemOfOrigin": "Braintree", "data": { "private_key": "private_key", "public_key:": "public_key", "merchant_account_id": "merchantId" } }
Fiserv	"api_key" "secret" "merchant_id" "terminal_id"	string	..."credentialType": "payment", "systemOfOrigin": "Fiserv", "data": { "private_key": "private_key", "public_key:": "public_key", "merchant_account_id": "merchantId" } }

Request Body Example

{
  "name": "Pizza Express ",
  "partnerMerchantId": "string",
  "industry": "Restaurant",
  "configs": [
    {
      "name": "SETTLEMENT_TYPE",
      "value": "Sale",
      "enabled": true
    }
  ],
  "credentials": [
    {
      "credentialType": "payment",
      "systemOfOrigin": "string",
      "data": { 
        "apiKey": "string", 
        "merchantId": "string"
      }
    }
  ]
}

API Response

Response Body Parameters

Parameter Name	Type	Description
merchantId	string	The Skipify Merchant Identifier
name	string	The Name of the business
domain	string	URL for the merchant's business website
supportEmail	string	The email for the merchant's business
supportEmailVerified	boolean	Reserved for future use
industry	string	Industry of the merchant
legacy	string	The Skipify transaction identifier
externalCredentials	object	Reserved for future use
partnerMerchantId	string	The direct parent of the merchant
externalPlatformId	string, nullable	If applicable, The merchants identifier on their selected Ecom platform
topLevelMerchantId	string	The topLevel Merchant associated with this account
apiKey	string	apiKey for this merchant
schemas	object	deprecated
urls	array(urls)	URLs where Skipify is allowed to be rendered
configs	array(configs)	Configurations that are applied during checkout
callbacks	array(callbacks)	Callbacks used during checkout to communicate with the Merchant's server
whitelists	array(whitelists)	Whitelisted emails that the merchant can use to test Ecom platform integrations in the test environment
credentials	array(credentials)	Ecom platform and Payment platform credentials used during checkout
directLineage	array(string)	An array containing any parent merchants
createdAt	dateTime, string	The created date/time for this merchant Ex: `2024-06-02T21:48:02Z`
updatedAt	dateTime, string	The updated date/time for this merchant Ex: `2024-06-02T21:48:02Z`

Response Body Example

{
    "merchantId": "c0ba8231-b40c-4ca0-9198-6d0bed2b7b1c",
    "name": "Skipify Merchant",
    "domain": "skipify.com",
    "supportEmail": "[email protected]",
    "supportEmailVerified": false,
    "legacy": false,
    "externalCredentials": {
        "ecommerce": "23e4197c-a0e8-42bb-88ab-2061d86be06f"
    },
    "partnerMerchantId": "afff952b-b336-4e4e-a232-e0402f4165a7",
    "industry": "Food & Beverage",
    "externalPlatformId": null,
    "topLevelMerchantId": "afff952b-b336-4e4e-a232-e0402f4165a7",
    "apiKey": "547abd9aa8904e01b76d2hfue39d935d",
    "schemas": {},
    "createdAt": "2024-11-04T17:18:10.137Z",
    "updatedAt": "2024-11-04T17:18:10.137Z",
    "urls": [
        {
            "createdAt": "2022-01-19T18:14:13.000Z",
            "updatedAt": "2023-09-22T17:04:36.395Z",
            "urlId": "67f77264-cceb-4219-8cc6-f2b731950252",
            "merchantId": "afff952b-b336-4e4e-a232-e0402f4165a7",
            "url": "*",
            "backendUrl": "*",
            "isInherited": true
        }
    ],
    "configs": [
        {
            "merchantId": "c0ba8231-b40c-4ca0-9198-6d0bed2b7b1c",
            "name": "SETTLEMENT_TYPE",
            "value": "Sale",
            "type": "payment",
            "enabled": true,
            "configId": "66d80ba9-35ea-4ac4-856a-3a3553ae1463",
            "createdAt": "2024-11-04T17:18:10.337Z",
            "updatedAt": "2024-11-04T17:18:10.337Z"
        }
    ],
    "callbacks": [],
    "whitelists": [],
    "credentials": [
        {
            "merchantId": "c0ba8231-b40c-4ca0-9198-6d0bed2b7b1c",
            "credentialType": "ecommerce",
            "systemOfOrigin": "custom",
            "data": {
                "configuration": {},
                "apiVersion": "v1"
            },
            "credentialId": "23e4197c-a0e8-42bb-88ab-2061d86be06f",
            "createdAt": "2024-11-04T17:18:10.025Z",
            "updatedAt": "2024-11-04T17:18:10.025Z"
        }
    ],
    "directLineage": [
        "afff952b-b336-4e4e-a232-e0402f4165a7"
    ]
}

Overview

👍This endpoint uses HMAC with SHA-256

Request Body Parameters

Configs Object Parameters

Credentials Object Parameters

Data Object Parameters within Credentials object*

Request Body Example

API Response

Response Body Parameters

Response Body Example

👍
This endpoint uses HMAC with SHA-256