Create Account

​

Create a new account with optional MMS setup (Clerk org, SVIX, API key)

Headers

  • Accept
    enum
    const:  
    application/json
    required

    Response format. Must be application/json.

  • Content-Type
    enum
    const:  
    application/json
    required

    Request payload format. Must be application/json when a body is sent.

Body·

required
application/json
  • name
    Type: string
    required
  • type
    Type: enum
    required
    values
    adminpsppartnermerchant
  • address
    Type: nullable

    Address for a create request. Supplied state, ZIP and country values must be valid. For a US address, use a two-letter state and a five-digit ZIP or ZIP+4. Country defaults to USA when omitted or null. Blank or omitted address details are accepted where the endpoint permits an incomplete address.

    Properties: 6
  • admin_email
    Type: stringnullable
  • admin_first_name
    Type: stringnullable
  • admin_last_name
    Type: stringnullable
  • available_processor_configs
    Type: array of stringnullable
  • description
    Type: string
  • has_access_to_mms
    Type: booleannullable
  • invites
    Type: array of Invitenullable

    Array of invitation objects, each with an "email" field. Email strings alone are not accepted. The optional "role" is "org:admin" or "org:member" (default).

    Properties: 2
  • mcc
    Type: stringnullable
  • parent_id
    Type: stringnullable

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v2/accounts
curl https://api.uat.koard.com/v2/accounts \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN' \
  --data '{
  "type": "admin",
  "parent_id": "",
  "name": "",
  "description": "",
  "address": {
    "street_line1": "",
    "street_line2": "",
    "city": "",
    "country": "",
    "state": "",
    "zip": ""
  },
  "tax_id": "",
  "mcc": "",
  "available_processor_configs": [
    ""
  ],
  "surcharge_rate": 1,
  "surcharge_confirmation_required": true,
  "surcharge_basis": "total",
  "tax_rate": 1,
  "tax_basis": "total",
  "has_access_to_mms": false,
  "admin_email": "",
  "admin_first_name": "",
  "admin_last_name": "",
  "invites": [
    {
      "email": "person@example.com",
      "role": "org:member"
    }
  ]
}'

{
  "address": {
    "street_line1": "",
    "street_line2": "",
    "city": "",
    "country": "USA",
    "state": "",
    "zip": ""
  },
  "available_processor_configs": [],
  "created_at": "2026-10-05T00:11:08.519Z",
  "deleted_at": null,
  "description": "string",
  "id": "string",
  "mcc": null,
  "name": "string",
  "organization_id": null,
  "parent_account_ids": [],
  "status": "active",
  "surcharge_rate": null,
  "surcharge_basis": "total",
  "surcharge_confirmation_required": null,
  "tax_rate": null,
  "tax_basis": "total",
  "tax_id": null,
  "type": "admin",
  "updated_at": null
}

Successful Response