WePay logo
      Nothing Found

Get a collection of terminals

get/terminals

Look up a collection of terminals, filtered by the optional specified parameters. Note: 3.2 /terminals endpoints are not ready for public use, and will accompany other Card Present enhancements

SecurityappIdAuth and appTokenAuth
Request
query Parameters
account_id
string [ 1 .. 255 ] characters

Filter search window by elements that match the merchant account ID.

reference_id
string or null [ 1 .. 255 ] characters

Filter search window by elements that match the reference ID.

model
string

Filter search window by elements that match the model.

Value: Description
DX8000

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

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

Filter search window by elements that match the serial_number.

Example: serial_number=FA00332-1000138
header Parameters
Api-Version
required
string
Example: 3.2
Responses
200

A successful collection lookup response.

Response Schema: application/json
required
Array of objects unique
api_version
required
string
400

INVALID_PARAMS

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "results": [
    • {
      • "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": "active",
      • "serial_number": "FA00332-1000138",
      • "model": "DX8000",
      • "reference_id": "abc12345"
      }
    ],
  • "api_version": "3.2"
}