POST Poynt/Terminal/Assign

Creates a request to assign a poynt terminal. This will create the terminal if it does not exist along with the merchant account information. Warning: Please NOTE that If the terminal is already assigned to a different subscriber, all links to the previous subscriber will be REMOVED.

Request Information

URI Parameters

None.

Body Parameters

AssignPoyntTerminalRequest
NameDescriptionTypeAdditional information
BusinessId

globally unique identifier

None.
StoreId

globally unique identifier

None.
TerminalTypeId

integer

Range: inclusive between 1 and 1
ExternalId

string

Required

Max length: 255
TerminalName

string

Max length: 255
SubscriberId

integer

None.
LocationId

integer

None.
PaymentServiceId

integer

Range: inclusive between 1 and 1
MerchantId

string

Required

Max length: 255
MerchantTerminalId

string

Required

Max length: 255

Request Formats

application/json, text/json

Sample: 
{
  "BusinessId": "913a6a5d-872c-4159-b002-02770e8bc0ee",
  "StoreId": "4cc72ab8-98b7-45cd-b6d9-e1570e8d13ca",
  "TerminalTypeId": 3,
  "ExternalId": "sample string 4",
  "TerminalName": "sample string 5",
  "SubscriberId": 6,
  "LocationId": 7,
  "PaymentServiceId": 8,
  "MerchantId": "sample string 9",
  "MerchantTerminalId": "sample string 10"
}

application/xml, text/xml

Sample: 
<AssignPoyntTerminalRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Subscriber.Requests">
  <ExternalId>sample string 4</ExternalId>
  <LocationId>7</LocationId>
  <MerchantId>sample string 9</MerchantId>
  <MerchantTerminalId>sample string 10</MerchantTerminalId>
  <PaymentServiceId>8</PaymentServiceId>
  <SubscriberId>6</SubscriberId>
  <TerminalName>sample string 5</TerminalName>
  <TerminalTypeId>3</TerminalTypeId>
  <BusinessId>913a6a5d-872c-4159-b002-02770e8bc0ee</BusinessId>
  <StoreId>4cc72ab8-98b7-45cd-b6d9-e1570e8d13ca</StoreId>
</AssignPoyntTerminalRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AssignTerminalResponse

None.

Response Formats

application/json, text/json

Sample: 
{}

application/xml, text/xml

Sample: 
<AssignTerminalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Subscriber.Responses" />