Search documentation of tiger_stripe

# Stripe.Services.TransferReversalService (tiger_stripe v0.1.1)

Copy Markdown View Source

TransferReversal

Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform's balance and subtract from the destination account's balance.

Reversing a transfer that was made for a destination charge is allowed only up to the amount of the charge. It is possible to reverse a transfer_group transfer only if the destination account has enough balance to cover the reversal.

Related guide: Reverse transfers

## Summary

### Functions

create(client, id, params \\ %{}, opts \\ [])

Create a transfer reversal

list(client, id, params \\ %{}, opts \\ [])

List all reversals

retrieve(client, transfer, id, params \\ %{}, opts \\ [])

Retrieve a reversal

update(client, transfer, id, params \\ %{}, opts \\ [])

Update a reversal

## Functions

# create(client, id, params \\ %{}, opts \\ [])

    @spec create(Stripe.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, Stripe.Error.t()}

Create a transfer reversal

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.

# list(client, id, params \\ %{}, opts \\ [])

    @spec list(Stripe.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, Stripe.Error.t()}

List all reversals

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.

# retrieve(client, transfer, id, params \\ %{}, opts \\ [])

    @spec retrieve(Stripe.Client.t(), String.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, Stripe.Error.t()}

Retrieve a reversal

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.

# update(client, transfer, id, params \\ %{}, opts \\ [])

    @spec update(Stripe.Client.t(), String.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, Stripe.Error.t()}

Update a reversal

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.