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.

    values
    • application/json
  • Content-Type
    enum
    const:  
    application/json
    required

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

    values
    • application/json
Body·
required
application/json
  • address
    Type: object ·
    required
  • description
    Type: string · Description
    required
  • name
    Type: string · Name
    required
  • type
    Type: string · enum
    required
    values
    • psp
    • partner
    • merchant
  • available_processor_configs
    Type: array string[] | null · Available Processor Configs
  • mcc
    Type: string | null · Mcc
  • parent_id
    Type: string | null · Parent Id
  • surcharge_basis
    Type: string | null · Surcharge Basis

    What the surcharge is calculated on. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level leaves it unset.

  • surcharge_confirmation_required
    Type: boolean | null · Surcharge Confirmation Required

    Whether the cardholder must confirm the surcharge before the sale proceeds. When true, sale/preauth returns a surcharge-pending state that must be confirmed before the transaction completes. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level defaults to no confirmation.

  • surcharge_rate
    Type: number | null · Surcharge Rate

    Surcharge percentage (e.g., 3.5 for 3.5%). Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits the value from the level above; a null at the account (root) level disables automatic surcharge logic (no surcharge is applied). 0 means surcharges are never applied unless explicitly overridden.

  • tax_basis
    Type: string | null · Tax Basis

    What the tax is calculated on. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level leaves it unset.

  • tax_id
    Type: string | null · Tax Id
Responses
  • 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 '{
  "address": {
    "city": "",
    "state": "",
    "street_line1": "",
    "street_line2": "",
    "zip": ""
  },
  "available_processor_configs": [
    ""
  ],
  "description": "",
  "mcc": null,
  "name": "",
  "parent_id": null,
  "surcharge_rate": null,
  "surcharge_basis": null,
  "surcharge_confirmation_required": null,
  "tax_rate": null,
  "tax_basis": null,
  "tax_id": null,
  "type": "psp"
}'

{
  "address": {
    "city": "string",
    "state": "string",
    "street_line1": "string",
    "street_line2": "",
    "zip": "string"
  },
  "available_processor_configs": [],
  "created_at": "2026-07-10T18:41:46.980Z",
  "deleted_at": null,
  "description": "string",
  "has_access_to_apple_config": false,
  "id": "string",
  "mcc": null,
  "name": "string",
  "organization_id": null,
  "parent_account_ids": [],
  "status": "active",
  "surcharge_rate": null,
  "surcharge_basis": null,
  "surcharge_confirmation_required": null,
  "tax_rate": null,
  "tax_basis": null,
  "tax_id": null,
  "type": "psp",
  "updated_at": null
}

Successful Response