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
AssignPoyntTerminalRequestName | Description | Type | Additional 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": "4736472e-fba8-4354-a64c-6ef55b2c52ed", "StoreId": "d858d53d-c9cf-4346-afdc-de72f93a5019", "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>4736472e-fba8-4354-a64c-6ef55b2c52ed</BusinessId> <StoreId>d858d53d-c9cf-4346-afdc-de72f93a5019</StoreId> </AssignPoyntTerminalRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AssignTerminalResponseNone.
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" />