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 NameRequiredTypeDescription
nameyesstringNew Merchant's Business Name (DBA)
partnerMerchantIdyesstringThe Partner (Parent) MerchantID to associate the new merchant with
industrynostringThe merchant's industry if different than parent. Inherited from Parent (partner) merchantId. Accepted values:
Bill_Pay
Restaurant
Retail
Transportation
Sporting_Goods

Request Body Example

{
  "name": "Merchant Name",
  "partnerMerchantId": "string",
  "industry": "string"
}

API Response

Response Body Parameters

Parameter NameTypeDescription
merchantIdstringThe Skipify Merchant Identifier
namestringThe Name of the business
supportEmailVerifiedbooleanReserved for future use
legacystringThe Skipify transaction identifier
externalCredentialsobjectReserved for future use
partnerMerchantIdstringThis message will be populated if there was an error processing the capture
externalPlatformIdstring, nullableReserved for future use
topLevelMerchantIdstringThe topLevel Merchant associated with this account
schemaVersionIntegerThe version if the schema for this merchant
isDeletedbooleanIs this merchant deleted
_idstringInternal ID for this Merchant
apiKeystringapiKey for this merchant
schemasobjectdeprecated
createdAtdateTime, stringThe created date/time for this merchant
Ex:
2024-06-02T21:48:02Z
updatedAtdateTime, stringThe updated date/time for this merchant
Ex:
2024-06-02T21:48:02Z
_vIntegerreserved for future use
idstringInternal 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"
}