NAME

Net::API::Stripe::Balance::Transaction - The Balance Transaction object

SYNOPSIS

my $bt = $stripe->balance_transactions({
    amount => 2000,
    # or we could also use a unix timestamp
    available_on => '2019-08-15',
    currency => 'jpy',
    description => 'Customer account credit',
    fee_details => Net::API::Stripe::Balance::Transaction::FeeDetails->new({
        amount => 40,
        currency => 'eur',
        description => 'Some transaction',
        type => 'application_fee',
    }),
    net => 1960,
    status => 'available',
    type => 'application_fee',
}) || die( $stripe->error );

VERSION

v0.101.0

DESCRIPTION

Balance transactions represent funds moving through your Stripe account. They're created for every type of transaction that comes into or flows out of your Stripe account balance.

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Balance::Transaction object

METHODS

id string

Unique identifier for the object.

object string, value is "balance_transaction"

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

amount integer

Gross amount of the transaction, in JPY.

available_on timestamp

The date the transaction’s net funds will become available in the Stripe balance.

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 (https://stripe.com/docs/currencies).

description string

An arbitrary string attached to the object. Often useful for displaying to users.

exchange_rate decimal

fee integer

Fees (in JPY) paid for this transaction.

fee_details array of Net::API::Stripe::Balance::Transaction::FeeDetails objects

Detailed breakdown of fees (in JPY) paid for this transaction.

amount integer

Amount of the fee, in cents.

application string

currency currency

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

description string

An arbitrary string attached to the object. Often useful for displaying to users.

type string

Type of the fee, one of: application_fee, stripe_fee or tax.

net integer

Net amount of the transaction, in JPY.

reporting_category string

Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.

source string (expandable)

The Stripe object to which this transaction is related.

For example, a charge object. This is managed with "_set_get_scalar_or_object_variant" in Net::API::Stripe::Generic method. It will check if this is a hash, array or string, and will find out the proper associated class by peeking into the data.

sourced_transfers array

This is a list of object, but according to Stripe and its support, it is deprecated.

The "sourced_transfers parameters used to include any charges or ACH payments to which the balance transfer relates and provide a link back to the 'source' of the balance transaction."

See https://stripe.com/docs/upgrades#2017-01-27

status string

If the transaction’s net funds are available in the Stripe balance yet. Either available or pending.

type string

Transaction type:

adjustment

advance

advance_funding

application_fee

application_fee_refund

charge

connect_collection_transfer

issuing_authorization_hold

issuing_authorization_release

issuing_transaction

payment

payment_failure_refund

payment_refund

payout

payout_cancel

payout_failure

refund

refund_failure

reserve_transaction

reserved_funds

stripe_fee

stripe_fx_fee

tax_fee

topup

topup_reversal

transfer

transfer_cancel

transfer_failure

transfer_refund

API SAMPLE

{
  "id": "txn_fake1234567890",
  "object": "balance_transaction",
  "amount": 8000,
  "available_on": 1571443200,
  "created": 1571128827,
  "currency": "jpy",
  "description": "Invoice 409CD54-0039",
  "exchange_rate": null,
  "fee": 288,
  "fee_details": [
    {
      "amount": 288,
      "application": null,
      "currency": "jpy",
      "description": "Stripe processing fees",
      "type": "stripe_fee"
    }
  ],
  "net": 7712,
  "source": "ch_fake1234567890",
  "status": "pending",
  "type": "charge"
}

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/balance_transactions, https://stripe.com/docs/reports/balance-transaction-types

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.

cpanm Net::API::Stripe

perl -MCPAN -e shell
install Net::API::Stripe