NAME

Net::API::Stripe::Cash::Transaction - Stripe API

SYNOPSIS

use Net::API::Stripe::Cash::Transaction;
my $this = Net::API::Stripe::Cash::Transaction->new || die( Net::API::Stripe::Cash::Transaction->error, "\n" );

VERSION

v0.1.0

DESCRIPTION

METHODS

id

String

Unique identifier for the object.

Object string, value is "customer_cash_balance_transaction"

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

applied_to_payment

Hash

If this is a type=applied_to_payment transaction, contains information about how funds were applied.

• payment_intent

  String

  Expandable

  The Payment Intent that funds were applied to.

created timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string

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

customer string

Expandable

The customer whose available cash balance changed as a result of this transaction.

ending_balance integer

The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.

funded

Hash

If this is a type=funded transaction, contains information about the funding.

• bank_transfer

  Hash

  Information about the bank transfer that funded the customer’s cash balance.

  • eu_bank_transfer

    Hash

    EU-specific details of the bank transfer.

    • bic

      String

      The BIC of the bank of the sender of the funding.

    • iban_last4

      String

      The last 4 digits of the IBAN of the sender of the funding.

    • sender_name

      String

      The full name of the sender, as supplied by the sending bank.

  • reference

    String

    The user-supplied reference field on the bank transfer.

  • type

    String

    The funding method type used to fund the customer balance. Permitted values include: us_bank_account, eu_bank_account, id_bank_account, gb_bank_account, jp_bank_account, mx_bank_account, eu_bank_transfer, gb_bank_transfer, id_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.

livemode boolean

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

net_amount integer

The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.

refunded_from_payment

Hash

If this is a type=refunded_from_payment transaction, contains information about the source of the refund.

• refund

  String. Expandable

  The Refund that moved these funds into the customer’s cash balance.

type string

The type of the cash balance transaction. One of adjustment, applied_to_invoice, credit_note, initial, invoice_too_large, invoice_too_small, migration, unspent_receiver_credit, or unapplied_from_invoice. New types may be added in future. See Customer Balances to learn more about these types.

unapplied_from_payment

Hash

If this is a type=unapplied_from_payment transaction, contains information about how funds were unapplied.

• payment_intent

  String. Expandable

  The Payment Intent that funds were unapplied from.

API SAMPLE

{
  "id": "ccsbtxn_1LIVZqCeyNCl6fY2APWGE8ro",
  "object": "customer_cash_balance_transaction",
  "created": 1657103726,
  "currency": "jpy",
  "customer": "cus_AODr7KhjWjH7Yk",
  "ending_balance": 10000,
  "funded": {
    "bank_transfer": {
      "reference": null,
      "type": "jp_bank_transfer"
    }
  },
  "livemode": false,
  "net_amount": 5000,
  "type": "funded"
}
=head1 AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/cash_balance_transactions/object

COPYRIGHT & LICENSE

Copyright(c) 2022 DEGUEST Pte. Ltd.

All rights reserved This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm Net::API::Stripe

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