NAME

Net::API::Stripe::Treasury::CreditReversal - The CreditReversal object

SYNOPSIS

VERSION

v0.1.0

DESCRIPTION

You can reverse some ReceivedCredits depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.

METHODS

id string

Unique identifier for the object.

object string

String representing the object's type. Objects of the same type share the same value.

amount integer

Amount (in cents) transferred.

currency currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

financial_account string

The FinancialAccount to reverse funds from.

hosted_regulatory_receipt_url string

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

livemode boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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.

network string

The rails used to reverse the funds.

received_credit string

The ReceivedCredit being reversed.

status string

Status of the CreditReversal

status_transitions hash

Hash containing timestamps of when the object transitioned to a particular status.

It has the following properties:

posted_at timestamp

Timestamp describing when the CreditReversal changed status to posted

transaction expandable

The Transaction associated with this object.

When expanded this is an Net::API::Stripe::Treasury::Transaction object.

API SAMPLE

[ { "amount" : "1000", "currency" : "usd", "financial_account" : "fa_1Le9F32eZvKYlo2CjbQcDQUE", "hosted_regulatory_receipt_url" : "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKN6u0JgGMgZ5OcNPutk6NpPqyGNMSnPeYuICbWV_67gyzu-WhKrtnutbIUkZW186FSWoCzhS4mHPYChKMkLzDubrcfUuiQ", "id" : "credrev_1Le9F42eZvKYlo2CHPmAdXSp", "livemode" : 0, "metadata" : {}, "network" : "ach", "object" : "treasury.credit_reversal", "received_credit" : "rc_1Le9F42eZvKYlo2CM2wIU5bz", "status" : "processing", "status_transitions" : { "posted_at" : null }, "transaction" : "trxn_1Le9F32eZvKYlo2C2dtkse82" } ]

HISTORY

v0.1.0

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation

COPYRIGHT & LICENSE

Copyright (c) 2019-2022 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.