WePay logo
      Nothing Found

Onboard a terminal

post/terminals

Onboard a Point-of-Sale terminal into the WePay system. A Terminal resource allows you to control the configuration and lifecycle of a physical terminal. You can only have one non-deleted instance of a terminals resource per physical terminal, which is uniquely identified by the model and serial number. NOTE: the currency parameter for Terminals only supports USD. Note: 3.2 /terminals endpoints are not ready for public use, and will accompany other Card Present enhancements

SecurityappIdAuth and appTokenAuth
Request
header Parameters
Api-Version
required
string
Example: 3.2
Content-Type
required
stringapplication/json
Example: application/json
Request Body schema: application/json
account_id
required
string [ 1 .. 255 ] characters

Merchant account ID to associate the terminal with.

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.

required
object
reference_id
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.

Responses
201

A successful terminals creation 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}.

Enum: Description
pending

The terminal is waiting for the onboarding process to be finished.

active

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

… 1 more
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.

required
object
400

INVALID_PARAMS, ACCOUNT_CANNOT_CREATE_TERMINALS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "account_id": "0ef0dcd6-a2c6-49c4-9051-bbbe5c6c36e2",
  • "serial_number": "FA00332-1000138",
  • "model": "DX8000",
  • "reference_id": "abc12345",
  • "terminal_configuration": {
    • "name": "Front Desk",
    • "manual_entry_configuration": {
      • "avs_prompt_enabled": false,
      • "cvd_prompt_enabled": true
      },
    • "address": {
      • "city": "Redwood City",
      • "country": "US",
      • "line1": "250 Convention Way",
      • "line2": "Suite 200",
      • "postal_code": "94063",
      • "region": "CA"
      },
    • "currency": "USD",
    • "timezone": "US/Pacific",
    • "quick_chip": {
      • "enabled": true
      },
    • "receipt_header_merchant_name": "Joe's Coffee",
    • "tip": {
      • "mode": "prompt_on_terminal",
      • "terminal_display": {
        • "amount_guide_type": "percentage_guide",
        • "percentage_guide": {
          • "percentage_low": 15,
          • "percentage_medium": 18,
          • "percentage_high": 20
          }
        }
      },
    • "signature_required": false,
    • "deferred_authorization": {
      • "enabled": true,
      • "international_enabled": true,
      • "max_transaction_count": 200,
      • "max_total_amount": 25000,
      • "max_transaction_amount": 12500,
      • "supported_card_entry_modes": "all_entry_modes"
      }
    }
}
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": "active",
  • "serial_number": "FA00332-1000138",
  • "model": "DX8000",
  • "reference_id": "abc12345",
  • "terminal_configuration": {
    • "receipt_header_merchant_name": "Joe's Coffee",
    • "name": "Front Desk",
    • "manual_entry_configuration": {
      • "avs_prompt_enabled": false,
      • "cvd_prompt_enabled": true
      },
    • "address": {
      • "city": "Redwood City",
      • "country": "US",
      • "line1": "250 Convention Way",
      • "line2": "Suite 200",
      • "postal_code": "94063",
      • "region": "CA"
      },
    • "currency": "USD",
    • "timezone": "US/Pacific",
    • "quick_chip": {
      • "enabled": true
      },
    • "tip": {
      • "mode": "prompt_on_terminal",
      • "terminal_display": {
        • "amount_guide_type": "percentage_guide",
        • "percentage_guide": {
          • "percentage_low": 15,
          • "percentage_medium": 18,
          • "percentage_high": 20
          }
        }
      },
    • "signature_required": false,
    • "deferred_authorization": {
      • "enabled": true,
      • "international_enabled": true,
      • "max_transaction_count": 200,
      • "max_total_amount": 25000,
      • "max_transaction_amount": 12500,
      • "supported_card_entry_modes": "all_entry_modes"
      }
    }
}