NAME
Net::API::Stripe::Payment::Method - A Stripe Payment Method Object
SYNOPSIS
VERSION
0.1.1
DESCRIPTION
PaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents (https://stripe.com/docs/payments/payment-intents) to collect payments or saved to Customer objects to store instrument details for future payments.
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 "payment_method"
-
String representing the object’s type. Objects of the same type share the same value.
- au_becs_debit
-
If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
- bsb_number string
-
Six-digit number identifying bank and branch associated with this bank account.
- fingerprint string
-
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- last4 string
-
Last four digits of the bank account number.
- billing_details hash
-
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
This is a
Net::API::Stripe::Billing::Details
object. - card hash
-
If this is a card PaymentMethod, this hash contains details about the card. Show child attributes
- card_present hash
-
If this is an card_present PaymentMethod, this hash contains details about the Card Present payment method. Show child attributes
- created timestamp
-
Time at which the object was created. Measured in seconds since the Unix epoch.
- customer string (expandable)
-
The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
- fpx hash
-
If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
- ideal hash
-
If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
- 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.
- sepa_debit hash
-
If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
- bank_code string
-
Bank code of bank associated with the bank account.
- branch_code string
-
Branch code of bank associated with the bank account.
- country string
-
Two-letter ISO code representing the country the bank account is located in.
- fingerprint string
-
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- last4 string
-
Last four characters of the IBAN.
- type string
-
The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
Possible enum values: card, fpx, ideal, sepa_debit
API SAMPLE
{
"id": "pm_123456789",
"object": "payment_method",
"billing_details": {
"address": {
"city": "Anytown",
"country": "US",
"line1": "1234 Main street",
"line2": null,
"postal_code": "123456",
"state": null
},
"email": "jenny@example.com",
"name": null,
"phone": "+15555555555"
},
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": null
},
"country": "US",
"exp_month": 8,
"exp_year": 2020,
"fingerprint": "x18XyLUPM6hub5xz",
"funding": "credit",
"generated_from": null,
"last4": "4242",
"three_d_secure_usage": {
"supported": true
},
"wallet": null
},
"created": 123456789,
"customer": null,
"livemode": false,
"metadata": {
"order_id": "123456789"
},
"type": "card"
}
HISTORY
v0.1
Initial version
STRIPE HISTORY
2019-12-24
Added properties ideal and sepa_debit
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
Stripe API documentation:
https://stripe.com/docs/api/payment_methods, https://stripe.com/docs/payments/payment-methods, https://stripe.com/docs/payments/cards/reusing-cards
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.
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 103:
You forgot a '=back' before '=head1'