POST v1/facilities/{facilityId}/tenants/processmerchandisesale
Processes the merchandise sale.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
facilityId |
The facility identifier. |
globally unique identifier |
Required |
Body Parameters
The tenant merchandise.
TenantProcessMerchandiseSaleName | Description | Type | Additional information |
---|---|---|---|
FacilityId | globally unique identifier |
None. |
|
TenantId | string |
None. |
|
TenantPin | string |
None. |
|
UnitId | string |
None. |
|
UnitName | string |
None. |
|
ItemIds | Collection of string |
None. |
|
PayType | string |
None. |
|
PayAmount | decimal number |
None. |
|
BankRoutingNumber | string |
None. |
|
BankAccountNumber | string |
None. |
|
BankName | string |
None. |
|
BankAccountName | string |
None. |
|
CheckNumber | string |
None. |
|
CreditCardType | string |
None. |
|
CreditCardNumber | string |
None. |
|
CreditCardExpMo | string |
None. |
|
CreditCardExpYear | string |
None. |
|
CreditCardNameOnCard | string |
None. |
|
CreditCardStreet | string |
None. |
|
CreditCardCity | string |
None. |
|
CreditCardState | string |
None. |
|
CreditCardPostalCode | string |
None. |
|
CreditCardCvv | string |
None. |
|
CreditCardMagData | string |
None. |
|
DriverLicense | string |
None. |
|
DriverLicenseState | string |
None. |
|
PhoneNumber | string |
None. |
|
string |
None. |
||
TransactionToken | string |
None. |
|
AmountApproved | string |
None. |
|
TransportKey | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "FacilityId": "3d5281b4-e5f7-4dc5-9c39-e2a400f2cfce", "TenantId": "sample string 2", "TenantPin": "sample string 3", "UnitId": "sample string 4", "UnitName": "sample string 5", "ItemIds": [ "sample string 1", "sample string 2" ], "PayType": "sample string 6", "PayAmount": 7.1, "BankRoutingNumber": "sample string 8", "BankAccountNumber": "sample string 9", "BankName": "sample string 10", "BankAccountName": "sample string 11", "CheckNumber": "sample string 12", "CreditCardType": "sample string 13", "CreditCardNumber": "sample string 14", "CreditCardExpMo": "sample string 15", "CreditCardExpYear": "sample string 16", "CreditCardNameOnCard": "sample string 17", "CreditCardStreet": "sample string 18", "CreditCardCity": "sample string 19", "CreditCardState": "sample string 20", "CreditCardPostalCode": "sample string 21", "CreditCardCvv": "sample string 22", "CreditCardMagData": "sample string 23", "DriverLicense": "sample string 24", "DriverLicenseState": "sample string 25", "PhoneNumber": "sample string 26", "Email": "sample string 27", "TransactionToken": "sample string 28", "AmountApproved": "sample string 29", "TransportKey": "sample string 30" }
application/xml, text/xml
Sample:
<TenantProcessMerchandiseSale xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.ViewModels"> <AmountApproved>sample string 29</AmountApproved> <BankAccountName>sample string 11</BankAccountName> <BankAccountNumber>sample string 9</BankAccountNumber> <BankName>sample string 10</BankName> <BankRoutingNumber>sample string 8</BankRoutingNumber> <CheckNumber>sample string 12</CheckNumber> <CreditCardCity>sample string 19</CreditCardCity> <CreditCardCvv>sample string 22</CreditCardCvv> <CreditCardExpMo>sample string 15</CreditCardExpMo> <CreditCardExpYear>sample string 16</CreditCardExpYear> <CreditCardMagData>sample string 23</CreditCardMagData> <CreditCardNameOnCard>sample string 17</CreditCardNameOnCard> <CreditCardNumber>sample string 14</CreditCardNumber> <CreditCardPostalCode>sample string 21</CreditCardPostalCode> <CreditCardState>sample string 20</CreditCardState> <CreditCardStreet>sample string 18</CreditCardStreet> <CreditCardType>sample string 13</CreditCardType> <DriverLicense>sample string 24</DriverLicense> <DriverLicenseState>sample string 25</DriverLicenseState> <Email>sample string 27</Email> <FacilityId>3d5281b4-e5f7-4dc5-9c39-e2a400f2cfce</FacilityId> <ItemIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ItemIds> <PayAmount>7.1</PayAmount> <PayType>sample string 6</PayType> <PhoneNumber>sample string 26</PhoneNumber> <TenantId>sample string 2</TenantId> <TenantPin>sample string 3</TenantPin> <TransactionToken>sample string 28</TransactionToken> <TransportKey>sample string 30</TransportKey> <UnitId>sample string 4</UnitId> <UnitName>sample string 5</UnitName> </TenantProcessMerchandiseSale>
Response Information
Resource Description
FacilityProcessMerchandiseSalesName | Description | Type | Additional information |
---|---|---|---|
ReceiptNumber | string |
None. |
|
AuthorizationNumber | string |
None. |
|
IsSuccess | boolean |
None. |
|
Errors | Collection of Exception |
None. |
Response Formats
application/json, text/json
Sample:
{ "ReceiptNumber": "sample string 1", "AuthorizationNumber": "sample string 2", "IsSuccess": true, "Errors": [ { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null }, { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null } ] }
application/xml, text/xml
Sample:
<FacilityProcessMerchandiseSales xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels"> <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.PmsInterface.Models.BindingModels"> <d2p1:Exception> <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName> <Message i:nil="true" xmlns="" /> <Data i:nil="true" xmlns="" /> <InnerException i:nil="true" xmlns="" /> <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL> <StackTraceString i:nil="true" xmlns="" /> <RemoteStackTraceString i:nil="true" xmlns="" /> <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex> <ExceptionMethod i:nil="true" xmlns="" /> <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult> <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source> <WatsonBuckets i:nil="true" xmlns="" /> </d2p1:Exception> <d2p1:Exception> <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName> <Message i:nil="true" xmlns="" /> <Data i:nil="true" xmlns="" /> <InnerException i:nil="true" xmlns="" /> <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL> <StackTraceString i:nil="true" xmlns="" /> <RemoteStackTraceString i:nil="true" xmlns="" /> <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex> <ExceptionMethod i:nil="true" xmlns="" /> <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult> <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source> <WatsonBuckets i:nil="true" xmlns="" /> </d2p1:Exception> </Errors> <IsSuccess xmlns="http://schemas.datacontract.org/2004/07/OpenTech.PmsInterface.Models.BindingModels">true</IsSuccess> <AuthorizationNumber>sample string 2</AuthorizationNumber> <ReceiptNumber>sample string 1</ReceiptNumber> </FacilityProcessMerchandiseSales>