POST v1/tenants/{id}/payments

Posts a tenant payment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The identifier.

string

Required

Body Parameters

The tenant payment view model.

TenantPaymentViewModel
NameDescriptionTypeAdditional information
FacilityId

globally unique identifier

Required

Pin

string

None.

UnitId

string

Required

UnitName

string

None.

PayType

string

Required

PayAmount

decimal number

Required

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.

CreditCardName

string

None.

CreditCardStreet

string

None.

CreditCardCity

string

None.

CreditCardState

string

None.

CreditCardPostalCode

string

None.

CreditCardCCV

string

None.

CreditCardMagData

string

None.

PhoneNumber

string

None.

Email

string

None.

DriversLicense

string

None.

DriversLicenseState

string

None.

CallerId

string

None.

CiscoSessionId

string

None.

PrepayPeriods

integer

None.

SendEmailConfirmation

boolean

None.

AddConvenienceFee

boolean

None.

ConvenienceFeeName

string

None.

TransactionToken

string

None.

AmountApproved

string

None.

TransportKey

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FacilityId": "9dc0bcda-ab7e-4150-b910-9b96eaa4ab5a",
  "Pin": "sample string 2",
  "UnitId": "sample string 3",
  "UnitName": "sample string 4",
  "PayType": "sample string 5",
  "PayAmount": 6.1,
  "BankRoutingNumber": "sample string 7",
  "BankAccountNumber": "sample string 8",
  "BankName": "sample string 9",
  "BankAccountName": "sample string 10",
  "CheckNumber": "sample string 11",
  "CreditCardType": "sample string 12",
  "CreditCardNumber": "sample string 13",
  "CreditCardExpMo": "sample string 14",
  "CreditCardExpYear": "sample string 15",
  "CreditCardName": "sample string 16",
  "CreditCardStreet": "sample string 17",
  "CreditCardCity": "sample string 18",
  "CreditCardState": "sample string 19",
  "CreditCardPostalCode": "sample string 20",
  "CreditCardCCV": "sample string 21",
  "CreditCardMagData": "sample string 22",
  "PhoneNumber": "sample string 23",
  "Email": "sample string 24",
  "DriversLicense": "sample string 25",
  "DriversLicenseState": "sample string 26",
  "CallerId": "sample string 27",
  "CiscoSessionId": "sample string 28",
  "PrepayPeriods": 29,
  "SendEmailConfirmation": true,
  "AddConvenienceFee": true,
  "ConvenienceFeeName": "sample string 32",
  "TransactionToken": "sample string 33",
  "AmountApproved": "sample string 34",
  "TransportKey": "sample string 35"
}

application/xml, text/xml

Sample:
<TenantPaymentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.ViewModels">
  <AddConvenienceFee>true</AddConvenienceFee>
  <AmountApproved>sample string 34</AmountApproved>
  <BankAccountName>sample string 10</BankAccountName>
  <BankAccountNumber>sample string 8</BankAccountNumber>
  <BankName>sample string 9</BankName>
  <BankRoutingNumber>sample string 7</BankRoutingNumber>
  <CallerId>sample string 27</CallerId>
  <CheckNumber>sample string 11</CheckNumber>
  <CiscoSessionId>sample string 28</CiscoSessionId>
  <ConvenienceFeeName>sample string 32</ConvenienceFeeName>
  <CreditCardCCV>sample string 21</CreditCardCCV>
  <CreditCardCity>sample string 18</CreditCardCity>
  <CreditCardExpMo>sample string 14</CreditCardExpMo>
  <CreditCardExpYear>sample string 15</CreditCardExpYear>
  <CreditCardMagData>sample string 22</CreditCardMagData>
  <CreditCardName>sample string 16</CreditCardName>
  <CreditCardNumber>sample string 13</CreditCardNumber>
  <CreditCardPostalCode>sample string 20</CreditCardPostalCode>
  <CreditCardState>sample string 19</CreditCardState>
  <CreditCardStreet>sample string 17</CreditCardStreet>
  <CreditCardType>sample string 12</CreditCardType>
  <DriversLicense>sample string 25</DriversLicense>
  <DriversLicenseState>sample string 26</DriversLicenseState>
  <Email>sample string 24</Email>
  <FacilityId>9dc0bcda-ab7e-4150-b910-9b96eaa4ab5a</FacilityId>
  <PayAmount>6.1</PayAmount>
  <PayType>sample string 5</PayType>
  <PhoneNumber>sample string 23</PhoneNumber>
  <Pin>sample string 2</Pin>
  <PrepayPeriods>29</PrepayPeriods>
  <SendEmailConfirmation>true</SendEmailConfirmation>
  <TransactionToken>sample string 33</TransactionToken>
  <TransportKey>sample string 35</TransportKey>
  <UnitId>sample string 3</UnitId>
  <UnitName>sample string 4</UnitName>
</TenantPaymentViewModel>

Response Information

Resource Description

TenantPaymentReturnViewModel
NameDescriptionTypeAdditional information
CallNoteReservationId

string

None.

TenantFirstName

string

None.

TenantLastName

string

None.

ReceiptNumber

string

None.

CCAuthorizationCode

string

None.

Errors

Collection of Exception

None.

IsSuccess

boolean

None.

TransactionId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "CallNoteReservationId": "sample string 1",
  "TenantFirstName": "sample string 2",
  "TenantLastName": "sample string 3",
  "ReceiptNumber": "sample string 4",
  "CCAuthorizationCode": "sample string 5",
  "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
    }
  ],
  "IsSuccess": true,
  "TransactionId": "cf044ca1-65cd-48f0-88e9-e0a8c554492c"
}

application/xml, text/xml

Sample:
<TenantPaymentReturnViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.ViewModels">
  <CCAuthorizationCode>sample string 5</CCAuthorizationCode>
  <CallNoteReservationId>sample string 1</CallNoteReservationId>
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <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>true</IsSuccess>
  <ReceiptNumber>sample string 4</ReceiptNumber>
  <TenantFirstName>sample string 2</TenantFirstName>
  <TenantLastName>sample string 3</TenantLastName>
  <TransactionId>cf044ca1-65cd-48f0-88e9-e0a8c554492c</TransactionId>
</TenantPaymentReturnViewModel>