The Reader object

Terminal

Reader

The Reader object

Attributes

idstring
Unique identifier for the object.

device_typeenum

Device type of the reader.

Possible enum values

bbpos_chipper2x

BBPOS Chipper 2X BT reader.

bbpos_wisepad3

BBPOS WisePad 3 reader.

bbpos_wisepos_e

BBPOS WisePOS E reader.

mobile_phone_reader

Tap to Pay device.

simulated_stripe_s700

Simulated Stripe S700 reader.

simulated_wisepos_e

Simulated BBPOS WisePOS E reader.

stripe_m2

Stripe M2 reader.

stripe_s700

Stripe S700 reader.

labelstring
Custom label given to the reader for easier identification.

locationnullable stringExpandable
The location identifier of the reader.

metadataobject
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.

serial_numberstring
Serial number of the reader.

statusnullable enum
The networking status of the reader. We do not recommend using this field in flows that may block taking payments.
Possible enum values
offline
online

More attributes

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

actionnullable object

The most recent action performed by the reader.

action.collect_inputsnullable objectPreview feature
Payload required to collect inputs using the reader. Only present if type is collect_inputs.
- action.collect_inputs.inputsarray of objects
  List of inputs to be collected.
  action.collect_inputs.inputs.custom_textnullable object
  Default text of input being collected.
  action.collect_inputs.inputs.custom_text.descriptionnullable string
  Customize the default description for this input
  action.collect_inputs.inputs.custom_text.skip_buttonnullable string
  Customize the default label for this input’s skip button
  action.collect_inputs.inputs.custom_text.submit_buttonnullable string
  Customize the default label for this input’s submit button
  action.collect_inputs.inputs.custom_text.titlenullable string
  Customize the default title for this input
  action.collect_inputs.inputs.emailnullable object
  Email form value collected.
  action.collect_inputs.inputs.email.valuenullable string
  The collected email address
  action.collect_inputs.inputs.numericnullable object
  Numeric form value collected.
  action.collect_inputs.inputs.numeric.valuenullable string
  The collected number
  action.collect_inputs.inputs.phonenullable object
  Phone form value collected.
  action.collect_inputs.inputs.phone.valuenullable string
  The collected phone number
  action.collect_inputs.inputs.requirednullable boolean
  Indicate that this input is required, disabling the skip button.
  action.collect_inputs.inputs.selectionnullable object
  Selection form choices being collected. Values are present if collection is complete.
  action.collect_inputs.inputs.selection.idnullable string
  The id of the selected choice
  action.collect_inputs.inputs.selection.choicesarray of objects
  List of possible choices to be selected
  action.collect_inputs.inputs.selection.choices.idnullable string
  The id to be selected
  action.collect_inputs.inputs.selection.choices.stylenullable enum
  The button style for the choice
  action.collect_inputs.inputs.selection.choices.textstring
  The text to be selected
  action.collect_inputs.inputs.selection.textnullable string
  The text of the selected choice
  action.collect_inputs.inputs.signaturenullable object
  Signature form value collected.
  action.collect_inputs.inputs.signature.valuenullable string
  The File ID of a collected signature image
  action.collect_inputs.inputs.skippednullable boolean
  Indicate that this input was skipped by the user.
  action.collect_inputs.inputs.textnullable object
  Text form value collected.
  action.collect_inputs.inputs.text.valuenullable string
  The collected text value
  action.collect_inputs.inputs.togglesnullable array of objects
  List of toggles being collected. Values are present if collection is complete.
  action.collect_inputs.inputs.toggles.default_valuenullable enum
  The toggle’s default value
  action.collect_inputs.inputs.toggles.descriptionnullable string
  The toggle’s description text
  action.collect_inputs.inputs.toggles.titlenullable string
  The toggle’s title text
  action.collect_inputs.inputs.toggles.valuenullable enum
  The toggle’s collected value
  action.collect_inputs.inputs.typeenum
  Type of input being collected.
  Possible enum values
  email
  numeric
  phone
  selection
  signature
  text
- action.collect_inputs.metadatanullable object
  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.

action.collect_payment_methodnullable object

Payload required to collect payment method using the reader. Only present if type is collect_payment_method.

action.collect_payment_method.collect_confignullable object
Per-transaction overrides of Terminal reader configurations.
- action.collect_payment_method.collect_config.enable_customer_cancellationnullable boolean
  Enable customer-initiated cancellation when processing this payment.
- action.collect_payment_method.collect_config.skip_tippingnullable boolean
  Override showing a tipping selection screen on this transaction.
- action.collect_payment_method.collect_config.tippingnullable object
  Tipping configuration for this transaction.
  action.collect_payment_method.collect_config.tipping.amount_eligiblenullable integer
  Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).

action.collect_payment_method.payment_intentstringExpandable
Most recent PaymentIntent processed by the reader.

action.collect_payment_method.payment_methodnullable object

PaymentMethod collected by the reader.

action.collect_payment_method.payment_method.idstring
Unique identifier for the object.

action.collect_payment_method.payment_method.objectstring
String representing the object’s type. Objects of the same type share the same value.

action.collect_payment_method.payment_method.acss_debitnullable object
If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
- action.collect_payment_method.payment_method.acss_debit.bank_namenullable string
  Name of the bank associated with the bank account.
- action.collect_payment_method.payment_method.acss_debit.fingerprintnullable string
  Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- action.collect_payment_method.payment_method.acss_debit.institution_numbernullable string
  Institution number of the bank account.
- action.collect_payment_method.payment_method.acss_debit.last4nullable string
  Last four digits of the bank account number.
- action.collect_payment_method.payment_method.acss_debit.transit_numbernullable string
  Transit number of the bank account.

action.collect_payment_method.payment_method.affirmnullable object
If this is an affirm PaymentMethod, this hash contains details about the Affirm payment method.

action.collect_payment_method.payment_method.afterpay_clearpaynullable object
If this is an AfterpayClearpay PaymentMethod, this hash contains details about the AfterpayClearpay payment method.

action.collect_payment_method.payment_method.alipaynullable object
If this is an Alipay PaymentMethod, this hash contains details about the Alipay payment method.

action.collect_payment_method.payment_method.allow_redisplaynullable enum

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

