Create Merchant
Overview
The Create Merchant call allows Merchants and Partners to create new accounts on the Skipify Platform. This is the first call to create the account.
This endpoint uses HMAC with SHA-256
Check out our API Authentication section to learn more
Staging: POST https://stage-merchants.skipify.com/v1/merchants
Production: POST https://merchants.skipify.com/v1/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 | and 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 |
| supportEmailVerified | boolean | Reserved for future use |
| legacy | string | The Skipify transaction identifier |
| externalCredentials | object | Reserved for future use |
| partnerMerchantId | string | This message will be populated if there was an error processing the capture |
| externalPlatformId | string, nullable | Reserved for future use |
| topLevelMerchantId | string | The topLevel Merchant associated with this account |
| schemaVersion | Integer | The version if the schema for this merchant |
| isDeleted | boolean | Is this merchant deleted |
| _id | string | Internal ID for this Merchant |
| apiKey | string | apiKey for this merchant |
| schemas | object | deprecated |
| 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 |
| _v | Integer | reserved for future use |
| id | string | Internal ID for this merchant |
Response Body Example
{
"merchantId": "string",
"name": "Merchant Name",
"supportEmailVerified": false,
"legacy": false,
"externalCredentials": {},
"partnerMerchantId": "string",
"externalPlatformId": null,
"topLevelMerchantId": "string",
"schemaVersion": 1,
"isDeleted": false,
"_id": "string",
"apiKey": "string",
"schemas": {},
"createdAt": "2024-04-22T15:54:44.434Z",
"updatedAt": "2024-04-22T15:54:44.434Z",
"__v": 0,
"id": "string"
}
Updated 6 days ago