Struct TransferRequest 

pub struct TransferRequest {
    pub amount: PositiveDecimal,
    pub amount_type: TransferRequestAmountType,
    pub asset: Asset,
    pub execute: bool,
    pub metadata: Option<Metadata>,
    pub source: CreateTransferSource,
    pub target: TransferTarget,
    pub travel_rule: Option<TravelRule>,
    pub validate_only: bool,
}

A request to create a transfer.

JSON schema

{
 "description": "A request to create a transfer.",
 "type": "object",
 "required": [
   "amount",
   "asset",
   "execute",
   "source",
   "target"
 ],
 "properties": {
   "amount": {
     "description": "The amount of the transfer, as a decimal string in standard unit denomination of the asset specified by `asset` (e.g., \"100.00\" for 100 USD, \"0.05\" for 0.05 ETH).",
     "examples": [
       "100.00"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/PositiveDecimal"
       }
     ]
   },
   "amountType": {
     "description": "Specifies whether the given amount is to be received by the target or taken from the source.\n\n- `target`: The transfer `target` receives the exact value specified in `amount`. Fees are added to the amount taken from the transfer `source`.\n- `source`: The transfer `target` receives the value specified in `amount`, minus any fees.\n",
     "default": "source",
     "examples": [
       "source"
     ],
     "type": "string",
     "enum": [
       "target",
       "source"
     ]
   },
   "asset": {
     "description": "The symbol of the asset for the amount. This must be one of the assets of the source or target.",
     "examples": [
       "usd"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/Asset"
       }
     ]
   },
   "execute": {
     "description": "Whether to immediately execute the transfer. If false, the transfer will be created in quoted status and must be executed manually via the /execute endpoint.",
     "examples": [
       true
     ],
     "type": "boolean"
   },
   "metadata": {
     "$ref": "#/components/schemas/Metadata"
   },
   "source": {
     "$ref": "#/components/schemas/CreateTransferSource"
   },
   "target": {
     "$ref": "#/components/schemas/TransferTarget"
   },
   "travelRule": {
     "description": "Travel Rule compliance information for this transfer. Required for transfers to external wallets above regulatory thresholds. Fields required differ by region and Coinbase contracting entity.",
     "examples": [
       {
         "beneficiary": {
           "name": "Jane Smith",
           "walletType": "custodial"
         },
         "isIntermediary": false,
         "isSelf": false,
         "originator": {
           "address": {
             "city": "San Francisco",
             "countryCode": "US",
             "line1": "123 Main St",
             "postCode": "94105",
             "state": "CA"
           },
           "name": "John Doe"
         }
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/TravelRule"
       }
     ]
   },
   "validateOnly": {
     "description": "If true, validates the transfer without initiating it.  If the request is valid, a 2xx will be returned. If the request is invalid, a 4xx error will be returned. The response will include an errorType, for e.g. invalid_target if the specified target cannot receive funds.",
     "default": false,
     "examples": [
       false
     ],
     "type": "boolean"
   }
 }
}

Fields

amount: PositiveDecimal

The amount of the transfer, as a decimal string in standard unit denomination of the asset specified by asset (e.g., “100.00” for 100 USD, “0.05” for 0.05 ETH).

amount_type: TransferRequestAmountType

Specifies whether the given amount is to be received by the target or taken from the source.

    - `target`: The transfer `target` receives the exact value specified in `amount`. Fees are added to the amount taken from the transfer `source`.
    - `source`: The transfer `target` receives the value specified in `amount`, minus any fees.

asset: Asset

The symbol of the asset for the amount. This must be one of the assets of the source or target.

execute: bool

Whether to immediately execute the transfer. If false, the transfer will be created in quoted status and must be executed manually via the /execute endpoint.

metadata: Option<Metadata>

source: CreateTransferSource

target: TransferTarget

travel_rule: Option<TravelRule>

Travel Rule compliance information for this transfer. Required for transfers to external wallets above regulatory thresholds. Fields required differ by region and Coinbase contracting entity.

validate_only: bool

If true, validates the transfer without initiating it. If the request is valid, a 2xx will be returned. If the request is invalid, a 4xx error will be returned. The response will include an errorType, for e.g. invalid_target if the specified target cannot receive funds.

Implementations

impl TransferRequest

pub fn builder() -> TransferRequest

Trait Implementations

impl Clone for TransferRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TransferRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransferRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&TransferRequest> for TransferRequest

fn from(value: &TransferRequest) -> Self

Converts to this type from the input type.

impl From<TransferRequest> for TransferRequest

fn from(value: TransferRequest) -> Self

Converts to this type from the input type.

impl Serialize for TransferRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<TransferRequest> for TransferRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: TransferRequest) -> Result<Self, ConversionError>

Performs the conversion.