Possible enum values

always

Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

limited

Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

unspecified

This is the default value for payment methods where allow_redisplay wasn’t set.

action.collect_payment_method.payment_method.almanullable object
If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.

action.collect_payment_method.payment_method.amazon_paynullable object
If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.

action.collect_payment_method.payment_method.au_becs_debitnullable object
If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
- action.collect_payment_method.payment_method.au_becs_debit.bsb_numbernullable string
  Six-digit number identifying bank and branch associated with this bank account.
- action.collect_payment_method.payment_method.au_becs_debit.fingerprintnullable string
  Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- action.collect_payment_method.payment_method.au_becs_debit.last4nullable string
  Last four digits of the bank account number.

action.collect_payment_method.payment_method.bacs_debitnullable object
If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
- action.collect_payment_method.payment_method.bacs_debit.fingerprintnullable string
  Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- action.collect_payment_method.payment_method.bacs_debit.last4nullable string
  Last four digits of the bank account number.
- action.collect_payment_method.payment_method.bacs_debit.sort_codenullable string
  Sort code of the bank account. (e.g., 10-20-30)

action.collect_payment_method.payment_method.bancontactnullable object
If this is a bancontact PaymentMethod, this hash contains details about the Bancontact payment method.

action.collect_payment_method.payment_method.billienullable object
If this is a billie PaymentMethod, this hash contains details about the Billie payment method.

action.collect_payment_method.payment_method.billing_detailsobject
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
- action.collect_payment_method.payment_method.billing_details.addressnullable object
  Billing address.
  action.collect_payment_method.payment_method.billing_details.address.citynullable string
  City, district, suburb, town, or village.
  action.collect_payment_method.payment_method.billing_details.address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  action.collect_payment_method.payment_method.billing_details.address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  action.collect_payment_method.payment_method.billing_details.address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  action.collect_payment_method.payment_method.billing_details.address.postal_codenullable string
  ZIP or postal code.
  action.collect_payment_method.payment_method.billing_details.address.statenullable string
  State, county, province, or region.
- action.collect_payment_method.payment_method.billing_details.emailnullable string
  Email address.
- action.collect_payment_method.payment_method.billing_details.namenullable string
  Full name.
- action.collect_payment_method.payment_method.billing_details.phonenullable string
  Billing phone number (including extension).
- action.collect_payment_method.payment_method.billing_details.tax_idnullable string
  Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.

action.collect_payment_method.payment_method.bliknullable object
If this is a blik PaymentMethod, this hash contains details about the BLIK payment method.

action.collect_payment_method.payment_method.boletonullable object
If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
- action.collect_payment_method.payment_method.boleto.tax_idstring
  Uniquely identifies the customer tax id (CNPJ or CPF)

action.collect_payment_method.payment_method.cardnullable object

If this is a card PaymentMethod, this hash contains the user’s card details.

action.collect_payment_method.payment_method.card.brandstring
Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.

action.collect_payment_method.payment_method.card.checksnullable object
Checks on Card address and CVC if provided.
- action.collect_payment_method.payment_method.card.checks.address_line1_checknullable string
  If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked.
- action.collect_payment_method.payment_method.card.checks.address_postal_code_checknullable string
  If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked.
- action.collect_payment_method.payment_method.card.checks.cvc_checknullable string
  If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked.

action.collect_payment_method.payment_method.card.countrynullable 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.

action.collect_payment_method.payment_method.card.display_brandnullable string
The brand to use when displaying the card, this accounts for customer’s brand choice on dual-branded cards. Can be american_express, cartes_bancaires, diners_club, discover, eftpos_australia, interac, jcb, mastercard, union_pay, visa, or other and may contain more values in the future.

action.collect_payment_method.payment_method.card.exp_monthinteger
Two-digit number representing the card’s expiration month.

action.collect_payment_method.payment_method.card.exp_yearinteger
Four-digit number representing the card’s expiration year.

action.collect_payment_method.payment_method.card.fingerprintnullable 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. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

action.collect_payment_method.payment_method.card.fundingstring
Card funding type. Can be credit, debit, prepaid, or unknown.

action.collect_payment_method.payment_method.card.generated_fromnullable object

Details of the original PaymentMethod that created this object.

action.collect_payment_method.payment_method.card.generated_from.chargenullable string
The charge that created this object.

action.collect_payment_method.payment_method.card.generated_from.payment_method_detailsnullable object

Transaction-specific details of the payment method used in the payment.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_presentnullable object

This hash contains the snapshot of the card_present transaction-specific details which generated this card payment method.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.amount_authorizednullable integer
The authorized amount

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.brandnullable string
Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.brand_productnullable string
The product code that identifies the specific program or product associated with a card.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.capture_beforenullable timestamp
When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.cardholder_namenullable string
The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.countrynullable 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.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.descriptionnullable string
A high-level description of the type of cards issued in this range.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.emv_auth_datanullable string
Authorization response cryptogram.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.exp_monthinteger
Two-digit number representing the card’s expiration month.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.exp_yearinteger
Four-digit number representing the card’s expiration year.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.fingerprintnullable 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. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.fundingnullable string
Card funding type. Can be credit, debit, prepaid, or unknown.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.generated_cardnullable string
ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.incremental_authorization_supportedboolean
Whether this PaymentIntent is eligible for incremental authorizations. Request support using request_incremental_authorization_support.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.issuernullable string
The name of the card’s issuing bank.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.last4nullable string
The last four digits of the card.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.networknullable string
Identifies which network this charge was processed on. Can be amex, cartes_bancaires, diners, discover, eftpos_au, interac, jcb, link, mastercard, unionpay, visa, or unknown.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.network_transaction_idnullable string
This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.offlinenullable object
Details about payments collected offline.
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.offline.stored_atnullable timestamp
  Time at which the payment was collected while offline
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.offline.typenullable enum
  The method used to process this payment method offline. Only deferred is allowed.
  Possible enum values
  deferred

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.overcapture_supportedboolean
Defines whether the authorized amount can be over-captured or not

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.preferred_localesnullable array of strings
The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card’s chip.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.read_methodnullable enum

How card details were read in this transaction.

Possible enum values

