POST

Create a merchant

https://api.kustom.co/accountmanagement/v1/merchants/

Creates a new merchant account. Returns the merchant ID, creation timestamp, and initial API credentials.

Request body91 fields

emailstring · emailrequired
Primary contact email for the merchant.
phonestringoptional
Primary contact phone number.
typestringrequired
Merchant type.
- ESTABLISHED
- NEW
countrystringrequired
Two-letter ISO 3166-1 alpha-2 country code.
price_planstringrequired
The pricing plan assigned to this merchant.
platformstringoptional
E-commerce platform used by the merchant.
special_offer_idstringoptional
ID of a special pricing offer, if applicable.
custom_dataobjectoptional
Arbitrary key-value metadata.
1 field in custom_data
- keyanyoptional
  Any additional property. The key is free-form; the value has this shape.
business_informationobjectrequired
Business details for the merchant.
47 fields in business_information
- organization_is_registeredbooleanoptional
  Whether the organization is officially registered.
- organization_entity_typestringoptional
  Legal entity type (e.g. AB, GmbH, Ltd).
- organization_namestringoptional
  Legal name of the organization.
- organization_registration_idstringoptional
  Official registration number.
- organization_registration_authoritystringoptional
  Registration authority (e.g. Companies House, Bolagsverket).
- vat_idstringoptional
  VAT identification number.
- subject_to_vatbooleanoptional
  Whether the organization is subject to VAT.
- registered_addressobjectoptional
  A physical address.
  6 fields in registered_address
  - street_addressstringoptional
    Primary street address.
  - street_address2stringoptional
    Secondary street address (apt, suite, etc.).
  - postal_codestringoptional
    Postal or ZIP code.
  - citystringoptional
    City name.
  - regionstringoptional
    State, province, or region.
  - countrystringoptional
    Two-letter ISO 3166-1 alpha-2 country code.
- operating_addressobjectoptional
  A physical address.
  Same shape as registered_address — 6 fields, identical. Anchors under this path still resolve.
  6 fields in operating_address
  - street_addressstringoptional
    Primary street address.
  - street_address2stringoptional
    Secondary street address (apt, suite, etc.).
  - postal_codestringoptional
    Postal or ZIP code.
  - citystringoptional
    City name.
  - regionstringoptional
    State, province, or region.
  - countrystringoptional
    Two-letter ISO 3166-1 alpha-2 country code.
- ownerobjectoptional
  A business owner or managing director.
  12 fields in owner
  - given_namestringoptional
    First name.
  - family_namestringoptional
    Last name.
  - date_of_birthstring · dateoptional
    Date of birth (YYYY-MM-DD).
  - titlestringoptional
    Job title or role.
  - managing_directorbooleanoptional
    Whether this person is a managing director.
  - personal_idstringoptional
    National personal identification number.
  - street_addressstringoptional
  - street_address2stringoptional
  - postal_codestringoptional
  - citystringoptional
  - regionstringoptional
  - countrystringoptional
    Two-letter ISO 3166-1 alpha-2 country code.
- owners[]array<object>optional
  List of business owners.
  Same shape as owner — 12 fields, identical. Anchors under this path still resolve.
  12 fields in owners
  - given_namestringoptional
    First name.
  - family_namestringoptional
    Last name.
  - date_of_birthstring · dateoptional
    Date of birth (YYYY-MM-DD).
  - titlestringoptional
    Job title or role.
  - managing_directorbooleanoptional
    Whether this person is a managing director.
  - personal_idstringoptional
    National personal identification number.
  - street_addressstringoptional
  - street_address2stringoptional
  - postal_codestringoptional
  - citystringoptional
  - regionstringoptional
  - countrystringoptional
    Two-letter ISO 3166-1 alpha-2 country code.
store_informationobjectrequired
Container for merchant stores.
10 fields in store_information
- stores[]array<object>required
  List of stores (at least one required).
  9 fields in stores
  - countrystringoptional
    Two-letter ISO 3166-1 alpha-2 country code.
  - store_namestringoptional
    Display name of the store.
  - organization_categorystringoptional
    Business category.
  - merchant_category_codestringoptional
    MCC code.
  - homepage_urlstringoptional
    Store website URL.
  - icon_urlstringoptional
    URL to the store icon.
  - logo_urlstringoptional
    URL to the store logo.
  - support_emailstringoptional
    Customer support email.
  - support_phonestringoptional
    Customer support phone number.
bank_accounts[]array<object>required
List of bank accounts for settlements (at least one required).
7 fields in bank_accounts
- account_numberstringoptional
  Bank account number (IBAN or local format).
