Stripe: what is the exact functionality of transfer_group?

Viewed 572

I am familiar with the documentation on Stripe's website about the transfer_group property here: Transfer Options. However, I find this documentation rather limited and I'm still not sure what it does exactly.

One of the things that I'd expect to happen, is that the charge and associated transfer(s) are somehow grouped together on the Stripe Dashboard. But this appears to not be the case.

My question thus is, what does the transfer_group property do exactly and why would one use it?

EDIT: I found some use for it now. It can be used in the following way:

const transfers = await stripe.transfers.list({
    transfer_group: bookingId
})

This returns all the transfers associated with that transfer_group. Their id's can then be used to create transfer_reversals for example.

Note that the reason I'm not considering this finding as an answer, is because there must be more to it to this (I think).

1 Answers
Related