contact_emv

Inserting a chip card into the card reader.

contactless_emv

Tapping a contactless-enabled chip card or mobile wallet.

contactless_magstripe_mode

Older standard for contactless payments that emulated a magnetic stripe read.

magnetic_stripe_fallback

When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.

magnetic_stripe_track2

Swiping a card using the magnetic stripe reader.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receiptnullable object
A collection of fields required to be displayed on receipts. Only required for EMV transactions.
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receipt.account_typenullable enum
  The type of account being debited or credited
  Possible enum values
  checking
  A checking account, as when using a debit card
  credit
  A credit account, as when using a credit card
  prepaid
  A prepaid account, as when using a debit gift card
  unknown
  An unknown account
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receipt.application_cryptogramnullable string
  The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receipt.application_preferred_namenullable string
  The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card’s chip.
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receipt.authorization_codenullable string
  Identifier for this transaction.
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receipt.authorization_response_codenullable string
  EMV tag 8A. A code returned by the card issuer.
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receipt.cardholder_verification_methodnullable string
  Describes the method used by the cardholder to verify ownership of the card. One of the following: approval, failure, none, offline_pin, offline_pin_and_signature, online_pin, or signature.
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receipt.dedicated_file_namenullable string
  Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receipt.terminal_verification_resultsnullable string
  A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
- action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.receipt.transaction_status_informationnullable string
  An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.walletnullable object

If a mobile wallet was presented in the transaction, this contains the details of the mobile wallet.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.card_present.wallet.typeenum

The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.

Possible enum values

apple_pay

Apple Pay is a mobile payment service by Apple.

google_pay

Google Pay is a mobile payment service by Google.

samsung_pay

Samsung Pay is a mobile payment service by Samsung Electronics.

unknown

The wallet provider is unknown.

action.collect_payment_method.payment_method.card.generated_from.payment_method_details.typestring
The type of payment method transaction-specific details from the transaction that generated this card payment method. Always card_present.

action.collect_payment_method.payment_method.card.generated_from.setup_attemptnullable stringExpandable
The ID of the SetupAttempt that generated this PaymentMethod, if any.

action.collect_payment_method.payment_method.card.last4string
The last four digits of the card.

action.collect_payment_method.payment_method.card.networksnullable object
Contains information about card networks that can be used to process the payment.
- action.collect_payment_method.payment_method.card.networks.availablearray of strings
  All networks available for selection via payment_method_options.card.network.
- action.collect_payment_method.payment_method.card.networks.preferrednullable string
  The preferred network for co-branded cards. Can be cartes_bancaires, mastercard, visa or invalid_preference if requested network is not valid for the card.

action.collect_payment_method.payment_method.card.regulated_statusnullable enum
Status of a card based on the card issuer.
Possible enum values
regulated
The card falls under a regulated account range.
unregulated
The card does not fall under a regulated account range.

action.collect_payment_method.payment_method.card.three_d_secure_usagenullable object
Contains details on how this Card may be used for 3D Secure authentication.
- action.collect_payment_method.payment_method.card.three_d_secure_usage.supportedboolean
  Whether 3D Secure is supported on this card.

action.collect_payment_method.payment_method.card.walletnullable object
If this Card is part of a card wallet, this contains the details of the card wallet.
- action.collect_payment_method.payment_method.card.wallet.amex_express_checkoutnullable object
  If this is a amex_express_checkout card wallet, this hash contains details about the wallet.
- action.collect_payment_method.payment_method.card.wallet.apple_paynullable object
  If this is a apple_pay card wallet, this hash contains details about the wallet.
- action.collect_payment_method.payment_method.card.wallet.dynamic_last4nullable string
  (For tokenized numbers only.) The last four digits of the device account number.
- action.collect_payment_method.payment_method.card.wallet.google_paynullable object
  If this is a google_pay card wallet, this hash contains details about the wallet.
- action.collect_payment_method.payment_method.card.wallet.linknullable object
  If this is a link card wallet, this hash contains details about the wallet.
- action.collect_payment_method.payment_method.card.wallet.masterpassnullable object
  If this is a masterpass card wallet, this hash contains details about the wallet.
  action.collect_payment_method.payment_method.card.wallet.masterpass.billing_addressnullable object
  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.
  action.collect_payment_method.payment_method.card.wallet.masterpass.billing_address.citynullable string
  City, district, suburb, town, or village.
  action.collect_payment_method.payment_method.card.wallet.masterpass.billing_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  action.collect_payment_method.payment_method.card.wallet.masterpass.billing_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  action.collect_payment_method.payment_method.card.wallet.masterpass.billing_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  action.collect_payment_method.payment_method.card.wallet.masterpass.billing_address.postal_codenullable string
  ZIP or postal code.
  action.collect_payment_method.payment_method.card.wallet.masterpass.billing_address.statenullable string
  State, county, province, or region.
  action.collect_payment_method.payment_method.card.wallet.masterpass.emailnullable 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.
  action.collect_payment_method.payment_method.card.wallet.masterpass.namenullable 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.
  action.collect_payment_method.payment_method.card.wallet.masterpass.shipping_addressnullable object
  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.
  action.collect_payment_method.payment_method.card.wallet.masterpass.shipping_address.citynullable string
  City, district, suburb, town, or village.
  action.collect_payment_method.payment_method.card.wallet.masterpass.shipping_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  action.collect_payment_method.payment_method.card.wallet.masterpass.shipping_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  action.collect_payment_method.payment_method.card.wallet.masterpass.shipping_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  action.collect_payment_method.payment_method.card.wallet.masterpass.shipping_address.postal_codenullable string
  ZIP or postal code.
  action.collect_payment_method.payment_method.card.wallet.masterpass.shipping_address.statenullable string
  State, county, province, or region.
- action.collect_payment_method.payment_method.card.wallet.samsung_paynullable object
  If this is a samsung_pay card wallet, this hash contains details about the wallet.
- action.collect_payment_method.payment_method.card.wallet.typeenum
  The type of the card wallet, one of amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout, or link. 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.
  Possible enum values
  amex_express_checkout
  apple_pay
  google_pay
  link
  masterpass
  samsung_pay
  visa_checkout
