WePay logo
      Nothing Found

Delete a terminal

delete/terminals/{id}

Deletes the terminal from the system, marking it as deleted. The physical terminal represented by this API record will not be able to process payments until it is onboarded again. Note: As of version 3.2, GET /terminals and POST /terminals endpoints won't return any deleted terminal records.

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string <= 15 characters

A hashed value that uniquely identifies a physical terminal (the terminal ID on both Wepay and EMS ecosystem).

header Parameters
Api-Version
required
string
Example: 3.2
Responses
200

A successful deletion response.

Response Schema: application/json
id
required
string <= 15 characters

A hashed value that uniquely identifies a physical terminal (the terminal ID on both Wepay and EMS ecosystem).

resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
terminals
path
required
string

The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it.

required
object or null

Details the owner resource and owner path.

api_version
required
string
status
required
string

The status of the terminal. Note: Deleted terminals will only be returned via DELETE /terminals/{id}.

Value: Description
deleted

The terminal was deleted, cannot process authorizations and cannot be found via GET /terminals/{id} or GET /terminals/.

serial_number
required
string [ 1 .. 32 ] characters ^[a-zA-Z0-9-]+$

The serial number of the physical terminal.

model
required
string

The model of the physical terminal.

Value: Description
DX8000

This terminal is a DX8000, used in WePay's Card Present 2.0 solution.

reference_id
required
string or null [ 1 .. 255 ] characters

A reference ID that can be used to identify the terminals resource in WePay's system. Searching capabilities are supported on this field.

400

INVALID_PARAMS, TERMINAL_HAS_NOT_BEEN_ONBOARDED

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "id": "13A64A41D4B87HW",
  • "resource": "terminals",
  • "path": "/terminals/13A64A41D4B87HW",
  • "owner": {
    • "id": "0ef0dcd6-a2c6-49c4-9051-bbbe5c6c36e2",
    • "path": "/accounts/0ef0dcd6-a2c6-49c4-9051-bbbe5c6c36e2",
    • "resource": "accounts"
    },
  • "api_version": "3.2",
  • "status": "deleted",
  • "serial_number": "FA00332-1000138",
  • "model": "DX8000",
  • "reference_id": "abc12345"
}