Create a new merchant

curl -X POST https://api-sandbox.koywe.com/api/v1/organizations/org_abc123/merchants \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "countryId": "ctry_84b8b218-2777-4e7f-863e-7d0601ac289f",
  "profile": {
    "name": "Galactic Republic Trading",
    "address": "123 Main St",
    "taxIdType": "RUT",
    "taxIdNumber": "123456789",
    "slug": "republic",
    "supportEmail": "galactic.republic@support.com"
  }
}'

{
  "merchantId": "mrc_31fd8637-f889-43fa-8b31-50d9296abfdc",
  "slug": "republic",
  "profile": {
    "name": "Galactic Republic Trading",
    "description": "1234 Main St, Coruscant",
    "address": "1234 Main St, Coruscant",
    "email": "galactic.republic@row.com",
    "phone": "1234567890",
    "url": "https://galacticrepublic.com",
    "supportEmail": "galacticrepublic",
    "supportPhone": "1234567890",
    "supportUrl": "https://galacticrepublic.com/support",
    "taxIdType": "RUT",
    "taxIdNumber": "123456789",
    "addressLine2": "Suite 100",
    "city": "Springfield",
    "postalCode": "90210",
    "stateId": "st_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "State": {
      "id": "id",
      "name": "name",
      "code": "code",
      "countryId": "countryId"
    },
    "countyId": "cnt_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "County": {
      "id": "id",
      "name": "name",
      "code": "code",
      "stateId": "stateId"
    },
    "Country": {
      "id": "id",
      "name": "name",
      "twoLetterIso": {
        "key": "value"
      },
      "fullName": "fullName"
    },
    "dateOfBirth": "1990-01-15T00:00:00Z",
    "nationalityCountryId": "ctry_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "nationalityCountry": {
      "key": "value"
    },
    "state": "California"
  },
  "businessType": "Galactic Republic Trading",
  "businessStructure": "Galactic Republic Trading",
  "capabilities": {
    "payments": true,
    "collections": true
  },
  "chargesEnabled": true,
  "countryId": "ctry_84b8b218-2777-4e7f-863e-7d0601ac289f",
  "createdAt": "2024-07-01T22:40:22Z",
  "defaultCurrencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64",
  "kybComplete": true,
  "disabled": true,
  "disabledReason": "N/D",
  "billing": {
    "roundingType": "NET"
  },
  "Country": {
    "id": "id",
    "name": "name",
    "twoLetterIso": {
      "key": "value"
    },
    "fullName": "fullName"
  },
  "branding": {
    "icon": "https://example.com/icon.png",
    "logo": "https://example.com/logo.png",
    "primaryColor": "#FF0000",
    "secondaryColor": "#00FF00"
  }
}

Create a new merchant within an organization. Requires ORGANIZATION_SETTINGS_ADD_MERCHANT permission.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Organization identifier

Request

This endpoint expects an object.

countryIdstringRequired

profileobjectRequired

defaultCurrencyIdstringOptional

settingsobjectOptional

billingobjectOptional

Billing configuration for the merchant

Response

Merchant created successfully

merchantIdstring

slugstring

profileobject

businessTypestring

businessStructurestring

capabilitiesobject

chargesEnabledboolean

countryIdstring

createdAtdatetime

defaultCurrencyIdstring

kybCompleteboolean

disabledboolean

disabledReasonstring

billingobject

Billing configuration for the merchant

Countryobject

brandingobject

Errors

400

Create Request Bad Request Error

401

Create Request Unauthorized Error

403

Create Request Forbidden Error

404

Create Request Not Found Error

422

Create Request Unprocessable Entity Error

500

Create Request Internal Server Error