- action.collect_payment_method.payment_method.card.wallet.visa_checkoutnullable object
  If this is a visa_checkout card wallet, this hash contains details about the wallet.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.billing_addressnullable object
  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.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.billing_address.citynullable string
  City, district, suburb, town, or village.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.billing_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.billing_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.billing_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.billing_address.postal_codenullable string
  ZIP or postal code.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.billing_address.statenullable string
  State, county, province, or region.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.emailnullable 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.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.namenullable 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.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.shipping_addressnullable object
  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.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.shipping_address.citynullable string
  City, district, suburb, town, or village.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.shipping_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.shipping_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.shipping_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.shipping_address.postal_codenullable string
  ZIP or postal code.
  action.collect_payment_method.payment_method.card.wallet.visa_checkout.shipping_address.statenullable string
  State, county, province, or region.

action.collect_payment_method.payment_method.card_presentnullable object

If this is a card_present PaymentMethod, this hash contains details about the Card Present payment method.

action.collect_payment_method.payment_method.card_present.brandnullable string
Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.

action.collect_payment_method.payment_method.card_present.brand_productnullable string
The product code that identifies the specific program or product associated with a card.

action.collect_payment_method.payment_method.card_present.cardholder_namenullable string
The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.

action.collect_payment_method.payment_method.card_present.countrynullable 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.

action.collect_payment_method.payment_method.card_present.descriptionnullable string
A high-level description of the type of cards issued in this range.

action.collect_payment_method.payment_method.card_present.exp_monthinteger
Two-digit number representing the card’s expiration month.

action.collect_payment_method.payment_method.card_present.exp_yearinteger
Four-digit number representing the card’s expiration year.

action.collect_payment_method.payment_method.card_present.fingerprintnullable 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. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

action.collect_payment_method.payment_method.card_present.fundingnullable string
Card funding type. Can be credit, debit, prepaid, or unknown.

action.collect_payment_method.payment_method.card_present.issuernullable string
The name of the card’s issuing bank.

action.collect_payment_method.payment_method.card_present.last4nullable string
The last four digits of the card.

action.collect_payment_method.payment_method.card_present.networksnullable object
Contains information about card networks that can be used to process the payment.
- action.collect_payment_method.payment_method.card_present.networks.availablearray of strings
  All networks available for selection via payment_method_options.card.network.
- action.collect_payment_method.payment_method.card_present.networks.preferrednullable string
  The preferred network for the card.

action.collect_payment_method.payment_method.card_present.offlinenullable object
Details about payment methods collected offline.
- action.collect_payment_method.payment_method.card_present.offline.stored_atnullable timestamp
  Time at which the payment was collected while offline
- action.collect_payment_method.payment_method.card_present.offline.typenullable enum
  The method used to process this payment method offline. Only deferred is allowed.
  Possible enum values
  deferred

action.collect_payment_method.payment_method.card_present.preferred_localesnullable array of strings
The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card’s chip.

action.collect_payment_method.payment_method.card_present.read_methodnullable enum

How card details were read in this transaction.

Possible enum values

contact_emv

Inserting a chip card into the card reader.

contactless_emv

Tapping a contactless-enabled chip card or mobile wallet.

contactless_magstripe_mode

Older standard for contactless payments that emulated a magnetic stripe read.

magnetic_stripe_fallback

When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.

magnetic_stripe_track2

Swiping a card using the magnetic stripe reader.

action.collect_payment_method.payment_method.card_present.walletnullable object

If a mobile wallet was presented in the transaction, this contains the details of the mobile wallet.

action.collect_payment_method.payment_method.card_present.wallet.typeenum

The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.

Possible enum values

apple_pay

Apple Pay is a mobile payment service by Apple.

google_pay

Google Pay is a mobile payment service by Google.

samsung_pay

Samsung Pay is a mobile payment service by Samsung Electronics.

unknown

The wallet provider is unknown.

action.collect_payment_method.payment_method.cashappnullable object
If this is a cashapp PaymentMethod, this hash contains details about the Cash App Pay payment method.
- action.collect_payment_method.payment_method.cashapp.buyer_idnullable string
  A unique and immutable identifier assigned by Cash App to every buyer.
- action.collect_payment_method.payment_method.cashapp.cashtagnullable string
  A public identifier for buyers using Cash App.

action.collect_payment_method.payment_method.createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

action.collect_payment_method.payment_method.cryptonullable object
If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.

action.collect_payment_method.payment_method.customernullable stringExpandable
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.

action.collect_payment_method.payment_method.customer_balancenullable object
If this is a customer_balance PaymentMethod, this hash contains details about the CustomerBalance payment method.

action.collect_payment_method.payment_method.epsnullable object

If this is an eps PaymentMethod, this hash contains details about the EPS payment method.

action.collect_payment_method.payment_method.eps.banknullable enum

The customer’s bank. Should be one of arzte_und_apotheker_bank, austrian_anadi_bank_ag, bank_austria, bankhaus_carl_spangler, bankhaus_schelhammer_und_schattera_ag, bawag_psk_ag, bks_bank_ag, brull_kallmus_bank_ag, btv_vier_lander_bank, capital_bank_grawe_gruppe_ag, deutsche_bank_ag, dolomitenbank, easybank_ag, erste_bank_und_sparkassen, hypo_alpeadriabank_international_ag, hypo_noe_lb_fur_niederosterreich_u_wien, hypo_oberosterreich_salzburg_steiermark, hypo_tirol_bank_ag, hypo_vorarlberg_bank_ag, hypo_bank_burgenland_aktiengesellschaft, marchfelder_bank, oberbank_ag, raiffeisen_bankengruppe_osterreich, schoellerbank_ag, sparda_bank_wien, volksbank_gruppe, volkskreditbank_ag, or vr_bank_braunau.

Possible enum values

arzte_und_apotheker_bank

austrian_anadi_bank_ag

bank_austria

bankhaus_carl_spangler

bankhaus_schelhammer_und_schattera_ag

bawag_psk_ag

bks_bank_ag

brull_kallmus_bank_ag

btv_vier_lander_bank

capital_bank_grawe_gruppe_ag

Show 18 more

