NAME

Net::API::Stripe::Payment::Source::Receiver - A Stripe Payment Receiver Object

SYNOPSIS

    my $rcv = $stripe->source->receiver({
        address => '1-2-3 Kudan-Minami, Chiyoda-ku, Tokyo 123-4567 Japan',
        amount_charged => 2000,
    });

VERSION

    v0.100.0

DESCRIPTION

Information related to the receiver flow. Present if the source is a receiver (flow is receiver).

This is part of the Net::API::Stripe::Payment::Source object

CONSTRUCTOR

new( %ARG )

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

METHODS

address string

The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.

amount_charged integer

The total amount that was charged by you. The amount charged is expressed in the source’s currency.

amount_received integer

The total amount received by the receiver source. amount_received = amount_returned + amount_charged is true at all time. The amount received is expressed in the source’s currency.

amount_returned integer

The total amount that was returned to the customer. The amount returned is expressed in the source’s currency.

refund_attributes_method string

Type of refund attribute method, one of email, manual, or none.

refund_attributes_status string

Type of refund attribute status, one of missing, requested, or available.

API SAMPLE

    {
      "id": "src_fake123456789",
      "object": "source",
      "ach_credit_transfer": {
        "account_number": "test_52796e3294dc",
        "routing_number": "110000000",
        "fingerprint": "avmabmnabvmnvb",
        "bank_name": "TEST BANK",
        "swift_code": "TSTEZ122"
      },
      "amount": null,
      "client_secret": "src_client_secret_fake123456789",
      "created": 1571314413,
      "currency": "jpy",
      "flow": "receiver",
      "livemode": false,
      "metadata": {},
      "owner": {
        "address": null,
        "email": "jenny.rosen@example.com",
        "name": null,
        "phone": null,
        "verified_address": null,
        "verified_email": null,
        "verified_name": null,
        "verified_phone": null
      },
      "receiver": {
        "address": "121042882-38381234567890123",
        "amount_charged": 0,
        "amount_received": 0,
        "amount_returned": 0,
        "refund_attributes_method": "email",
        "refund_attributes_status": "missing"
      },
      "statement_descriptor": null,
      "status": "pending",
      "type": "ach_credit_transfer",
      "usage": "reusable"
    }

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/sources/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