Net::API::Stripe::Connect::TopUp - An Stripe Top-up Object
0.1
To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.
Creates a new Net::API::Stripe objects. It may also take an hash like arguments, that also are method of the same name.
Net::API::Stripe
Toggles verbose mode on/off
Toggles debug mode on/off
Unique identifier for the object.
String representing the object’s type. Objects of the same type share the same value.
Amount transferred.
ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
When expanded, this is a Net::API::Stripe::Balance::Transaction object.
Net::API::Stripe::Balance::Transaction
Time at which the object was created. Measured in seconds since the Unix epoch.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
An arbitrary string attached to the object. Often useful for displaying to users.
Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
Message to user further explaining reason for top-up failure if available.
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
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.
For most Stripe users, the source of every top-up is a bank account. This hash is then the source object describing that bank account.
This is a Net::API::Stripe::Payment::Source object.
Net::API::Stripe::Payment::Source
Extra information about a top-up. This will appear on your source’s bank statement. It must contain at least one letter.
The status of the top-up is either canceled, failed, pending, reversed, or succeeded. transfer_group string
A string that identifies this top-up as part of a group.
Undocumented in Stripe API, but found in its response json data. See example API sample below.
{ "id": "tu_123456789", "object": "topup", "amount": 1000, "balance_transaction": null, "created": 123456789, "currency": "jpy", "description": "Top-up description", "expected_availability_date": 123456789, "failure_code": null, "failure_message": null, "livemode": false, "metadata": { "order_id": "12345678" }, "source": { "id": "src_1FVF3MF5IfL0eXz9l7WLfMwG", "object": "source", "ach_debit": { "country": "US", "type": "individual", "routing_number": "110000000", "bank_name": "STRIPE TEST BANK", "fingerprint": "5Wh4KBcfDrz5IOnx", "last4": "6789" }, "amount": null, "client_secret": "src_client_secret_G1HcAPbFnoCcNic9PYnhFqDj", "created": 1571480456, "currency": "jpy", "flow": "code_verification", "livemode": false, "metadata": {}, "owner": { "address": null, "email": "jenny.rosen@example.com", "name": "Jenny Rosen", "phone": null, "verified_address": null, "verified_email": null, "verified_name": null, "verified_phone": null }, "statement_descriptor": null, "status": "pending", "type": "ach_debit", "usage": "reusable" }, "statement_descriptor": null, "status": "pending", "transfer_group": null }
Initial version
Jacques Deguest <jack@deguest.jp>
Stripe API documentation:
https://stripe.com/docs/api/topups, https://stripe.com/docs/connect/top-ups
Copyright (c) 2018-2019 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.
1 POD Error
The following errors were encountered while parsing the POD:
You forgot a '=back' before '=head1'
To install Net::API::Stripe, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::API::Stripe
CPAN shell
perl -MCPAN -e shell install Net::API::Stripe
For more information on module installation, please visit the detailed CPAN module installation guide.