NAME

Net::API::Stripe::Connect::TopUp - An Stripe Top-up Object

SYNOPSIS

my $topup = $stripe->topup({
    amount => 2000,
    currency => 'usd',
    description => 'Adding fund for Q2 2020',
    metadata => { transaction_id => 123 },
    source => $source_object,
    statement_descriptor => 'Fund transfer to Stripe for Q2 2020',
});

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

VERSION

v0.100.0

DESCRIPTION

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.

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Connect::TopUp 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 "topup"

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

amount integer

Amount transferred.

balance_transaction string (expandable)

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.

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.

description string

An arbitrary string attached to the object. Often useful for displaying to users.

expected_availability_date integer

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.

failure_code string

Error code explaining reason for top-up failure if available (see the errors section for a list of codes).

failure_message string

Message to user further explaining reason for top-up failure if available.

livemode boolean

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

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.

source hash, source object

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.

statement_descriptor string

Extra information about a top-up. This will appear on your source’s bank statement. It must contain at least one letter.

status string

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.

transfer_group

Undocumented in Stripe API, but found in its response json data. See example API sample below.

API SAMPLE

{
  "id": "tu_fake123456789",
  "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_fake123456789",
    "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_fake123456789",
    "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
}

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/topups, https://stripe.com/docs/connect/top-ups

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