1.0.0 • Published 3 years ago
uis-client v1.0.0
Protocol Documentation
Table of Contents
proto/uis.proto
Asset
| Field | Type | Label | Description |
|---|---|---|---|
| vin_hull | string |
ErrorResponse
| Field | Type | Label | Description |
|---|---|---|---|
| code | string | ||
| message | string | ||
| stack | string |
Loan
| Field | Type | Label | Description |
|---|---|---|---|
| meta | Meta | ||
| payee | Payee | ||
| description | string | ||
| account_number | string | ||
| account_balance | string | ||
| term | float | ||
| total_amount | google.type.Money | ||
| interest_rate_fixed | google.type.Money | ||
| principal_interest_monthly | google.type.Money | ||
| additional_payment_monthly | google.type.Money | ||
| additional_payment_24 | google.type.Money | ||
| origination_date | google.type.Date | ||
| cid | int64 | ||
| ownership_branch | int32 | ||
| sponsor_id | int32 | ||
| arm_override | bool | ||
| payoff_date | google.type.Date | ||
| effective_date | google.type.Date |
LoanDebitTerms
| Field | Type | Label | Description |
|---|---|---|---|
| first_debit_date | google.type.Date | ||
| first_semi_monthly_debit_day_of_month | int32 | ||
| second_semi_monthly_debit_day_of_month | int32 | ||
| monthly_debit_day_of_month | int32 | ||
| second_debit_date | google.type.Date | ||
| debit_type | string |
LoanPaymentTerms
| Field | Type | Label | Description |
|---|---|---|---|
| due_date | google.type.Date | ||
| due_day_of_month | google.type.Date | ||
| grace_period_days | int32 | ||
| hold_days | int32 | ||
| monthly_fee | google.type.Money | ||
| payment_start_date | google.type.Date | ||
| payment_end_date | google.type.Date | ||
| escrow_amount | google.type.Money | ||
| curtailment_amount | google.type.Money | ||
| processor_id | int32 | ||
| return_fees | google.type.Money |
LoanRequest
| Field | Type | Label | Description |
|---|---|---|---|
| loan_ids | string | repeated |
LoanResponse
| Field | Type | Label | Description |
|---|---|---|---|
| loans | Loan | repeated | |
| error | bool |
Meta
| Field | Type | Label | Description |
|---|---|---|---|
| created_at | google.protobuf.Timestamp | ||
| updated_at | google.protobuf.Timestamp |
Payee
| Field | Type | Label | Description |
|---|---|---|---|
| class | string | ||
| information_id | int32 | ||
| ach_fee | google.type.Money |
Person
| Field | Type | Label | Description |
|---|---|---|---|
| meta | Meta | ||
| id | int32 | ||
| string | |||
| cognito_sub | string | ||
| cognito_given_name | string | ||
| cognito_email | string | ||
| cognito_username | string |
Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|---|---|---|---|---|---|---|---|---|
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
1.0.0
3 years ago