-
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ff43ae1
commit f863e43
Showing
85 changed files
with
681 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
namespace Going.Plaid.Entity; | ||
|
||
/// <summary> | ||
/// <para>Identity information about an account</para> | ||
/// </summary> | ||
public record AccountIdentityDocumentUpload | ||
{ | ||
/// <summary> | ||
/// <para>Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new <c>account_id</c> will be assigned to the account.</para> | ||
/// <para>The <c>account_id</c> can also change if the <c>access_token</c> is deleted and the same credentials that were used to generate that <c>access_token</c> are used to generate a new <c>access_token</c> on a later date. In that case, the new <c>account_id</c> will be different from the old <c>account_id</c>.</para> | ||
/// <para>If an account with a specific <c>account_id</c> disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.</para> | ||
/// <para>Like all Plaid identifiers, the <c>account_id</c> is case sensitive.</para> | ||
/// </summary> | ||
[JsonPropertyName("account_id")] | ||
public string? AccountId { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by <c>/accounts/balance/get</c>.</para> | ||
/// </summary> | ||
[JsonPropertyName("balances")] | ||
public Entity.AccountBalance? Balances { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.</para> | ||
/// </summary> | ||
[JsonPropertyName("mask")] | ||
public string? Mask { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>The name of the account, either assigned by the user or by the financial institution itself</para> | ||
/// </summary> | ||
[JsonPropertyName("name")] | ||
public string? Name { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>The official name of the account as given by the financial institution</para> | ||
/// </summary> | ||
[JsonPropertyName("official_name")] | ||
public string? OfficialName { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>See the <a href="https://plaid.com/docs/api/accounts#account-type-schema">Account type schema</a> for a full listing of account types and corresponding subtypes.</para> | ||
/// </summary> | ||
[JsonPropertyName("type")] | ||
public Entity.AccountType? Type { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>See the [Account type schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.</para> | ||
/// </summary> | ||
[JsonPropertyName("subtype")] | ||
public Entity.AccountSubtype? Subtype { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.</para> | ||
/// </summary> | ||
[JsonPropertyName("verification_status")] | ||
public Entity.AccountIdentityDocumentUploadVerificationStatusEnum? VerificationStatus { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>Insights from performing database verification for the account.</para> | ||
/// </summary> | ||
[JsonPropertyName("verification_insights")] | ||
public Entity.VerificationInsights? VerificationInsights { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field may be populated for any account; in Production and Development, it will only be populated for Chase accounts.</para> | ||
/// </summary> | ||
[JsonPropertyName("persistent_account_id")] | ||
public string? PersistentAccountId { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution; detecting whether the linked account is a business account is not currently supported. Multiple owners on a single account will be represented in the same <c>owner</c> object, not in multiple owner objects within the array. In API versions 2018-05-22 and earlier, the <c>owners</c> object is not returned, and instead identity information is returned in the top level <c>identity</c> object. For more details, see <a href="https://plaid.com/docs/api/versioning/#version-2019-05-29">Plaid API versioning</a></para> | ||
/// </summary> | ||
[JsonPropertyName("owners")] | ||
public IReadOnlyList<Entity.Owner>? Owners { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>An array of document with which the Identity data is derived from.</para> | ||
/// </summary> | ||
[JsonPropertyName("documents")] | ||
public IReadOnlyList<Entity.IdentityDocumentUpload>? Documents { get; init; } = default!; | ||
|
||
} |
74 changes: 74 additions & 0 deletions
74
src/Plaid/Entity/AccountIdentityDocumentUploadVerificationStatusEnum.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
namespace Going.Plaid.Entity; | ||
|
||
/// <summary> | ||
/// <para>The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.</para> | ||
/// </summary> | ||
public enum AccountIdentityDocumentUploadVerificationStatusEnum | ||
{ | ||
/// <summary> | ||
/// <para>The Item has successfully been automatically verified</para> | ||
/// </summary> | ||
[EnumMember(Value = "automatically_verified")] | ||
AutomaticallyVerified, | ||
|
||
/// <summary> | ||
/// <para>The Item is pending automatic verification</para> | ||
/// </summary> | ||
[EnumMember(Value = "pending_automatic_verification")] | ||
PendingAutomaticVerification, | ||
|
||
/// <summary> | ||
/// <para>The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.</para> | ||
/// </summary> | ||
[EnumMember(Value = "pending_manual_verification")] | ||
PendingManualVerification, | ||
|
||
/// <summary> | ||
/// <para>The Item has successfully been manually verified</para> | ||
/// </summary> | ||
[EnumMember(Value = "manually_verified")] | ||
ManuallyVerified, | ||
|
||
/// <summary> | ||
/// <para>Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.</para> | ||
/// </summary> | ||
[EnumMember(Value = "verification_expired")] | ||
VerificationExpired, | ||
|
||
/// <summary> | ||
/// <para>The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.</para> | ||
/// </summary> | ||
[EnumMember(Value = "verification_failed")] | ||
VerificationFailed, | ||
|
||
/// <summary> | ||
/// <para>The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.</para> | ||
/// </summary> | ||
[EnumMember(Value = "database_matched")] | ||
DatabaseMatched, | ||
|
||
/// <summary> | ||
/// <para>The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.</para> | ||
/// </summary> | ||
[EnumMember(Value = "database_insights_pass")] | ||
DatabaseInsightsPass, | ||
|
||
/// <summary> | ||
/// <para>The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.</para> | ||
/// </summary> | ||
[EnumMember(Value = "database_insights_pass_with_caution")] | ||
DatabaseInsightsPassWithCaution, | ||
|
||
/// <summary> | ||
/// <para>The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.</para> | ||
/// </summary> | ||
[EnumMember(Value = "database_insights_fail")] | ||
DatabaseInsightsFail, | ||
|
||
/// <summary> | ||
/// <para>Catch-all for unknown values returned by Plaid. If you encounter this, please check if there is a later version of the Going.Plaid library.</para> | ||
/// </summary> | ||
[EnumMember(Value = "undefined")] | ||
Undefined, | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
namespace Going.Plaid.Entity; | ||
|
||
/// <summary> | ||
/// <para>The ID of the category to which this transaction belongs. For a full list of categories, see <a href="https://plaid.com/docs/api/products/transactions/#categoriesget"><c>/categories/get</c></a>.</para> | ||
/// </summary> | ||
public record BaseReportTransactionCategoryIdObject | ||
{ | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
namespace Going.Plaid.Entity; | ||
|
||
/// <summary> | ||
/// | ||
/// </summary> | ||
public enum BaseReportTransactionType | ||
{ | ||
/// <summary> | ||
/// <para>transactions that took place online.</para> | ||
/// </summary> | ||
[EnumMember(Value = "digital")] | ||
Digital, | ||
|
||
/// <summary> | ||
/// <para>transactions that were made at a physical location.</para> | ||
/// </summary> | ||
[EnumMember(Value = "place")] | ||
Place, | ||
|
||
/// <summary> | ||
/// <para>transactions that relate to banks, e.g. fees or deposits.</para> | ||
/// </summary> | ||
[EnumMember(Value = "special")] | ||
Special, | ||
|
||
/// <summary> | ||
/// <para>transactions that do not fit into the other types.</para> | ||
/// </summary> | ||
[EnumMember(Value = "unresolved")] | ||
Unresolved, | ||
|
||
/// <summary> | ||
/// <para>Catch-all for unknown values returned by Plaid. If you encounter this, please check if there is a later version of the Going.Plaid library.</para> | ||
/// </summary> | ||
[EnumMember(Value = "undefined")] | ||
Undefined, | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
namespace Going.Plaid.Entity; | ||
|
||
/// <summary> | ||
/// <para>Document object with metadata of the uploaded document</para> | ||
/// </summary> | ||
public record IdentityDocumentUpload | ||
{ | ||
/// <summary> | ||
/// | ||
/// </summary> | ||
[JsonPropertyName("document_id")] | ||
public string? DocumentId { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>In closed beta. Object representing metadata pertaining to the document.</para> | ||
/// </summary> | ||
[JsonPropertyName("metadata")] | ||
public Entity.IdentityDocumentUploadMetadata? Metadata { get; init; } = default!; | ||
|
||
/// <summary> | ||
/// <para>In closed beta. Object representing fraud risk data of the document</para> | ||
/// </summary> | ||
[JsonPropertyName("risk_insights")] | ||
public Entity.IdentityDocumentUploadRiskInsights? RiskInsights { get; init; } = default!; | ||
|
||
} |
Oops, something went wrong.