The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Net::API::Stripe::Issuing::Transaction - A Stripe Issuing Transaction Object

SYNOPSIS

    my $trans = $stripe->issuing_transaction({
        amount => 2000,
        authorization => $authorization_object,
        balance_transaction => $balance_transaction,
        card => $card_object,
        currency => 'jpy',
        merchant_amount => 2000,
        merchant_currency => 'jpy',
        metadata => { transaction_id => 123, customer_id > 456 },
    });

See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.

VERSION

    v0.101.0

DESCRIPTION

Any use of an issued card (https://stripe.com/docs/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing Transaction object.

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Issuing::Transaction 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 "issuing.transaction"

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

amount integer

The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit.

amount_details hash

Detailed breakdown of amount components. These amounts are denominated in `currency` and in the smallest currency unit.

It has the following properties:

atm_fee integer

The fee charged by the ATM for the cash withdrawal.

authorization string (expandable)

The Authorization object that led to this transaction.

When expanded, this is a Net::API::Stripe::Issuing::Authorization object.

balance_transaction string (expandable)

When expanded, this is a Net::API::Stripe::Balance::Transaction object.

card string (expandable)

The card used to make this transaction.

When expanded, this is a Net::API::Stripe::Payment::Card object.

cardholder string (expandable)

The cardholder to whom this transaction belongs.

When expanded, this is a Net::API::Stripe::Issuing::Card::Holder 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.

dispute string (expandable)

When expanded, this is a Net::API::Stripe::Issuing::Dispute object.

livemode boolean

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

merchant_amount integer

The amount that the merchant will receive, denominated in "merchant_currency" and in the smallest currency unit. It will be different from "amount" if the merchant is taking payment in a different currency.

merchant_currency currency

The currency with which the merchant is taking payment.

merchant_data hash

More information about the user involved in the transaction.

This is a Net::API::Stripe::Issuing::MerchantData 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.

purchase_details hash

Additional purchase information that is optionally provided by the merchant.

It has the following properties:

flight hash

Information about the flight that was purchased with this transaction.

departure_at integer

The time that the flight departed.

passenger_name string

The name of the passenger.

refundable boolean

Whether the ticket is refundable.

segments array

The legs of the trip.

arrival_airport_code string

The three-letter IATA airport code of the flight's destination.

carrier string

The airline carrier code.

departure_airport_code string

The three-letter IATA airport code that the flight departed from.

flight_number string

The flight number.

service_class string

The flight's service class.

stopover_allowed boolean

Whether a stopover is allowed on this flight.

travel_agency string

The travel agency that issued the ticket.

fuel hash

Information about fuel that was purchased with this transaction.

type string

The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.

unit string

The units for `volume_decimal`. One of `us_gallon` or `liter`.

unit_cost_decimal decimal_string

The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.

volume_decimal decimal_string

The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.

lodging hash

Information about lodging that was purchased with this transaction.

check_in_at integer

The time of checking into the lodging.

nights integer

The number of nights stayed at the lodging.

receipt array

The line items in the purchase.

description string

The description of the item. The maximum length of this field is 26 characters.

quantity decimal

The quantity of the item.

total integer

The total for this line item in cents.

unit_cost integer

The unit cost of the item in cents.

reference string

A merchant-specific order number.

type string

One of capture, refund, cash_withdrawal, refund_reversal, dispute, or dispute_loss.

wallet string

The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay.

API SAMPLE

    {
      "id": "ipi_fake123456789",
      "object": "issuing.transaction",
      "amount": -100,
      "authorization": "iauth_fake123456789",
      "balance_transaction": null,
      "card": "ic_fake123456789",
      "cardholder": null,
      "created": 1571480456,
      "currency": "usd",
      "dispute": null,
      "livemode": false,
      "merchant_amount": -100,
      "merchant_currency": "usd",
      "merchant_data": {
        "category": "taxicabs_limousines",
        "city": "San Francisco",
        "country": "US",
        "name": "Rocket Rides",
        "network_id": "1234567890",
        "postal_code": "94107",
        "state": "CA",
        "url": null
      },
      "metadata": {},
      "type": "capture"
    }

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/issuing/transactions, https://stripe.com/docs/issuing/transactions

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.