Create Merchant Application (v1)

⚠️

Deprecated — use Create Merchant v2 instead.

Creates a new merchant services application by collecting the merchant's basic identifying information and associating it with an agent profile. On success, the system returns a merchantProfileId which is used in all subsequent boarding workflow calls. This is the v1 method and has been superseded by the v2 endpoint which supports a more complete data model.

Endpoint

POST /api/v1/merchant/create

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint only if you are maintaining a legacy integration with the v1 boarding API. For all new integrations, use POST /api/v2/merchant/create instead. The typical boarding flow begins with GET /api/v1/agentProfiles and GET /api/v1/GetBoardingSettings to obtain valid agentProfileId and boardingSettingsId values before calling this endpoint.

Request Body

{
  "cashDiscount": "No",
  "firstName": "Maria",
  "lastName": "Santos",
  "dba": "Santos Cafe & Bakery",
  "pos": "Clover",
  "agentProfileId": 4264,
  "email": "[email protected]",
  "boardingSettingsId": 42
}

Response

200 OK

{
  "data": {
    "merchantProfileId": 48291
  },
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 90215
}

Error Codes

Common Mistakes

• Using an agentProfileId that does not belong to your ISO — retrieve valid IDs from GET /api/v1/agentProfiles first.
• Providing an invalid pos enum value — use exact string values (case-sensitive) from the allowed list.
• Not saving the returned merchantProfileId — every subsequent boarding API call requires this value.
• Using this v1 endpoint for new integrations — migrate to POST /api/v2/merchant/create for access to the complete merchant data model.

Related Endpoints

• GET /api/v1/agentProfiles — retrieve valid agentProfileId values before creating a merchant
• GET /api/v1/GetBoardingSettings — retrieve valid boardingSettingsId values
• POST /api/v2/merchant/create — the recommended replacement for this deprecated endpoint

Example

curl -X POST https://hq.staging.netevia.dev/api/v1/merchant/create \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "cashDiscount": "No",
    "firstName": "Maria",
    "lastName": "Santos",
    "dba": "Santos Cafe & Bakery",
    "pos": "Clover",
    "agentProfileId": 4264,
    "email": "[email protected]",
    "boardingSettingsId": 42
  }'