GET api/ApplicantPayment/GetApplicant
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
ApplicantPaymentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | integer |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| UserName | string |
None. |
|
| EmailId | string |
None. |
|
| EnableFirstNameLastName | boolean |
None. |
|
| ApplicationId | integer |
None. |
|
| TenantUnitId | integer |
None. |
|
| CCProcessingFee | decimal number |
None. |
|
| ECProcessingFee | decimal number |
None. |
|
| IsEsigned | boolean |
None. |
|
| PaymentGatewayProcessingFeeType | integer |
None. |
|
| CheckProcessingFee | decimal number |
None. |
|
| CreditCardProcessingFee | decimal number |
None. |
|
| DBAId | integer |
None. |
|
| DBAName | string |
None. |
|
| DBAEmail | string |
None. |
|
| DBAPhoneNumber | string |
None. |
|
| ManagementCompanyId | integer |
None. |
|
| ManagementCompanyName | string |
None. |
|
| States | Collection of StateModel |
None. |
|
| BankAccountTypes | Collection of BankAccountTypeModel |
None. |
|
| CardValidYears | Collection of integer |
None. |
|
| UserBillingAddress | BillingAddress |
None. |
|
| BalanceAmout | decimal number |
None. |
|
| LedgerBalance | decimal number |
None. |
|
| AmountToPay | decimal number |
None. |
|
| ShowPaymentSection | boolean |
None. |
|
| PGProcessingFeeType | integer |
None. |
|
| ApplicationFees | Collection of ApplicationFeeModel |
None. |
|
| Payments | Collection of ApplicationFeeModel |
None. |
|
| transactionCodeIds | string |
None. |
|
| termIds | string |
None. |
|
| amounts | string |
None. |
|
| PaymentMethods | Collection of PaymentMethodsModel |
None. |
|
| MoneyGramReviceCode | string |
None. |
|
| CompanyName | string |
None. |
|
| AccountNumberToPay | integer |
None. |
|
| Latitude | decimal number |
None. |
|
| Longitude | decimal number |
None. |
|
| AllowECheck | boolean |
None. |
|
| AllowCreditCard | boolean |
None. |
|
| AllowDepositCreditCard | boolean |
None. |
|
| AllowDepositECheck | boolean |
None. |
|
| AllowMoneyGram | boolean |
None. |
|
| AllowDepositMoneyGram | boolean |
None. |
|
| AllowWesternUnion | boolean |
None. |
|
| WUCompanyName | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"userId": 1,
"firstName": "sample string 2",
"lastName": "sample string 3",
"userName": "sample string 4",
"emailId": "sample string 5",
"enableFirstNameLastName": true,
"applicationId": 7,
"tenantUnitId": 8,
"ccProcessingFee": 9.0,
"ecProcessingFee": 10.0,
"isEsigned": true,
"paymentGatewayProcessingFeeType": 12,
"checkProcessingFee": 13.0,
"creditCardProcessingFee": 14.0,
"dbaId": 15,
"dbaName": "sample string 16",
"dbaEmail": "sample string 17",
"dbaPhoneNumber": "sample string 18",
"managementCompanyId": 19,
"managementCompanyName": "sample string 20",
"states": [
{
"stateId": 64,
"state": "sample string 2",
"code": "sample string 3"
},
{
"stateId": 64,
"state": "sample string 2",
"code": "sample string 3"
}
],
"bankAccountTypes": [
{
"accountTypeId": 1,
"accountDescription": "sample string 2"
},
{
"accountTypeId": 1,
"accountDescription": "sample string 2"
}
],
"cardValidYears": [
1,
2
],
"userBillingAddress": {
"addressLine1": "sample string 1",
"addressLine2": "sample string 2",
"city": "sample string 3",
"stateId": 4,
"zip": "sample string 5",
"daytimePhone": "sample string 6"
},
"balanceAmout": 21.0,
"ledgerBalance": 22.0,
"amountToPay": 23.0,
"showPaymentSection": true,
"pgProcessingFeeType": 25,
"applicationFees": [
{
"description": "sample string 1",
"amount": 2.0,
"dateApplied": "2025-12-06T10:09:18.9452364-06:00"
},
{
"description": "sample string 1",
"amount": 2.0,
"dateApplied": "2025-12-06T10:09:18.9452364-06:00"
}
],
"payments": [
{
"description": "sample string 1",
"amount": 2.0,
"dateApplied": "2025-12-06T10:09:18.9452364-06:00"
},
{
"description": "sample string 1",
"amount": 2.0,
"dateApplied": "2025-12-06T10:09:18.9452364-06:00"
}
],
"transactionCodeIds": "sample string 26",
"termIds": "sample string 27",
"amounts": "sample string 28",
"paymentMethods": [
{
"transactionTypeId": 1,
"methodName": "sample string 2"
},
{
"transactionTypeId": 1,
"methodName": "sample string 2"
}
],
"moneyGramReviceCode": "sample string 29",
"companyName": "sample string 30",
"accountNumberToPay": 31,
"latitude": 32.1,
"longitude": 33.1,
"allowECheck": true,
"allowCreditCard": true,
"allowDepositCreditCard": true,
"allowDepositECheck": true,
"allowMoneyGram": true,
"allowDepositMoneyGram": true,
"allowWesternUnion": true,
"wuCompanyName": "sample string 41"
}
application/xml, text/xml
Sample:
<ApplicantPaymentModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<UserId>1</UserId>
<FirstName>sample string 2</FirstName>
<LastName>sample string 3</LastName>
<UserName>sample string 4</UserName>
<EmailId>sample string 5</EmailId>
<EnableFirstNameLastName>true</EnableFirstNameLastName>
<ApplicationId>7</ApplicationId>
<TenantUnitId>8</TenantUnitId>
<CCProcessingFee>9</CCProcessingFee>
<ECProcessingFee>10</ECProcessingFee>
<IsEsigned>true</IsEsigned>
<PaymentGatewayProcessingFeeType>12</PaymentGatewayProcessingFeeType>
<CheckProcessingFee>13</CheckProcessingFee>
<CreditCardProcessingFee>14</CreditCardProcessingFee>
<DBAId>15</DBAId>
<DBAName>sample string 16</DBAName>
<DBAEmail>sample string 17</DBAEmail>
<DBAPhoneNumber>sample string 18</DBAPhoneNumber>
<ManagementCompanyId>19</ManagementCompanyId>
<ManagementCompanyName>sample string 20</ManagementCompanyName>
<States>
<StateModel>
<StateId>64</StateId>
<State>sample string 2</State>
<Code>sample string 3</Code>
</StateModel>
<StateModel>
<StateId>64</StateId>
<State>sample string 2</State>
<Code>sample string 3</Code>
</StateModel>
</States>
<BankAccountTypes>
<BankAccountTypeModel>
<AccountTypeId>1</AccountTypeId>
<AccountDescription>sample string 2</AccountDescription>
</BankAccountTypeModel>
<BankAccountTypeModel>
<AccountTypeId>1</AccountTypeId>
<AccountDescription>sample string 2</AccountDescription>
</BankAccountTypeModel>
</BankAccountTypes>
<CardValidYears>
<int>1</int>
<int>2</int>
</CardValidYears>
<UserBillingAddress>
<AddressLine1>sample string 1</AddressLine1>
<AddressLine2>sample string 2</AddressLine2>
<City>sample string 3</City>
<StateId>4</StateId>
<Zip>sample string 5</Zip>
<DaytimePhone>sample string 6</DaytimePhone>
</UserBillingAddress>
<BalanceAmout>21</BalanceAmout>
<LedgerBalance>22</LedgerBalance>
<AmountToPay>23</AmountToPay>
<ShowPaymentSection>true</ShowPaymentSection>
<PGProcessingFeeType>25</PGProcessingFeeType>
<ApplicationFees>
<ApplicationFeeModel>
<Description>sample string 1</Description>
<Amount>2</Amount>
<DateApplied>2025-12-06T10:09:18.9452364-06:00</DateApplied>
</ApplicationFeeModel>
<ApplicationFeeModel>
<Description>sample string 1</Description>
<Amount>2</Amount>
<DateApplied>2025-12-06T10:09:18.9452364-06:00</DateApplied>
</ApplicationFeeModel>
</ApplicationFees>
<Payments>
<ApplicationFeeModel>
<Description>sample string 1</Description>
<Amount>2</Amount>
<DateApplied>2025-12-06T10:09:18.9452364-06:00</DateApplied>
</ApplicationFeeModel>
<ApplicationFeeModel>
<Description>sample string 1</Description>
<Amount>2</Amount>
<DateApplied>2025-12-06T10:09:18.9452364-06:00</DateApplied>
</ApplicationFeeModel>
</Payments>
<transactionCodeIds>sample string 26</transactionCodeIds>
<termIds>sample string 27</termIds>
<amounts>sample string 28</amounts>
<PaymentMethods>
<PaymentMethodsModel>
<TransactionTypeId>1</TransactionTypeId>
<MethodName>sample string 2</MethodName>
</PaymentMethodsModel>
<PaymentMethodsModel>
<TransactionTypeId>1</TransactionTypeId>
<MethodName>sample string 2</MethodName>
</PaymentMethodsModel>
</PaymentMethods>
<MoneyGramReviceCode>sample string 29</MoneyGramReviceCode>
<CompanyName>sample string 30</CompanyName>
<AccountNumberToPay>31</AccountNumberToPay>
<Latitude>32.1</Latitude>
<Longitude>33.1</Longitude>
<AllowECheck>true</AllowECheck>
<AllowCreditCard>true</AllowCreditCard>
<AllowDepositCreditCard>true</AllowDepositCreditCard>
<AllowDepositECheck>true</AllowDepositECheck>
<AllowMoneyGram>true</AllowMoneyGram>
<AllowDepositMoneyGram>true</AllowDepositMoneyGram>
<AllowWesternUnion>true</AllowWesternUnion>
<WUCompanyName>sample string 41</WUCompanyName>
</ApplicantPaymentModel>