Create Location

​
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
  • account_id
    Type: string · Account Id
    required
  • name
    Type: string · Name
    required
  • address
    Type: object · nullable
  • country_code
    Type: string | null · Country Code
  • currency
    Type: string | null · Currency
  • email
    Type: string | null · Email
  • metadata
    Type: object | null · Metadata
  • phone
    Type: string | null · Phone
  • processor_config_id
    Type: string | null · Processor Config Id
  • status
    Type: string · Status
  • 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.

Responses
  • application/json
  • application/json
Request Example for post/v1/locations
curl https://api.uat.koard.com/v1/locations \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN' \
  --data '{
  "account_id": "",
  "address": {
    "city": "",
    "state": "",
    "street_line1": "",
    "street_line2": "",
    "zip": ""
  },
  "country_code": "840",
  "currency": "USD",
  "email": null,
  "metadata": null,
  "name": "",
  "phone": null,
  "processor_config_id": null,
  "status": "active",
  "surcharge_rate": null,
  "surcharge_basis": null,
  "surcharge_confirmation_required": null,
  "tax_rate": null,
  "tax_basis": null,
  "terminal_id": null
}'

{
  "account_id": "string",
  "address": {
    "city": "string",
    "state": "string",
    "street_line1": "string",
    "street_line2": "",
    "zip": "string"
  },
  "country_code": null,
  "created_at": null,
  "currency": null,
  "deleted_at": null,
  "email": null,
  "id": "string",
  "metadata": null,
  "name": "string",
  "phone": null,
  "processor_config_id": null,
  "status": "active",
  "surcharge_rate": null,
  "surcharge_basis": null,
  "surcharge_confirmation_required": null,
  "tax_rate": null,
  "tax_basis": null,
  "terminal_id": null,
  "updated_at": null
}

Successful Response