NAME
Net::API::Stripe::Connect::Transfer::Reversal - A Stripe Transfer Reversal Object
SYNOPSIS
my $rev = $stripe->transfer_reversal({
amount => 2000,
currency => 'jpy',
destination_payment_refund => $refund_object,
metadata => { transaction_id => 123 },
transfer => $transfer_object,
});See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.
VERSION
v0.100.0DESCRIPTION
Stripe Connect (https://stripe.com/docs/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 (https://stripe.com/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a transfer_group (https://stripe.com/docs/connect/charges-transfers#grouping-transactions) transfer only if the destination account has enough balance to cover the reversal.
CONSTRUCTOR
new( %ARG )
Creates a new Net::API::Stripe::Connect::Transfer::Reversal object. It may also take an hash like arguments, that also are method of the same name.
METHODS
id string
Unique identifier for the object. object string, value is "transfer_reversal"
String representing the object’s type. Objects of the same type share the same value.
amount integer
Amount, in JPY.
balance_transaction string (expandable)
Balance transaction that describes the impact on your account balance. This is a Net::API::Stripe::Balance::Transaction object.
created timestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
currency currency
Three-letter ISO currency code, in lowercase. Must be a supported currency.
destination_payment_refund string (expandable)
Linked payment refund for the transfer reversal.
When expanded, this is a Net::API::Stripe::Refund object.
metadata hash
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.
source_refund string (expandable)
ID of the refund responsible for the transfer reversal.
When expanded, this is a Net::API::Stripe::Refund object.
transfer string (expandable)
ID of the transfer that was reversed.
When expanded, this is a Net::API::Stripe::Connect::Transfer
API SAMPLE
{
"id": "trr_fake123456789",
"object": "transfer_reversal",
"amount": 1100,
"balance_transaction": null,
"created": 1571313252,
"currency": "jpy",
"destination_payment_refund": null,
"metadata": {},
"source_refund": null,
"transfer": "tr_fake123456789"
}HISTORY
v0.1
Initial version
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
Stripe API documentation:
https://stripe.com/docs/api/transfer_reversals, https://stripe.com/docs/connect/charges-transfers#reversing-transfers
COPYRIGHT & LICENSE
Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.