action.collect_payment_method.payment_method.fpxnullable object
If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
- action.collect_payment_method.payment_method.fpx.bankenum
  The customer’s bank, if provided. Can be one of affin_bank, agrobank, alliance_bank, ambank, bank_islam, bank_muamalat, bank_rakyat, bsn, cimb, hong_leong_bank, hsbc, kfh, maybank2u, ocbc, public_bank, rhb, standard_chartered, uob, deutsche_bank, maybank2e, pb_enterprise, or bank_of_china.
  Possible enum values
  affin_bank
  agrobank
  alliance_bank
  ambank
  bank_islam
  bank_muamalat
  bank_of_china
  bank_rakyat
  bsn
  cimb
  Show 12 more

action.collect_payment_method.payment_method.giropaynullable object
If this is a giropay PaymentMethod, this hash contains details about the Giropay payment method.

action.collect_payment_method.payment_method.grabpaynullable object
If this is a grabpay PaymentMethod, this hash contains details about the GrabPay payment method.

action.collect_payment_method.payment_method.idealnullable object
If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
- action.collect_payment_method.payment_method.ideal.banknullable enum
  The customer’s bank, if provided. Can be one of abn_amro, asn_bank, bunq, buut, handelsbanken, ing, knab, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, or yoursafe.
  Possible enum values
  abn_amro
  asn_bank
  bunq
  buut
  handelsbanken
  ing
  knab
  moneyou
  n26
  nn
  Show 7 more
- action.collect_payment_method.payment_method.ideal.bicnullable enum
  The Bank Identifier Code of the customer’s bank, if the bank was provided.
  Possible enum values
  ABNANL2A
  ASNBNL21
  BITSNL2A
  BUNQNL2A
  BUUTNL2A
  FVLBNL22
  HANDNL2A
  INGBNL2A
  KNABNL2H
  MOYONL21
  Show 8 more

action.collect_payment_method.payment_method.interac_presentnullable objectPreview feature

If this is an interac_present PaymentMethod, this hash contains details about the Interac Present payment method.

action.collect_payment_method.payment_method.interac_present.brandnullable string
Card brand. Can be interac, mastercard or visa.

action.collect_payment_method.payment_method.interac_present.cardholder_namenullable string
The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.

action.collect_payment_method.payment_method.interac_present.countrynullable 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.

action.collect_payment_method.payment_method.interac_present.descriptionnullable string
A high-level description of the type of cards issued in this range.

action.collect_payment_method.payment_method.interac_present.exp_monthinteger
Two-digit number representing the card’s expiration month.

action.collect_payment_method.payment_method.interac_present.exp_yearinteger
Four-digit number representing the card’s expiration year.

action.collect_payment_method.payment_method.interac_present.fingerprintnullable 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. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

action.collect_payment_method.payment_method.interac_present.fundingnullable string
Card funding type. Can be credit, debit, prepaid, or unknown.

action.collect_payment_method.payment_method.interac_present.issuernullable string
The name of the card’s issuing bank.

action.collect_payment_method.payment_method.interac_present.last4nullable string
The last four digits of the card.

action.collect_payment_method.payment_method.interac_present.networksnullable object
Contains information about card networks that can be used to process the payment.
- action.collect_payment_method.payment_method.interac_present.networks.availablearray of strings
  All networks available for selection via payment_method_options.card.network.
- action.collect_payment_method.payment_method.interac_present.networks.preferrednullable string
  The preferred network for the card.

action.collect_payment_method.payment_method.interac_present.preferred_localesnullable array of strings
The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card’s chip.

action.collect_payment_method.payment_method.interac_present.read_methodnullable enum

How card details were read in this transaction.

Possible enum values

contact_emv

Inserting a chip card into the card reader.

contactless_emv

Tapping a contactless-enabled chip card or mobile wallet.

contactless_magstripe_mode

Older standard for contactless payments that emulated a magnetic stripe read.

magnetic_stripe_fallback

When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.

magnetic_stripe_track2

Swiping a card using the magnetic stripe reader.

action.collect_payment_method.payment_method.kakao_paynullable object
If this is a kakao_pay PaymentMethod, this hash contains details about the Kakao Pay payment method.

action.collect_payment_method.payment_method.klarnanullable object
If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
- action.collect_payment_method.payment_method.klarna.dobnullable objectExpandable
  The customer’s date of birth, if provided.
  action.collect_payment_method.payment_method.klarna.dob.daynullable integer
  The day of birth, between 1 and 31.
  action.collect_payment_method.payment_method.klarna.dob.monthnullable integer
  The month of birth, between 1 and 12.
  action.collect_payment_method.payment_method.klarna.dob.yearnullable integer
  The four-digit year of birth.

action.collect_payment_method.payment_method.konbininullable object
If this is a konbini PaymentMethod, this hash contains details about the Konbini payment method.

action.collect_payment_method.payment_method.kr_cardnullable object
If this is a kr_card PaymentMethod, this hash contains details about the Korean Card payment method.
- action.collect_payment_method.payment_method.kr_card.brandnullable enum
  The local credit or debit card brand.
  Possible enum values
  bc
  BC
  citi
  Citi
  hana
  Hana
  hyundai
  Hyundai
  jeju
  Jeju
  jeonbuk
  Jeonbuk
  kakaobank
  Kakao Bank
  kbank
  KBank
  kdbbank
  KDB Bank
  kookmin
  Kookmin
  Show 12 more
- action.collect_payment_method.payment_method.kr_card.last4nullable string
  The last four digits of the card. This may not be present for American Express cards.

action.collect_payment_method.payment_method.linknullable object
If this is an Link PaymentMethod, this hash contains details about the Link payment method.
- action.collect_payment_method.payment_method.link.emailnullable string
  Account owner’s email address.

action.collect_payment_method.payment_method.livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

action.collect_payment_method.payment_method.metadatanullable object
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.

action.collect_payment_method.payment_method.mobilepaynullable object
If this is a mobilepay PaymentMethod, this hash contains details about the MobilePay payment method.

action.collect_payment_method.payment_method.multibanconullable object
If this is a multibanco PaymentMethod, this hash contains details about the Multibanco payment method.

