pub struct Transfer {Show 16 fields
pub created_at: String,
pub fees: Vec<Fee>,
pub id: TransferId,
pub source: PaymentMethodRequest,
pub source_amount: String,
pub source_currency: String,
pub source_type: TransferSourceType,
pub status: TransferStatus,
pub target: CryptoRailAddress,
pub target_amount: String,
pub target_currency: String,
pub target_type: TransferTargetType,
pub transaction_hash: Option<String>,
pub updated_at: String,
pub user_amount: String,
pub user_currency: String,
}
Expand description
The transfer object.
JSON schema
{
"description": "The transfer object.",
"examples": [
{
"createdAt": "2021-01-01T00:00:00Z",
"fees": [
{
"amount": "10.25",
"currency": "USD",
"type": "exchange_fee"
},
{
"amount": "0.25",
"currency": "USD",
"type": "network_fee"
}
],
"id": "8e03978e-40d5-43e8-bc93-6894a57f9324",
"source": {
"id": "8e03978e-40d5-43e8-bc93-6894a57f9324"
},
"sourceAmount": "110.50",
"sourceCurrency": "USD",
"sourceType": "payment_method",
"status": "completed",
"target": {
"address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
"currency": "USDC",
"network": "base"
},
"targetAmount": "100",
"targetCurrency": "USD",
"targetType": "crypto_rail",
"transactionHash": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
"updatedAt": "2021-01-01T00:00:00Z",
"userAmount": "100",
"userCurrency": "USD"
}
],
"type": "object",
"required": [
"createdAt",
"fees",
"id",
"source",
"sourceAmount",
"sourceCurrency",
"sourceType",
"status",
"target",
"targetAmount",
"targetCurrency",
"targetType",
"updatedAt",
"userAmount",
"userCurrency"
],
"properties": {
"createdAt": {
"description": "The UTC date and time in ISO 8601 format the transfer was created.",
"examples": [
"2021-01-01T00:00:00Z"
],
"type": "string"
},
"fees": {
"description": "The fees for the transfer.",
"examples": [
[
{
"amount": "10.25",
"currency": "USD",
"type": "exchange_fee"
},
{
"amount": "0.25",
"currency": "USD",
"type": "network_fee"
}
]
],
"type": "array",
"items": {
"$ref": "#/components/schemas/Fee"
}
},
"id": {
"description": "The ID of the transfer.",
"examples": [
"8e03978e-40d5-43e8-bc93-6894a57f9324"
],
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"source": {
"description": "The source of the transfer.",
"examples": [
{
"id": "8e03978e-40d5-43e8-bc93-6894a57f9324"
}
],
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/PaymentMethodRequest"
}
]
},
"sourceAmount": {
"description": "The amount the source will transfer.",
"examples": [
"110.50"
],
"type": "string"
},
"sourceCurrency": {
"description": "The currency the source will transfer.",
"examples": [
"USD"
],
"type": "string"
},
"sourceType": {
"description": "The type of the source of the transfer.",
"examples": [
"payment_method"
],
"type": "string",
"enum": [
"payment_method"
]
},
"status": {
"description": "The status of the transfer.",
"examples": [
"created"
],
"type": "string",
"enum": [
"created",
"pending",
"started",
"completed",
"failed"
]
},
"target": {
"description": "The target of the transfer.",
"examples": [
{
"address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
"currency": "USDC",
"network": "base"
}
],
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/CryptoRailAddress"
}
]
},
"targetAmount": {
"description": "The amount the target will receive.",
"examples": [
"100"
],
"type": "string"
},
"targetCurrency": {
"description": "The currency the target will receive.",
"examples": [
"USD"
],
"type": "string"
},
"targetType": {
"description": "The type of the target of the transfer.",
"examples": [
"crypto_rail"
],
"type": "string",
"enum": [
"crypto_rail"
]
},
"transactionHash": {
"description": "The transaction hash or transaction signature of the transfer.",
"examples": [
"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
],
"type": "string"
},
"updatedAt": {
"description": "The UTC date and time in ISO 8601 format the transfer was updated.",
"examples": [
"2021-01-01T00:00:00Z"
],
"type": "string"
},
"userAmount": {
"description": "The amount the customer put in to transfer.",
"examples": [
"100"
],
"type": "string"
},
"userCurrency": {
"description": "The currency the customer put in to transfer.",
"examples": [
"USD"
],
"type": "string"
}
}
}
Fields§
§created_at: String
The UTC date and time in ISO 8601 format the transfer was created.
fees: Vec<Fee>
The fees for the transfer.
id: TransferId
The ID of the transfer.
source: PaymentMethodRequest
The source of the transfer.
source_amount: String
The amount the source will transfer.
source_currency: String
The currency the source will transfer.
source_type: TransferSourceType
The type of the source of the transfer.
status: TransferStatus
The status of the transfer.
target: CryptoRailAddress
The target of the transfer.
target_amount: String
The amount the target will receive.
target_currency: String
The currency the target will receive.
target_type: TransferTargetType
The type of the target of the transfer.
transaction_hash: Option<String>
The transaction hash or transaction signature of the transfer.
updated_at: String
The UTC date and time in ISO 8601 format the transfer was updated.
user_amount: String
The amount the customer put in to transfer.
user_currency: String
The currency the customer put in to transfer.
Implementations§
Trait Implementations§
Source§impl<'de> Deserialize<'de> for Transfer
impl<'de> Deserialize<'de> for Transfer
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for Transfer
impl RefUnwindSafe for Transfer
impl Send for Transfer
impl Sync for Transfer
impl Unpin for Transfer
impl UnwindSafe for Transfer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more