@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

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.

@optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param destination [String?] Only return transfers for the destination specified by this account ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return transfers that were created during the given date interval. @optional @param transfer_group [String?] Only return transfers with the specified transfer group. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TransferList]

<p>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.</p> @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param destination [String?] Only return transfers for the destination specified by this account ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return transfers that were created during the given date interval. @optional @param transfer_group [String?] Only return transfers with the specified transfer group. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

@required @param id [String?] @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TransferReversalList]

<p>You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional reversals.</p> @required @param id [String?] @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional reversals.</p> @required @param id [String?] @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TransferReversalList, Integer, Hash)] Stripe::TransferReversalList, response status code and response headers

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.

@required @param transfer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::Transfer]

<p>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.</p> @required @param transfer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

@required @param id [String?] @required @param transfer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TransferReversal]

<p>By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.</p> @required @param id [String?] @required @param transfer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.</p> @required @param id [String?] @required @param transfer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TransferReversal, Integer, Hash)] Stripe::TransferReversal, response status code and response headers

<p>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.</p> @required @param transfer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Transfer, Integer, Hash)] Stripe::Transfer, response status code and response headers

<p>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.</p> @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param destination [String?] Only return transfers for the destination specified by this account ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return transfers that were created during the given date interval. @optional @param transfer_group [String?] Only return transfers with the specified transfer group. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TransferList, Integer, Hash)] Stripe::TransferList, response status code and response headers

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

@required @param currency [String?] Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). @required @param destination [String?] The ID of a connected Stripe account. See the Connect documentation for details. @optional @param amount [Int32?] A positive integer in cents (or local equivalent) representing how much to transfer. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param source_transaction [String?] 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/separate-charges-and-transfers#transfer-availability) for details. @optional @param source_type [String?] The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. @optional @param transfer_group [String?] A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. @return [Stripe::Transfer]

<p>To send funds from your Stripe account to a connected account, you create a new transfer object. Your <a href=&quot;#balance&quot;>Stripe balance</a> must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.</p> @required @param currency [String?] Three-letter ISO code for currency in lowercase. Must be a supported currency. @required @param destination [String?] The ID of a connected Stripe account. <a href=\"/docs/connect/separate-charges-and-transfers\">See the Connect documentation for details. @optional @param amount [Int32?] A positive integer in cents (or local equivalent) representing how much to transfer. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param source_transaction [String?] 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 for details. @optional @param source_type [String?] The source balance to use for this transfer. One of bank_account, card, or fpx. For most users, this will default to card. @optional @param transfer_group [String?] A string that identifies this transaction as part of a group. See the Connect documentation for details. @return nil

When you create a new reversal, you must specify a transfer to create it on.

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

@required @param id [String?] @optional @param amount [Int32?] A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. @optional @param description [String?] An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param refund_application_fee [Bool?] Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. @return [Stripe::TransferReversal]

<p>When you create a new reversal, you must specify a transfer to create it on.</p> <p>When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.</p> <p>Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.</p> @required @param id [String?] @optional @param amount [Int32?] A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. @optional @param description [String?] An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param refund_application_fee [Bool?] Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. @return nil

<p>When you create a new reversal, you must specify a transfer to create it on.</p> <p>When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.</p> <p>Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.</p> @required @param id [String?] @optional @param amount [Int32?] A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. @optional @param description [String?] An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param refund_application_fee [Bool?] Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. @return [Tuple(Stripe::TransferReversal, Integer, Hash)] Stripe::TransferReversal, response status code and response headers

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.

@required @param transfer [String?] @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Stripe::Transfer]

<p>Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> <p>This request accepts only metadata as an argument.</p> @required @param transfer [String?] @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata and description as arguments.

@required @param id [String?] @required @param transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Stripe::TransferReversal]

<p>Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> <p>This request only accepts metadata and description as arguments.</p> @required @param id [String?] @required @param transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil

<p>Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> <p>This request only accepts metadata and description as arguments.</p> @required @param id [String?] @required @param transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::TransferReversal, Integer, Hash)] Stripe::TransferReversal, response status code and response headers

<p>Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> <p>This request accepts only metadata as an argument.</p> @required @param transfer [String?] @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::Transfer, Integer, Hash)] Stripe::Transfer, response status code and response headers

<p>To send funds from your Stripe account to a connected account, you create a new transfer object. Your <a href=&quot;#balance&quot;>Stripe balance</a> must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.</p> @required @param currency [String?] Three-letter ISO code for currency in lowercase. Must be a supported currency. @required @param destination [String?] The ID of a connected Stripe account. <a href=\"/docs/connect/separate-charges-and-transfers\">See the Connect documentation for details. @optional @param amount [Int32?] A positive integer in cents (or local equivalent) representing how much to transfer. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param source_transaction [String?] 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 for details. @optional @param source_type [String?] The source balance to use for this transfer. One of bank_account, card, or fpx. For most users, this will default to card. @optional @param transfer_group [String?] A string that identifies this transaction as part of a group. See the Connect documentation for details. @return [Tuple(Stripe::Transfer, Integer, Hash)] Stripe::Transfer, response status code and response headers