NAME

Net::API::Stripe::Payment::Intent::TransferData - A Stripe TransferData Object

SYNOPSIS

    my $tf_data = $stripe->payment_intent->transfer_data({
        amount => 2000,
        destination => $connect_account_object,
    });

VERSION

    v0.100.0

DESCRIPTION

The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.

This is instantiated by method transfer_data in module Net::API::Stripe::Payment::Intent

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Payment::Intent::TransferData object. It may also take an hash like arguments, that also are method of the same name.

METHODS

amount integer

A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

destination string (expandable)

The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.

When expanded, this is a Net::API::Stripe::Connect::Account object.

API SAMPLE

    {
      "id": "pi_fake123456789",
      "object": "payment_intent",
      "amount": 1099,
      "amount_capturable": 0,
      "amount_received": 0,
      "application": null,
      "application_fee_amount": null,
      "canceled_at": null,
      "cancellation_reason": null,
      "capture_method": "automatic",
      "charges": {
        "object": "list",
        "data": [],
        "has_more": false,
        "url": "/v1/charges?payment_intent=pi_fake123456789"
      },
      "client_secret": "pi_fake123456789_secret_kfhksfhlajfl",
      "confirmation_method": "automatic",
      "created": 1556596976,
      "currency": "jpy",
      "customer": null,
      "description": null,
      "invoice": null,
      "last_payment_error": null,
      "livemode": false,
      "metadata": {},
      "next_action": null,
      "on_behalf_of": null,
      "payment_method": null,
      "payment_method_options": {},
      "payment_method_types": [
        "card"
      ],
      "receipt_email": null,
      "review": null,
      "setup_future_usage": null,
      "shipping": null,
      "statement_descriptor": null,
      "statement_descriptor_suffix": null,
      "status": "requires_payment_method",
      "transfer_data": null,
      "transfer_group": null
    }

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

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

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