NAME

Net::API::Stripe::Connect::ExternalAccount::Card - A Stripe Card Account Object

SYNOPSIS

VERSION

    0.1

DESCRIPTION

These External Accounts are transfer destinations on Account objects for Custom accounts (https://stripe.com/docs/connect/custom-accounts). They can be bank accounts or debit cards.

Bank accounts (https://stripe.com/docs/api#customer_bank_account_object) and debit cards (https://stripe.com/docs/api#card_object) can also be used as payment sources on regular charges, and are documented in the links above.

CONSTRUCTOR

new( %ARG )

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

verbose

Toggles verbose mode on/off

debug

Toggles debug mode on/off

METHODS

id string

Unique identifier for the object.

object string, value is "card"

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

account custom only string (expandable)

The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

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

address_city string

City/District/Suburb/Town/Village.

address_country string

Billing address country, if provided when creating card.

address_line1 string

Address line 1 (Street address/PO Box/Company name).

address_line1_check string

If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.

address_line2 string

Address line 2 (Apartment/Suite/Unit/Building).

address_state string

State/County/Province/Region.

address_zip string

ZIP or postal code.

address_zip_check string

If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.

available_payout_methods array

A set of available payout methods for this card. Will be either ["standard"] or ["standard", "instant"]. Only values from this set should be passed as the method when creating a transfer.

brand string

Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.

checks

address_line1_check string

If a address line1 was provided, results of the check, one of ‘pass’, ‘failed’, ‘unavailable’ or ‘unchecked’.

address_postal_code_check string

If a address postal code was provided, results of the check, one of ‘pass’, ‘failed’, ‘unavailable’ or ‘unchecked’.

cvc_check string

If a CVC was provided, results of the check, one of ‘pass’, ‘failed’, ‘unavailable’ or ‘unchecked’.

country string

Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

currency custom only currency

Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.

customer string (expandable)

The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.

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

cvc string

Card security code. Highly recommended to always include this value, but it's required only for accounts based in European countries.

This is used when creating a card object on Stripe API. See here: https://stripe.com/docs/api/cards/create

cvc_check string

If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked.

default_for_currency custom only boolean

Whether this card is the default external account for its currency.

dynamic_last4 string

(For tokenized numbers only.) The last four digits of the device account number.

exp_month integer

Two-digit number representing the card’s expiration month.

exp_year integer

Four-digit number representing the card’s expiration year.

fingerprint string

Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example.

funding string

Card funding type. Can be credit, debit, prepaid, or unknown.

generated_from hash

Details of the original PaymentMethod that created this object.

installments hash

If present, this is a Net::API::Stripe::Payment::Installment object. As of 2019-02-19, this is only used in Mexico though. See here for more information: https://stripe.com/docs/payments/installments

last4 string

The last four digits of the card.

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.

name string

Cardholder name.

network string preview feature

Identifies which network this charge was processed on. Can be amex, diners, discover, interac, jcb, mastercard, unionpay, visa, or unknown.

recipient string (expandable)

The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

Since 2017, Stripe recipients have been replaced by Stripe accounts: https://stripe.com/docs/connect/recipient-account-migrations

So this is a Stripe account id, or if expanded, a Net::API::Stripe::Connect::Account object.

three_d_secure hash

Populated if this transaction used 3D Secure authentication.

This is an objectified hash reference, ie its key / value pairs can be accessed as virtual methods. It uses the virtal package Net::API::Stripe::Payment::3DSecure

authenticated boolean

Whether or not authentication was performed. 3D Secure will succeed without authentication when the card is not enrolled.

succeeded boolean

Whether or not 3D Secure succeeded.

version string

The version of 3D Secure that was used for this payment.

three_d_secure_usage hash

Contains details on how this Card maybe be used for 3D Secure authentication.

This is a virtual Net::API::Strip::Payment::3DUsage object ie whereby each key can be accessed as methods.

supported boolean

Whether 3D Secure is supported on this card.

tokenization_method string

If the card number is tokenized, this is the method that was used. Can be apple_pay or google_pay.

wallet hash

If this Card is part of a card wallet, this contains the details of the card wallet.

If present, this is a virtual package Net::API::Stripe::Payment::Wallet object. The following data structure that can be accessed as chain objects is:

amex_express_checkout hash

If this is a amex_express_checkout card wallet, this hash contains details about the wallet.

No properties set yet in Stripe documentation.

apple_pay hash

If this is a apple_pay card wallet, this hash contains details about the wallet.

No properties set yet in Stripe documentation.

dynamic_last4 string

(For tokenized numbers only.) The last four digits of the device account number.

google_pay hash

If this is a google_pay card wallet, this hash contains details about the wallet.

No properties set yet in Stripe documentation.

masterpass hash

If this is a masterpass card wallet, this hash contains details about the wallet.

billing_address hash

Owner’s verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

city string

City/District/Suburb/Town/Village.

country string

2-letter country code.

line1 string

Address line 1 (Street address/PO Box/Company name).

line2 string

Address line 2 (Apartment/Suite/Unit/Building).

postal_code string

ZIP or postal code.

state string

State/County/Province/Region.

email string

Owner’s verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

name string

Owner’s verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

shipping_address hash

Owner’s verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

city string

City/District/Suburb/Town/Village.

country string

2-letter country code.

line1 string

Address line 1 (Street address/PO Box/Company name).

line2 string

Address line 2 (Apartment/Suite/Unit/Building).

postal_code string

ZIP or postal code.

state string

State/County/Province/Region.

samsung_pay hash

If this is a samsung_pay card wallet, this hash contains details about the wallet.

No properties set yet in Stripe documentation.

type string

The type of the card wallet, one of amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, or visa_checkout. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.

visa_checkout hash

If this is a visa_checkout card wallet, this hash contains details about the wallet.

billing_address hash

Owner’s verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

city string

City/District/Suburb/Town/Village.

country string

2-letter country code.

line1 string

Address line 1 (Street address/PO Box/Company name).

line2 string

Address line 2 (Apartment/Suite/Unit/Building).

postal_code string

ZIP or postal code.

state string

State/County/Province/Region.

email string

Owner’s verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

name string

Owner’s verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

shipping_address hash

Owner’s verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

city string

City/District/Suburb/Town/Village.

country string

2-letter country code.

line1 string

Address line 1 (Street address/PO Box/Company name).

line2 string

Address line 2 (Apartment/Suite/Unit/Building).

postal_code string

ZIP or postal code.

state string

State/County/Province/Region.

API SAMPLE

        {
          "id": "card_1FVF3JCeyNCl6fY2zKx7HpoK",
          "object": "card",
          "address_city": null,
          "address_country": null,
          "address_line1": null,
          "address_line1_check": null,
          "address_line2": null,
          "address_state": null,
          "address_zip": null,
          "address_zip_check": null,
          "brand": "Visa",
          "country": "US",
          "customer": null,
          "cvc_check": null,
          "dynamic_last4": null,
          "exp_month": 8,
          "exp_year": 2020,
          "fingerprint": "x18XyLUPM6hub5xz",
          "funding": "credit",
          "last4": "4242",
          "metadata": {},
          "name": null,
          "tokenization_method": null
        }

HISTORY

v0.1

Initial version

STRIPE HISTORY

2018-01-23

When being viewed by a platform, cards and bank accounts created on behalf of connected accounts will have a fingerprint that is universal across all connected accounts. For accounts that are not connect platforms, there will be no change.

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/external_account_cards/object, https://stripe.com/docs/connect/payouts

COPYRIGHT & LICENSE

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.