1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
// ====================================== // This file was automatically generated. // ====================================== use crate::config::{Client, Response}; use crate::ids::{ChargeId, TransferId}; use crate::params::{Expand, Expandable, List, Metadata, Object, RangeQuery, Timestamp}; use crate::resources::{Account, BalanceTransaction, Charge, Currency, TransferReversal}; use serde_derive::{Deserialize, Serialize}; /// The resource representing a Stripe "Transfer". /// /// For more details see [https://stripe.com/docs/api/transfers/object](https://stripe.com/docs/api/transfers/object). #[derive(Clone, Debug, Deserialize, Serialize)] pub struct Transfer { /// Unique identifier for the object. pub id: TransferId, /// Amount in %s to be transferred. pub amount: i64, /// Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). pub amount_reversed: i64, /// Balance transaction that describes the impact of this transfer on your account balance. #[serde(skip_serializing_if = "Option::is_none")] pub balance_transaction: Option<Expandable<BalanceTransaction>>, /// Time that this record of the transfer was first created. pub created: Timestamp, /// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. /// /// Must be a [supported currency](https://stripe.com/docs/currencies). pub currency: Currency, /// An arbitrary string attached to the object. /// /// Often useful for displaying to users. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<String>, /// ID of the Stripe account the transfer was sent to. #[serde(skip_serializing_if = "Option::is_none")] pub destination: Option<Expandable<Account>>, /// If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. #[serde(skip_serializing_if = "Option::is_none")] pub destination_payment: Option<Expandable<Charge>>, /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. pub livemode: bool, /// A set of key-value pairs that you can attach to a transfer object. /// /// It can be useful for storing additional information about the transfer in a structured format. pub metadata: Metadata, /// A list of reversals that have been applied to the transfer. pub reversals: List<TransferReversal>, /// Whether the transfer has been fully reversed. /// /// If the transfer is only partially reversed, this attribute will still be false. pub reversed: bool, /// ID of the charge or payment that was used to fund the transfer. /// /// If null, the transfer was funded from the available balance. #[serde(skip_serializing_if = "Option::is_none")] pub source_transaction: Option<Expandable<Charge>>, /// The source balance this transfer came from. /// /// One of `card` or `bank_account`. #[serde(skip_serializing_if = "Option::is_none")] pub source_type: Option<TransferSourceType>, /// A string that identifies this transaction as part of a group. /// /// See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for details. #[serde(skip_serializing_if = "Option::is_none")] pub transfer_group: Option<String>, } impl Transfer { /// Returns a list of existing transfers sent to connected accounts. /// /// The transfers are returned in sorted order, with the most recently created transfers appearing first. pub fn list(client: &Client, params: ListTransfers<'_>) -> Response<List<Transfer>> { client.get_query("/transfers", ¶ms) } /// To send funds from your Stripe account to a connected account, you create a new transfer object. /// /// Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error. pub fn create(client: &Client, params: CreateTransfer<'_>) -> Response<Transfer> { client.post_form("/transfers", ¶ms) } /// Retrieves the details of an existing transfer. /// /// Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information. pub fn retrieve(client: &Client, id: &TransferId, expand: &[&str]) -> Response<Transfer> { client.get_query(&format!("/transfers/{}", id), &Expand { expand }) } /// Updates the specified transfer by setting the values of the parameters passed. /// /// Any parameters not provided will be left unchanged. This request accepts only metadata as an argument. pub fn update( client: &Client, id: &TransferId, params: UpdateTransfer<'_>, ) -> Response<Transfer> { client.post_form(&format!("/transfers/{}", id), ¶ms) } } impl Object for Transfer { type Id = TransferId; fn id(&self) -> Self::Id { self.id.clone() } fn object(&self) -> &'static str { "transfer" } } /// The parameters for `Transfer::create`. #[derive(Clone, Debug, Serialize)] pub struct CreateTransfer<'a> { /// A positive integer in %s representing how much to transfer. pub amount: i64, /// 3-letter [ISO code for currency](https://stripe.com/docs/payouts). pub currency: Currency, /// An arbitrary string attached to the object. /// /// Often useful for displaying to users. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<&'a str>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// Set of key-value pairs that you can attach to an object. /// /// This can be useful for storing additional information about the object in a structured format. /// Individual keys can be unset by posting an empty value to them. /// All keys can be unset by posting an empty value to `metadata`. #[serde(skip_serializing_if = "Option::is_none")] pub metadata: Option<Metadata>, /// You can use this parameter to transfer funds from a charge before they are added to your available balance. /// /// A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. /// [See the Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for details. #[serde(skip_serializing_if = "Option::is_none")] pub source_transaction: Option<ChargeId>, /// The source balance to use for this transfer. /// /// One of `bank_account` or `card`. /// For most users, this will default to `card`. #[serde(skip_serializing_if = "Option::is_none")] pub source_type: Option<TransferSourceType>, /// A string that identifies this transaction as part of a group. /// /// See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for details. #[serde(skip_serializing_if = "Option::is_none")] pub transfer_group: Option<&'a str>, } impl<'a> CreateTransfer<'a> { pub fn new(amount: i64, currency: Currency) -> Self { CreateTransfer { amount, currency, description: Default::default(), expand: Default::default(), metadata: Default::default(), source_transaction: Default::default(), source_type: Default::default(), transfer_group: Default::default(), } } } /// The parameters for `Transfer::list`. #[derive(Clone, Debug, Serialize, Default)] pub struct ListTransfers<'a> { #[serde(skip_serializing_if = "Option::is_none")] pub created: Option<RangeQuery<Timestamp>>, /// A cursor for use in pagination. /// /// `ending_before` is an object ID that defines your place in the list. /// For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. #[serde(skip_serializing_if = "Option::is_none")] pub ending_before: Option<TransferId>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// A limit on the number of objects to be returned. /// /// Limit can range between 1 and 100, and the default is 10. #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<u64>, /// A cursor for use in pagination. /// /// `starting_after` is an object ID that defines your place in the list. /// For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. #[serde(skip_serializing_if = "Option::is_none")] pub starting_after: Option<TransferId>, /// Only return transfers with the specified transfer group. #[serde(skip_serializing_if = "Option::is_none")] pub transfer_group: Option<&'a str>, } impl<'a> ListTransfers<'a> { pub fn new() -> Self { ListTransfers { created: Default::default(), ending_before: Default::default(), expand: Default::default(), limit: Default::default(), starting_after: Default::default(), transfer_group: Default::default(), } } } /// The parameters for `Transfer::update`. #[derive(Clone, Debug, Serialize, Default)] pub struct UpdateTransfer<'a> { /// An arbitrary string attached to the object. /// /// Often useful for displaying to users. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<&'a str>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// Set of key-value pairs that you can attach to an object. /// /// This can be useful for storing additional information about the object in a structured format. /// Individual keys can be unset by posting an empty value to them. /// All keys can be unset by posting an empty value to `metadata`. #[serde(skip_serializing_if = "Option::is_none")] pub metadata: Option<Metadata>, } impl<'a> UpdateTransfer<'a> { pub fn new() -> Self { UpdateTransfer { description: Default::default(), expand: Default::default(), metadata: Default::default(), } } } /// An enum representing the possible values of an `Transfer`'s `source_type` field. #[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)] #[serde(rename_all = "snake_case")] pub enum TransferSourceType { BankAccount, Card, } impl TransferSourceType { pub fn as_str(self) -> &'static str { match self { TransferSourceType::BankAccount => "bank_account", TransferSourceType::Card => "card", } } } impl AsRef<str> for TransferSourceType { fn as_ref(&self) -> &str { self.as_str() } } impl std::fmt::Display for TransferSourceType { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { self.as_str().fmt(f) } }