action.collect_payment_method.payment_method.naver_paynullable object
If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
- action.collect_payment_method.payment_method.naver_pay.buyer_idnullable string
  Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
- action.collect_payment_method.payment_method.naver_pay.fundingenum
  Whether to fund this transaction with Naver Pay points or a card.
  Possible enum values
  card
  Use a card to fund this transaction.
  points
  Use Naver Pay points to fund this transaction.

action.collect_payment_method.payment_method.nz_bank_accountnullable object
If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
- action.collect_payment_method.payment_method.nz_bank_account.account_holder_namenullable string
  The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
- action.collect_payment_method.payment_method.nz_bank_account.bank_codestring
  The numeric code for the bank account’s bank.
- action.collect_payment_method.payment_method.nz_bank_account.bank_namestring
  The name of the bank.
- action.collect_payment_method.payment_method.nz_bank_account.branch_codestring
  The numeric code for the bank account’s bank branch.
- action.collect_payment_method.payment_method.nz_bank_account.last4string
  Last four digits of the bank account number.
- action.collect_payment_method.payment_method.nz_bank_account.suffixnullable string
  The suffix of the bank account number.

action.collect_payment_method.payment_method.oxxonullable object
If this is an oxxo PaymentMethod, this hash contains details about the OXXO payment method.

action.collect_payment_method.payment_method.p24nullable object
If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
- action.collect_payment_method.payment_method.p24.banknullable enum
  The customer’s bank, if provided.

action.collect_payment_method.payment_method.pay_by_banknullable object
If this is a pay_by_bank PaymentMethod, this hash contains details about the PayByBank payment method.

action.collect_payment_method.payment_method.payconullable object
If this is a payco PaymentMethod, this hash contains details about the PAYCO payment method.

action.collect_payment_method.payment_method.paynownullable object
If this is a paynow PaymentMethod, this hash contains details about the PayNow payment method.

action.collect_payment_method.payment_method.paypalnullable object
If this is a paypal PaymentMethod, this hash contains details about the PayPal payment method.
- action.collect_payment_method.payment_method.paypal.countrynullable string
  Two-letter ISO code representing the buyer’s country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
- action.collect_payment_method.payment_method.paypal.payer_emailnullable string
  Owner’s email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
- action.collect_payment_method.payment_method.paypal.payer_idnullable string
  PayPal account PayerID. This identifier uniquely identifies the PayPal customer.

action.collect_payment_method.payment_method.pixnullable object
If this is a pix PaymentMethod, this hash contains details about the Pix payment method.

action.collect_payment_method.payment_method.promptpaynullable object
If this is a promptpay PaymentMethod, this hash contains details about the PromptPay payment method.

action.collect_payment_method.payment_method.radar_optionsnullable object
Options to configure Radar. See Radar Session for more information.
- action.collect_payment_method.payment_method.radar_options.sessionnullable string
  A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.

action.collect_payment_method.payment_method.revolut_paynullable object
If this is a revolut_pay PaymentMethod, this hash contains details about the Revolut Pay payment method.

action.collect_payment_method.payment_method.samsung_paynullable object
If this is a samsung_pay PaymentMethod, this hash contains details about the SamsungPay payment method.

action.collect_payment_method.payment_method.satispaynullable object
If this is a satispay PaymentMethod, this hash contains details about the Satispay payment method.

action.collect_payment_method.payment_method.sepa_debitnullable object
If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
- action.collect_payment_method.payment_method.sepa_debit.bank_codenullable string
  Bank code of bank associated with the bank account.
- action.collect_payment_method.payment_method.sepa_debit.branch_codenullable string
  Branch code of bank associated with the bank account.
- action.collect_payment_method.payment_method.sepa_debit.countrynullable string
  Two-letter ISO code representing the country the bank account is located in.
- action.collect_payment_method.payment_method.sepa_debit.fingerprintnullable string
  Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- action.collect_payment_method.payment_method.sepa_debit.generated_fromnullable object
  Information about the object that generated this PaymentMethod.
  action.collect_payment_method.payment_method.sepa_debit.generated_from.chargenullable stringExpandable
  The ID of the Charge that generated this PaymentMethod, if any.
  action.collect_payment_method.payment_method.sepa_debit.generated_from.setup_attemptnullable stringExpandable
  The ID of the SetupAttempt that generated this PaymentMethod, if any.
- action.collect_payment_method.payment_method.sepa_debit.last4nullable string
  Last four characters of the IBAN.

action.collect_payment_method.payment_method.sofortnullable object
If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
- action.collect_payment_method.payment_method.sofort.countrynullable string
  Two-letter ISO code representing the country the bank account is located in.

action.collect_payment_method.payment_method.swishnullable object
If this is a swish PaymentMethod, this hash contains details about the Swish payment method.

action.collect_payment_method.payment_method.twintnullable object
If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.

action.collect_payment_method.payment_method.typeenum

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

acss_debit

Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).

affirm

Affirm is a buy now, pay later payment method in the US.

afterpay_clearpay

Afterpay / Clearpay is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.

alipay

Alipay is a digital wallet payment method used in China.

alma

Alma is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments.

amazon_pay

Amazon Pay is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day.

au_becs_debit

BECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).

bacs_debit

Bacs Direct Debit is used to debit UK bank accounts.

bancontact

Bancontact is a bank redirect payment method used in Belgium.

billie

Billie is a payment method.

Show 40 more

action.collect_payment_method.payment_method.us_bank_accountnullable object

If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.

action.collect_payment_method.payment_method.us_bank_account.account_holder_typenullable enum
Account holder type: individual or company.
Possible enum values
company
Account belongs to a company
individual
Account belongs to an individual

action.collect_payment_method.payment_method.us_bank_account.account_typenullable enum
Account type: checkings or savings. Defaults to checking if omitted.
Possible enum values
checking
Bank account type is checking
savings
Bank account type is savings

action.collect_payment_method.payment_method.us_bank_account.bank_namenullable string
The name of the bank.

action.collect_payment_method.payment_method.us_bank_account.financial_connections_accountnullable string
The ID of the Financial Connections Account used to create the payment method.

action.collect_payment_method.payment_method.us_bank_account.fingerprintnullable string
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