- account_typestringoptional
  Account type (e.g. CHECKING, SAVINGS).
- account_holderstringoptional
  Name of the account holder.
- countrystringoptional
  Two-letter country code for the bank.
- currency_codestringoptional
  Three-letter ISO 4217 currency code.
- routing_numberstringoptional
  Bank routing or sort code.
- is_defaultbooleanoptional
  Whether this is the default settlement account.
stakeholders[]array<object>required
List of stakeholders (at least one required).
14 fields in stakeholders
- typestringoptional
  Stakeholder type.
- given_namestringoptional
  First name.
- family_namestringoptional
  Last name.
- emailstringoptional
  Email address.
- phonestringoptional
  Phone number.
- addressobjectoptional
  A physical address.
  6 fields in address
  - street_addressstringoptional
    Primary street address.
  - street_address2stringoptional
    Secondary street address (apt, suite, etc.).
  - postal_codestringoptional
    Postal or ZIP code.
  - citystringoptional
    City name.
  - regionstringoptional
    State, province, or region.
  - countrystringoptional
    Two-letter ISO 3166-1 alpha-2 country code.
- company_namestringoptional
  Company name (if applicable).
- registration_idstringoptional
  Registration ID (if applicable).

200

Response5 fields

Merchant successfully created.

merchant_idstringrequired
The unique Kustom merchant identifier.
created_atstring · date-timerequired
Timestamp when the merchant was created.
credentialsobjectrequired
Merchant API credentials.
2 fields in credentials
- usernamestringrequired
  The API username for the merchant.
- passwordstringrequired
  The API password for the merchant.

400

Response0 fields

Invalid request payload.

No response body — this status returns headers only.

401

Response0 fields

Unauthorized — missing or invalid access token.

No response body — this status returns headers only.

POST https://api.kustom.co/accountmanagement/v1/merchants/

Request body· application/json

{
  "email": "<email>",
  "phone": "<string>",
  "type": "ESTABLISHED",
  "country": "<string>",
  "price_plan": "<string>",
  "platform": "<string>",
  "special_offer_id": "<string>",
  "custom_data": {
    "key": "<string>"
  },
  "business_information": {
    "organization_is_registered": false,
    "organization_entity_type": "<string>",
    "organization_name": "<string>",
    "organization_registration_id": "<string>",
    "organization_registration_authority": "<string>",
    "vat_id": "<string>",
    "subject_to_vat": false,
    "registered_address": {
      "street_address": "<string>",
      "street_address2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "region": "<string>",
      "country": "<string>"
    },
    "operating_address": {
      "street_address": "<string>",
      "street_address2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "region": "<string>",
      "country": "<string>"
    },
    "owner": {
      "given_name": "<string>",
      "family_name": "<string>",
      "date_of_birth": "<date>",
      "title": "<string>",
      "managing_director": false,
      "personal_id": "<string>",
      "street_address": "<string>",
      "street_address2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "region": "<string>",
      "country": "<string>"
    },
    "owners": [
      {
        "given_name": "<string>",
        "family_name": "<string>",
        "date_of_birth": "<date>",
        "title": "<string>",
        "managing_director": false,
        "personal_id": "<string>",
        "street_address": "<string>",
        "street_address2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "region": "<string>",
        "country": "<string>"
      }
    ]
  },
  "store_information": {
    "stores": [
      {
        "country": "<string>",
        "store_name": "<string>",
        "organization_category": "<string>",
        "merchant_category_code": "<string>",
        "homepage_url": "<string>",
        "icon_url": "<string>",
        "logo_url": "<string>",
        "support_email": "<string>",
        "support_phone": "<string>"
      }
    ]
  },
  "bank_accounts": [
    {
      "account_number": "<string>",
      "account_type": "<string>",
      "account_holder": "<string>",
      "country": "<string>",
      "currency_code": "<string>",
      "routing_number": "<string>",
      "is_default": false
    }
  ],
  "stakeholders": [
    {
      "type": "<string>",
      "given_name": "<string>",
      "family_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "address": {
        "street_address": "<string>",
        "street_address2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "region": "<string>",
        "country": "<string>"
      },
      "company_name": "<string>",
      "registration_id": "<string>"
    }
  ]
}

112 lines

Response 200· Merchant successfully created.

{
  "merchant_id": "<string>",
  "created_at": "<date-time>",
  "credentials": {
    "username": "<string>",
    "password": "<string>"
  }
}

8 lines

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.