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.

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

ID of the object or resource.

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. Note: Models ingenico_lane3000 and xac_at170r are currently only usable in the stage environment. If you are interested in using these models, please reach out to your integration team or account manager at WePay.

Enum: Description
verifone_p400

This terminal is a VeriFone P400.

verifone_v400m

This terminal is a VeriFone V400m.

… 2 more
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 [ 1 .. 255 ] characters

ID of the object or resource.

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. Active means the terminal is able to accept authorizations. Inactive means the terminal has been deactivated and is unable to accept payments (this can occur for risk and fraud related reasons).

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
serial_number
required
string [ 1 .. 32 ] characters ^[a-zA-Z0-9-]+$

The serial number of the terminal.

model
required
string

The model of the physical terminal. Note: Models ingenico_lane3000 and xac_at170r are currently only usable in the stage environment. If you are interested in using these models, please reach out to your integration team or account manager at WePay.

Enum: Description
verifone_p400

This terminal is a VeriFone P400.

verifone_v400m

This terminal is a VeriFone V400m.

… 2 more
reference_id
required
string or null [ 1 .. 255 ] characters
last_call_home
required
integer or null <int64> >= 0

The epoch timestamp of the last time this terminal called home. Null if the terminal has never done so.

terminal_application_version
required
string or null

The version of the application running on the terminal.

required
object
gateway_id
string [ 1 .. 255 ] characters

Unique identifier of the terminal used by our payment gateway

400

INVALID_PARAMS, ACCOUNT_CANNOT_CREATE_TERMINALS

403

NOT_AUTHORIZED

429

THROTTLE_EXCEEDED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "account_id": "0ef0dcd6-a2c6-49c4-9051-bbbe5c6c36e2",
  • "serial_number": "FA00332-1000138",
  • "model": "verifone_p400",
  • "reference_id": "abc12345",
  • "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"
      ],
    • "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"
        ]
      }
    }
}
Response samples
application/json
{
  • "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"
}