action.collect_payment_method.payment_method.us_bank_account.last4nullable string
Last four digits of the bank account number.

action.collect_payment_method.payment_method.us_bank_account.networksnullable object
Contains information about US bank account networks that can be used.
- action.collect_payment_method.payment_method.us_bank_account.networks.preferrednullable string
  The preferred network.
- action.collect_payment_method.payment_method.us_bank_account.networks.supportedarray of enums
  All supported networks.
  Possible enum values
  ach
  us_domestic_wire

action.collect_payment_method.payment_method.us_bank_account.routing_numbernullable string
Routing number of the bank account.

action.collect_payment_method.payment_method.us_bank_account.status_detailsnullable object

Contains information about the future reusability of this PaymentMethod.

action.collect_payment_method.payment_method.us_bank_account.status_details.blockednullable object

Contains more information about the underlying block. This field will only be rendered if the PaymentMethod is blocked.

action.collect_payment_method.payment_method.us_bank_account.status_details.blocked.network_codenullable enum

The ACH network code that resulted in this block.

Possible enum values

R02

Account Closed

R03

No Account, Unable to Locate Account

R04

Invalid Account Number Structure

R05

Unauthorized Debit to Consumer Account Using Corporate SEC Code

R07

Authorization Revoked By Consumer

R08

Payment Stopped

R10

Customer Advises Originator is Not Known to Receiver and/or Originator is Not Authorized by Receiver to Debit Receiver’s Account

R11

Customer Advises Entry Not in Accordance with the Terms of Authorization

R16

Account Frozen, Entry Returned Per OFAC Instructions

R20

Non-Transaction Account

Show 2 more

action.collect_payment_method.payment_method.us_bank_account.status_details.blocked.reasonnullable enum

The reason why this PaymentMethod’s fingerprint has been blocked

Possible enum values

bank_account_closed

Bank account has been closed.

bank_account_frozen

Bank account has been frozen.

bank_account_invalid_details

Bank account details are incorrect. Please check the account number, routing number, account holder name, and account type.

bank_account_restricted

Bank account does not support debits.

bank_account_unusable

Bank account has been blocked by Stripe. Please contact Support.

debit_not_authorized

Customer has disputed a previous payment with their bank. If the network_code is R29, please confirm that Stripe’s Company IDs are allowlisted before attempting additional payments.

action.collect_payment_method.payment_method.wechat_paynullable object
If this is an wechat_pay PaymentMethod, this hash contains details about the wechat_pay payment method.

action.collect_payment_method.payment_method.zipnullable object
If this is a zip PaymentMethod, this hash contains details about the Zip payment method.

action.confirm_payment_intentnullable object
Payload required to confirm a payment using the reader. Only present if type is confirm_payment_intent.
- action.confirm_payment_intent.confirm_confignullable objectPreview feature
  Per-transaction overrides of Terminal reader configurations.
  action.confirm_payment_intent.confirm_config.return_urlnullable stringPreview feature
  If the customer doesn’t abandon authenticating the payment, they’re redirected to this URL after completion.
- action.confirm_payment_intent.payment_intentstringExpandable
  Most recent PaymentIntent processed by the reader.

action.failure_codenullable string
Failure code, only set if status is failed.

action.failure_messagenullable string
Detailed failure message, only set if status is failed.

action.process_payment_intentnullable object
Payload required to process a PaymentIntent. Only present if type is process_payment_intent.
- action.process_payment_intent.payment_intentstringExpandable
  Most recent PaymentIntent processed by the reader.
- action.process_payment_intent.process_confignullable object
  Per-transaction overrides of Terminal reader configurations.
  action.process_payment_intent.process_config.enable_customer_cancellationnullable boolean
  Enable customer-initiated cancellation when processing this payment.
  action.process_payment_intent.process_config.return_urlnullable stringPreview feature
  If the customer doesn’t abandon authenticating the payment, they’re redirected to this URL after completion.
  action.process_payment_intent.process_config.skip_tippingnullable boolean
  Override showing a tipping selection screen on this transaction.
  action.process_payment_intent.process_config.tippingnullable object
  Tipping configuration for this transaction.
  action.process_payment_intent.process_config.tipping.amount_eligiblenullable integer
  Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).

action.process_setup_intentnullable object
Payload required to process a SetupIntent. Only present if type is process_setup_intent.
- action.process_setup_intent.generated_cardnullable string
  ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
- action.process_setup_intent.process_confignullable object
  Configuration for the reader to process the SetupIntent.
  action.process_setup_intent.process_config.enable_customer_cancellationnullable boolean
  Enable customer-initiated cancellation when processing this SetupIntent.
- action.process_setup_intent.setup_intentstringExpandable
  Most recent SetupIntent processed by the reader.

action.refund_paymentnullable object
Payload required to refund a payment. Only present if type is refund_payment.
- action.refund_payment.amountnullable integer
  The amount being refunded.
- action.refund_payment.chargenullable stringExpandable
  Charge that is being refunded.
- action.refund_payment.metadatanullable object
  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.
- action.refund_payment.payment_intentnullable stringExpandable
  Payment intent that is being refunded.
- action.refund_payment.reasonnullable enum
  The reason for the refund.
  Possible enum values
  duplicate
  fraudulent
  requested_by_customer
- action.refund_payment.refundnullable stringExpandable
  Unique identifier for the refund object.
- action.refund_payment.refund_application_feenullable boolean
  Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
- action.refund_payment.refund_payment_confignullable object
  Per-transaction overrides of Terminal reader configurations.
  action.refund_payment.refund_payment_config.enable_customer_cancellationnullable boolean
  Enable customer-initiated cancellation when refunding this payment.
- action.refund_payment.reverse_transfernullable boolean
  Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.

action.set_reader_displaynullable object
Payload required to set the reader display. Only present if type is set_reader_display.
- action.set_reader_display.cartnullable object
  Cart object to be displayed by the reader.
  action.set_reader_display.cart.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
  action.set_reader_display.cart.line_itemsarray of objects
  List of line items in the cart.
  action.set_reader_display.cart.line_items.amountinteger
  The amount of the line item. A positive integer in the smallest currency unit.
  action.set_reader_display.cart.line_items.descriptionstring
  Description of the line item.
  action.set_reader_display.cart.line_items.quantityinteger
  The quantity of the line item.
  action.set_reader_display.cart.taxnullable integer
  Tax amount for the entire cart. A positive integer in the smallest currency unit.
  action.set_reader_display.cart.totalinteger
  Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.
