GET v1/facilities/{facilityId}/tenants/{tenantId}/payinfo?TenantPin={TenantPin}&UnitId={UnitId}
Gets the tenant's on file pay information.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| facilityId |
The facility identifier. |
globally unique identifier |
Required |
| tenantId |
The tenant identifier. |
string |
Required |
| TenantPin | string |
None. |
|
| UnitId | string |
None. |
Body Parameters
None.
Response Information
Resource Description
FacilityTenantOnFilePayInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| TenantId | string |
None. |
|
| PayType | string |
None. |
|
| CreditCardType | string |
None. |
|
| CreditCardNameOnCard | string |
None. |
|
| CreditCardNumber | string |
None. |
|
| CreditCardCvv | string |
None. |
|
| CreditCardExpMo | string |
None. |
|
| CreditCardExpYear | string |
None. |
|
| CreditCardStreet | string |
None. |
|
| CreditCardCity | string |
None. |
|
| CreditCardStateOrProv | string |
None. |
|
| CreditCardPostalCode | string |
None. |
|
| BankName | string |
None. |
|
| BankRoutingNumber | string |
None. |
|
| BankAccountNumber | string |
None. |
|
| BankAccountType | string |
None. |
|
| Errors | Collection of Exception |
None. |
|
| IsSuccess | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"TenantId": "sample string 1",
"PayType": "sample string 2",
"CreditCardType": "sample string 3",
"CreditCardNameOnCard": "sample string 4",
"CreditCardNumber": "sample string 5",
"CreditCardCvv": "sample string 6",
"CreditCardExpMo": "sample string 7",
"CreditCardExpYear": "sample string 8",
"CreditCardStreet": "sample string 9",
"CreditCardCity": "sample string 10",
"CreditCardStateOrProv": "sample string 11",
"CreditCardPostalCode": "sample string 12",
"BankName": "sample string 13",
"BankRoutingNumber": "sample string 14",
"BankAccountNumber": "sample string 15",
"BankAccountType": "sample string 16",
"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
}
application/xml, text/xml
Sample:
<FacilityTenantOnFilePayInfo 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">
<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>
<BankAccountNumber>sample string 15</BankAccountNumber>
<BankAccountType>sample string 16</BankAccountType>
<BankName>sample string 13</BankName>
<BankRoutingNumber>sample string 14</BankRoutingNumber>
<CreditCardCity>sample string 10</CreditCardCity>
<CreditCardCvv>sample string 6</CreditCardCvv>
<CreditCardExpMo>sample string 7</CreditCardExpMo>
<CreditCardExpYear>sample string 8</CreditCardExpYear>
<CreditCardNameOnCard>sample string 4</CreditCardNameOnCard>
<CreditCardNumber>sample string 5</CreditCardNumber>
<CreditCardPostalCode>sample string 12</CreditCardPostalCode>
<CreditCardStateOrProv>sample string 11</CreditCardStateOrProv>
<CreditCardStreet>sample string 9</CreditCardStreet>
<CreditCardType>sample string 3</CreditCardType>
<PayType>sample string 2</PayType>
<TenantId>sample string 1</TenantId>
</FacilityTenantOnFilePayInfo>