Types Glossary
A complete list of models and enums
Name | Type | Description | Required |
---|---|---|---|
currency | The fiat currency for the limit | Yes | |
limit | string | The maximum allowable sum of ACH transaction amounts | Yes |
used | string | The current sum of ACH transaction amounts by the ACH limit type (e.g. daily) | Yes |
remaining | string | The remaining allowable sum, calculated as the delta between the limit and used values | Yes |
Name | Type | Description | Required |
---|---|---|---|
bankAccount | The bank account of the user | No |
Name | Type | Description | Required |
---|---|---|---|
publicToken | string | The public token from the Plaid integration | Yes |
Name | Type | Description | Required |
---|---|---|---|
id | string | The unique identifier of the allocation | No |
createTime | string | The time the allocation was created | No |
updateTime | string | The time the allocation was last updated | No |
fiat | The fiat component of the activity item | No | |
crypto | The crypto component of the activity item | No | |
metadata | object | (Optional) Additional metadata of the activity item | No |
Name | Type | Description | Required |
---|---|---|---|
status | The status of the crypto activity item | No | |
currency | The crypto currency acquired for the activity item | No | |
wallet | The destination wallet for the crypto currency | No | |
direction | The direction the crypto is moving | No | |
amount | string | The amount of crypto currency acquired | No |
price | string | The price of a single unit of the crypto currency; specified in the fiat currency | No |
fee | string | The fee to execute the crypto purchase and withdrawal; specified in the fiat currency | No |
transactionHash | string | The on-chain transaction hash of the activity item | No |
Name | Type | Description | Required |
---|---|---|---|
status | The status of the fiat activity item | No | |
currency | The fiat currency of the activity item | No | |
amount | string | The amount of fiat currency exchanged | No |
direction | The direction the fiat is moving | No | |
fundingMethod | The method used for fiat, if funded | No | |
bankAccount | The Bank Account used for fiat, if funded | No |
Name | Type | Description | Required |
---|---|---|---|
items | The activity items of the user | Yes | |
nextPageToken | string | The token for the next page of results, if available | No |
Name | Type | Description | Required |
---|---|---|---|
walletAddress | string | The wallet address to authenticate | Yes |
walletType | The type of wallet to authenticate | Yes | |
signature | string | The signature of the challenge | Yes |
Name | Type | Description | Required |
---|---|---|---|
challenge | string | The challenge string to be signed by the requested wallet | Yes |
Name | Type | Description | Required |
---|---|---|---|
walletAddress | string | The wallet address to authenticate | Yes |
walletType | The type of wallet to authenticate | Yes |
Name | Type | Description | Required |
---|---|---|---|
otp | string | The OTP to authenticate | Yes |
emailId | string | The phone identifier to authenticate | Yes |
Name | Type | Description | Required |
---|---|---|---|
otp | string | The OTP to authenticate | Yes |
phoneId | string | The phone identifier to authenticate | Yes |
Name | Type | Description | Required |
---|---|---|---|
id | string | The unique identifier of the bank account | No |
createTime | string | The time the bank account connection was created | No |
updateTime | string | The time the bank account connection was last updated | No |
name | string | The name of the bank account | No |
mask | string | The account number mask | No |
linkStatus | The status of the bank account link to the user | No | |
verificationStatus | The status of the bank account user identity verification | No |
Name | Type | Description | Required |
---|---|---|---|
address | string | The network address of the wallet | Yes |
type | The type of wallet | Yes | |
name | string | A name for the wallet | No |
Name | Type | Description | Required |
---|---|---|---|
firstName | string | The first name of the user | Yes |
middleName | string | The middle name of the user | No |
lastName | string | The last name of the user | Yes |
email | string | The email of the user | Yes |
country | string | The country of the user (Format: ISO 3166 alpha-2) | Yes |
phone | string | The phone number of the user (Format: E-164) | Yes |
acceptedTerms | string | A boolean indicating the user has accepted the terms | Yes |
Name | Type | Description | Required |
---|---|---|---|
url | string | The url for the client's webhook endpoint | Yes |
events | The events to subscribe to | Yes | |
name | string | A name for the webhook | No |
Name | Type | Description | Required |
---|---|---|---|
message | string | Error message | No |
createTime | string | Error creation time | No |
code | string | Error code | No |
data | object | Error data | No |
Name | Type | Description | Required |
---|---|---|---|
fiat | The estimated fiat for the exchange | Yes | |
crypto | The estimated crypto for the exchange | Yes |
Name | Type | Description | Required |
---|---|---|---|
currency | The crypto currency of the estimated exchange | Yes | |
direction | The direction the crypto is moving | Yes | |
amount | string | The amount of crypto currency estimated in the exchange | Yes |
price | string | The price of a single unit of the crypto currency; specified in the fiat currency | Yes |
ratioFee | string | The Ratio fee to execute the crypto transaction; specified in the fiat currency | Yes |
networkFee | string | The network fee to execute the crypto transaction; specified in the fiat currency | Yes |
Name | Type | Description | Required |
---|---|---|---|
currency | The fiat currency of the estimated exchange | Yes | |
direction | The direction the fiat is moving | Yes | |
amount | string | The amount of fiat currency estimated in the exchange | Yes |
fundingMethod | The method used for fiat, if funded | Yes |
Name | Type | Description | Required |
---|---|---|---|
sessionJwt | string | The authenticated Bearer token | Yes |
userMask | The user mask object | No |
Name | Type | Description | Required |
---|---|---|---|
prices | The quoted prices | Yes | |
networkFees | The current network fees | Yes |
Name | Type | Description | Required |
---|---|---|---|
activityItem | The pending activity item | No |
Name | Type | Description | Required |
---|---|---|---|
createTime | string | The time the KYC was created | No |
updateTime | string | The time the KYC was last updated | No |
addressResult | The result of the KYC address verification | No | |
dobResult | The result of the KYC date of birth verification | No | |
fraudResult | The result of the KYC fraud verification | No | |
idvResult | The result of the KYC identity documentation verification | No |
Name | Type | Description | Required |
---|---|---|---|
signingAddress | string | The wallet address that will be used to authenticate | Yes |
signingType | The type of signing wallet to authenticate | Yes | |
depositAddress | string | The wallet address that will be used as the deposit target. If not provided, the signing address will be used | No |
Name | Type | Description | Required |
---|---|---|---|
id | string | The session ID | Yes |
createTime | string | The time the session was created | Yes |
updateTime | string | The time the session was last updated | Yes |
depositAddress | string | The address of the deposit wallet | Yes |
depositType | WalletType | The type of deposit wallet | Yes |
userMask | The user mask object | No | |
signingAddress | string | The address of the signing wallet | Yes |
signingType | string | The type of signing wallet | Yes |
Name | Type | Description | Required |
---|---|---|---|
createTime | string | The time the payroll connection was created | No |
updateTime | string | The time the payroll connection was last updated | No |
provider | The provider for the payroll | No | |
distribution | string | The amount being distributed from this payroll | No |
Name | Type | Description | Required |
---|---|---|---|
linkToken | string | The link token for the Plaid integration | Yes |
Name | Type | Description | Required |
---|---|---|---|
sessionJwt | string | The authenticated Bearer token | Yes |
user | User | The user object | No |
Name | Type | Description |
---|