- action.set_reader_display.typeenum
  Type of information to be displayed by the reader.
  Possible enum values
  cart

action.statusenum
Status of the action performed by the reader.
Possible enum values
failed
Reader action completed with a failed outcome.
in_progress
Reader action is currently active on the Reader.
succeeded
Reader action completed with a successful outcome.

action.typeenum

Type of action performed by the reader.

Possible enum values

collect_inputs

Reader action to collect customer input.

collect_payment_method

Reader action to collect a PaymentMethod.

confirm_payment_intent

Reader action to confirm a PaymentIntent.

process_payment_intent

Reader action to process a PaymentIntent.

process_setup_intent

Reader action to process a SetupIntent.

refund_payment

Reader action to refund a payment.

set_reader_display

Reader action to display information such as shopping cart details.

device_sw_versionnullable string
The current software version of the reader.

ip_addressnullable string
The local IP address of the reader.

last_seen_atnullable integerPreview feature
The last time this reader reported to Stripe backend.

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

The Reader object

{
  "id": "tmr_FDOt2wlRZEdpd7",
  "object": "terminal.reader",
  "action": null,
  "device_sw_version": "",
  "device_type": "simulated_wisepos_e",
  "ip_address": "0.0.0.0",
  "label": "Blue Rabbit",
  "last_seen_at": 1681320543815,
  "livemode": false,
  "location": "tml_FDOtHwxAAdIJOh",
  "metadata": {},
  "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7",
  "status": "online"
}

The Reader object

Attributes

idstring

device_typeenum

labelstring

locationnullable stringExpandable

metadataobject

serial_numberstring

statusnullable enum

More attributesCollapse all

objectstring

actionnullable object

action.collect_inputsnullable objectPreview feature

action.collect_inputs.inputsarray of objects

action.collect_inputs.inputs.custom_textnullable object

action.collect_inputs.inputs.custom_text.descriptionnullable string

action.collect_inputs.inputs.custom_text.skip_buttonnullable string

action.collect_inputs.inputs.custom_text.submit_buttonnullable string

action.collect_inputs.inputs.custom_text.titlenullable string

action.collect_inputs.inputs.emailnullable object

action.collect_inputs.inputs.email.valuenullable string

action.collect_inputs.inputs.numericnullable object

action.collect_inputs.inputs.numeric.valuenullable string

action.collect_inputs.inputs.phonenullable object

action.collect_inputs.inputs.phone.valuenullable string

action.collect_inputs.inputs.requirednullable boolean

action.collect_inputs.inputs.selectionnullable object

action.collect_inputs.inputs.selection.idnullable string

action.collect_inputs.inputs.selection.choicesarray of objects

action.collect_inputs.inputs.selection.choices.idnullable string

action.collect_inputs.inputs.selection.choices.stylenullable enum

action.collect_inputs.inputs.selection.choices.textstring

action.collect_inputs.inputs.selection.textnullable string

action.collect_inputs.inputs.signaturenullable object

action.collect_inputs.inputs.signature.valuenullable string

action.collect_inputs.inputs.skippednullable boolean

action.collect_inputs.inputs.textnullable object

action.collect_inputs.inputs.text.valuenullable string

action.collect_inputs.inputs.togglesnullable array of objects

action.collect_inputs.inputs.toggles.default_valuenullable enum

action.collect_inputs.inputs.toggles.descriptionnullable string

action.collect_inputs.inputs.toggles.titlenullable string

action.collect_inputs.inputs.toggles.valuenullable enum

action.collect_inputs.inputs.typeenum

action.collect_inputs.metadatanullable object

action.collect_payment_methodnullable object

action.collect_payment_method.collect_confignullable object

action.collect_payment_method.collect_config.enable_customer_cancellationnullable boolean

action.collect_payment_method.collect_config.skip_tippingnullable boolean

action.collect_payment_method.collect_config.tippingnullable object

action.collect_payment_method.collect_config.tipping.amount_eligiblenullable integer

action.collect_payment_method.payment_intentstringExpandable

action.collect_payment_method.payment_methodnullable object

action.collect_payment_method.payment_method.idstring

action.collect_payment_method.payment_method.objectstring

action.collect_payment_method.payment_method.acss_debitnullable object

action.collect_payment_method.payment_method.acss_debit.bank_namenullable string

action.collect_payment_method.payment_method.acss_debit.fingerprintnullable string

action.collect_payment_method.payment_method.acss_debit.institution_numbernullable string

action.collect_payment_method.payment_method.acss_debit.last4nullable string

action.collect_payment_method.payment_method.acss_debit.transit_numbernullable string

action.collect_payment_method.payment_method.affirmnullable object

action.collect_payment_method.payment_method.afterpay_clearpaynullable object

action.collect_payment_method.payment_method.alipaynullable object

action.collect_payment_method.payment_method.allow_redisplaynullable enum

action.collect_payment_method.payment_method.almanullable object

action.collect_payment_method.payment_method.amazon_paynullable object

action.collect_payment_method.payment_method.au_becs_debitnullable object

action.collect_payment_method.payment_method.au_becs_debit.bsb_numbernullable string

action.collect_payment_method.payment_method.au_becs_debit.fingerprintnullable string

action.collect_payment_method.payment_method.au_becs_debit.last4nullable string

action.collect_payment_method.payment_method.bacs_debitnullable object

action.collect_payment_method.payment_method.bacs_debit.fingerprintnullable string

action.collect_payment_method.payment_method.bacs_debit.last4nullable string

action.collect_payment_method.payment_method.bacs_debit.sort_codenullable string

action.collect_payment_method.payment_method.bancontactnullable object

action.collect_payment_method.payment_method.billienullable object

action.collect_payment_method.payment_method.billing_detailsobject

action.collect_payment_method.payment_method.billing_details.addressnullable object

action.collect_payment_method.payment_method.billing_details.address.citynullable string

More attributes