WePay logo
      Nothing Found

Get a collection of terminals

get/terminals

Look up a collection of terminals, filtered by the optional specified parameters. Note: By default, the response will not include deleted terminals, while it will include deactivated terminals.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements starting from this page. If specified, no other query parameters can be specified.

page_size
integer [ 1 .. 50 ]
Default: 10

Maximum number of items per page of results.

create_time_start
integer <int64> >= 0

The create time epoch timestamp (in seconds) for the start of the search window, inclusive.

create_time_end
integer <int64> >= 0

The create time epoch timestamp (in seconds) for the end of the search window, inclusive.

account_id
string [ 1 .. 255 ] characters

ID of the object or resource.

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.

Enum: Description
verifone_p400

This terminal is a VeriFone P400.

verifone_v400m

This terminal is a VeriFone V400m.

… 2 more
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
status
Array of strings

Filter search window by elements that match the status list.

Items Enum: Description
active

The terminal has been onboarded for a merchant and is able to process authorizations.

deleted

The terminal was deleted and cannot process authorizations.

… 1 more
gateway_id
string [ 1 .. 255 ] characters

Filter search window by elements that match the gateway_id.

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

A successful collection lookup response.

Response Schema: application/json
next
required
string or null
previous
required
string or null
required
Array of objects unique
api_version
required
string
400

INVALID_PARAMS

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/terminals?page=AQQHAAEX8yf1HDkrXqO7R-wy2joNU6ooRNCyDb-sSbbvR-8J6jKeFgpqprcIsuEnBh4fqImpR2eYjKIgSCirw2mhEFR7m5AsSj1OkG9emN",
  • "previous": null,
  • "results": [
    • {
      • "id": "eaf1ef26-ea2d-4be3-b990-ec2c410b54de",
      • "resource": "terminals",
      • "path": "/terminals/eaf1ef26-ea2d-4be3-b990-ec2c410b54de",
      • "owner": {
        • "id": "0ef0dcd6-a2c6-49c4-9051-bbbe5c6c36e2",
        • "path": "/accounts/0ef0dcd6-a2c6-49c4-9051-bbbe5c6c36e2",
        • "resource": "accounts"
        },
      • "api_version": "3.0",
      • "status": "active",
      • "serial_number": "FA00332-1000138",
      • "model": "verifone_p400",
      • "reference_id": "abc12345",
      • "last_call_home": 1549570307,
      • "terminal_application_version": "1.27.311",
      • "terminal_configuration": {
        • "name": "Front Desk",
        • "receipt_header_merchant_name": "Joe's Coffee",
        • "maintenance_window": {
          • "start": 0,
          • "duration": 1
          },
        • "manual_entry_configuration": {
          • "avs_prompt_enabled": true,
          • "cvd_prompt_enabled": true
          },
        • "address": {
          • "city": "Redwood City",
          • "country": "US",
          • "line1": "250 Convention Way",
          • "line2": "Suite 200",
          • "postal_code": "94063",
          • "region": "CA"
          },
        • "timezone": "US/Pacific",
        • "currency": "USD",
        • "supported_card_brands": [
          • "visa",
          • "american_express",
          • "discover",
          • "mastercard",
          • "diners_club",
          • "jcb"
          ],
        • "credit_debit_preference": "prompt",
        • "sim_card_id": "5aad45c2-d128-466a-aae3-d42fef57e2f7",
        • "tip": {
          • "mode": "prompt_on_terminal",
          • "terminal_display": {
            • "amount_guide_type": "percentage_guide",
            • "percentage_guide": {
              • "show_amount": false,
              • "percentage_low": 15,
              • "percentage_medium": 18,
              • "percentage_high": 20
              }
            }
          },
        • "signature_required": true,
        • "contactless_payments": {
          • "enabled": true,
          • "credit_debit_preference": "credit"
          },
        • "quick_chip": {
          • "enabled": true
          },
        • "deferred_authorization": {
          • "enabled": true,
          • "international_enabled": true,
          • "max_transaction_count": 20,
          • "max_total_amount": 250000,
          • "max_transaction_amount": 12500,
          • "supported_card_entry_modes": [
            • "chip",
            • "contactless"
            ]
          }
        },
      • "gateway_id": "AB00004D3Z"
      }
    ],
  • "api_version": "3.0"
}