Skip to main content

Assign a payment terminal to a merchant

PUT 
/partner/partner/:partnerId/terminal/:terminalType/:serialnumber

Takes an already created terminal (part of the pool of unassigned terminals) and assigns it to an already existing merchant. A terminal can only be assigned to one merchant at a time. If it is already assigned to another merchant you will receive an error. It is necessary to publish the terminal configuration to the Handpoint gateway after this operation.

Request​

Path Parameters

    partnerId PartnerIDrequired

    Possible values: non-empty and <= 50 characters

    ID of the partner who owns the terminal.

    terminalType TerminalTyperequired

    Possible values: [MPED400, MPED800, HILITE, HIPLUS, HIPRO, HIFIVE, BP50PLUS, PAXA920, PAXA80, PAXA77, PAXA50, PAX30, PAXA35, PAXA60, PAXA910, PAXA920PRO, PAXA930, PAXARIES6, PAXARIES8, PAXE500, PAXE700, PAXE800, PAXA800, PAXIM30, TELPOTPS900, TELPOTPS988, TELPOTPS989, TELPOTPS328, TELPOTPS300, TELPOTPS, VT]

    Type of terminal to be assigned.

    serialnumber SerialNumberrequired

    Possible values: <= 20 characters

    Serial number of the terminal to be assigned.

Body

required

The assigment data to be used.

    terminalType TerminalTyperequired

    Possible values: [MPED400, MPED800, HILITE, HIPLUS, HIPRO, HIFIVE, BP50PLUS, PAXA920, PAXA80, PAXA77, PAXA50, PAX30, PAXA35, PAXA60, PAXA910, PAXA920PRO, PAXA930, PAXARIES6, PAXARIES8, PAXE500, PAXE700, PAXE800, PAXA800, PAXIM30, TELPOTPS900, TELPOTPS988, TELPOTPS989, TELPOTPS328, TELPOTPS300, TELPOTPS, VT]

    Terminal type supported by the TMS. They may belong to different brands: Pax, Telpo, Datecs or Virtual Terminals.

    terminalTypeLabel string
    serialNumber SerialNumberrequired

    Possible values: <= 20 characters

    The serial number of the terminal.

    terminalStatus string

    Possible values: [U]

    The status of the terminal, for assign operation the previous status should be UNASSIGNED.

    partnerId PartnerIDrequired

    Possible values: non-empty and <= 50 characters

    ID of your partner profile (provided by Handpoint)

    merchantId MerchantIDrequired

    Possible values: non-empty and <= 20 characters

    It is a unique Handpoint ID for the merchant, it must be unique across ALL TMS merchants. Handpoint will provide a range of IDs that can be used for this purpose.

    locationName string

    Location of the payment terminal If empty, the merchant's location address will be used.

    addressLine1 stringrequired

    Address line 1 of the payment terminal If empty, the merchant's address will be used.

    zipCode stringrequired

    Zip code of the payment terminal If empty, the merchant's zip code will be used.

    city stringrequired

    City of the payment terminal If empty, the merchant's city will be used.

    countryCodeAlpha2 stringrequired

    Country code Alpha 2 of the payment terminal If empty, the merchant's country code will be used.

    phone string

    Phone number of the merchant associated with the payment terminal If empty, the merchant's phone number will be used.

    email string

    E-mail associated with the payment terminal If empty, the merchant's email will be used.

    tipFlag boolean

    Default value: false

    Enable the tip functionality for the payment terminals. Only relevant for setting up Datecs terminals, not relevant for PAX or Telpo. This will override the merchant's tip flag value.

    showTipAdjustmentLine boolean

    Default value: false

    Show tip adjustment line in the receipt. Only relevant for setting up Datecs terminals, not relevant for PAX or Telpo. It is only used if tipFlag is true. This will override the merchant's tip flag value.

    softwareVersion string

    Use this software version instead of the default one.

    useDefaultApp boolean

    Default value: false

    Uses the default account selection (checking) on the payment terminal. Only relevant for setting up Datecs terminals in South Africa, not relevant for PAX or Telpo.

    customFieldsByProtocol object[]

    Custom fields to be used for the terminal configuration. Ask Handpoint about which acquirer custom fields need to be used for your partner profile. If empty, the merchant's custom fields will be used.

  • Array [
    • protocol stringrequired

    Protocol applied to the custom fields.

    customFields object[]
  • Array [
    • acquirerTerminalId string

    Acquirer terminal id customized.

  • ]
  • ]

Responses​

OK

Loading...