TerminalReader

Stripe 0.3.0, Aug 14 26

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

Create TerminalReader Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TerminalReader(name: string, args: TerminalReaderArgs, opts?: CustomResourceOptions);

@overload
def TerminalReader(resource_name: str,
                   args: TerminalReaderArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def TerminalReader(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   registration_code: Optional[str] = None,
                   label: Optional[str] = None,
                   location: Optional[str] = None,
                   metadata: Optional[Mapping[str, str]] = None)

func NewTerminalReader(ctx *Context, name string, args TerminalReaderArgs, opts ...ResourceOption) (*TerminalReader, error)

public TerminalReader(string name, TerminalReaderArgs args, CustomResourceOptions? opts = null)

public TerminalReader(String name, TerminalReaderArgs args)
public TerminalReader(String name, TerminalReaderArgs args, CustomResourceOptions options)

type: stripe:TerminalReader
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "stripe_terminal_reader" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args TerminalReaderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args TerminalReaderArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TerminalReaderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TerminalReaderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TerminalReaderArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var terminalReaderResource = new Stripe.TerminalReader("terminalReaderResource", new()
{
    RegistrationCode = "string",
    Label = "string",
    Location = "string",
    Metadata = 
    {
        { "string", "string" },
    },
});

example, err := stripe.NewTerminalReader(ctx, "terminalReaderResource", &stripe.TerminalReaderArgs{
	RegistrationCode: pulumi.String("string"),
	Label:            pulumi.String("string"),
	Location:         pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

resource "stripe_terminal_reader" "terminalReaderResource" {
  lifecycle {
    create_before_destroy = true
  }
  registration_code = "string"
  label             = "string"
  location          = "string"
  metadata = {
    "string" = "string"
  }
}

var terminalReaderResource = new TerminalReader("terminalReaderResource", TerminalReaderArgs.builder()
    .registrationCode("string")
    .label("string")
    .location("string")
    .metadata(Map.of("string", "string"))
    .build());

terminal_reader_resource = stripe.TerminalReader("terminalReaderResource",
    registration_code="string",
    label="string",
    location="string",
    metadata={
        "string": "string",
    })

const terminalReaderResource = new stripe.TerminalReader("terminalReaderResource", {
    registrationCode: "string",
    label: "string",
    location: "string",
    metadata: {
        string: "string",
    },
});

type: stripe:TerminalReader
properties:
    label: string
    location: string
    metadata:
        string: string
    registrationCode: string

TerminalReader Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TerminalReader resource accepts the following input properties:

RegistrationCode string: A code generated by the reader used for registering to an account.
Label string: Custom label given to the reader for easier identification.
Location string: The location identifier of the reader.
Metadata Dictionary<string, string>: 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.

RegistrationCode string: A code generated by the reader used for registering to an account.
Label string: Custom label given to the reader for easier identification.
Location string: The location identifier of the reader.
Metadata map[string]string: 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.

registration_code string: A code generated by the reader used for registering to an account.
label string: Custom label given to the reader for easier identification.
location string: The location identifier of the reader.
metadata map(string): 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.

registrationCode String: A code generated by the reader used for registering to an account.
label String: Custom label given to the reader for easier identification.
location String: The location identifier of the reader.
metadata Map<String,String>: 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.

registrationCode string: A code generated by the reader used for registering to an account.
label string: Custom label given to the reader for easier identification.
location string: The location identifier of the reader.
metadata {[key: string]: string}: 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.

registration_code str: A code generated by the reader used for registering to an account.
label str: Custom label given to the reader for easier identification.
location str: The location identifier of the reader.
metadata Mapping[str, str]: 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.

registrationCode String: A code generated by the reader used for registering to an account.
label String: Custom label given to the reader for easier identification.
location String: The location identifier of the reader.
metadata Map<String>: 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the TerminalReader resource produces the following output properties:

Action TerminalReaderAction: The most recent action performed by the reader.
DeviceSwVersion string: The current software version of the reader.
DeviceType string: Device type of the reader.
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string: The local IP address of the reader.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Object string: String representing the object's type. Objects of the same type share the same value.
SerialNumber string: Serial number of the reader.
Status string: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

Action TerminalReaderAction: The most recent action performed by the reader.
DeviceSwVersion string: The current software version of the reader.
DeviceType string: Device type of the reader.
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string: The local IP address of the reader.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Object string: String representing the object's type. Objects of the same type share the same value.
SerialNumber string: Serial number of the reader.
Status string: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action object: The most recent action performed by the reader.
device_sw_version string: The current software version of the reader.
device_type string: Device type of the reader.
id string: The provider-assigned unique ID for this managed resource.
ip_address string: The local IP address of the reader.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object string: String representing the object's type. Objects of the same type share the same value.
serial_number string: Serial number of the reader.
status string: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action TerminalReaderAction: The most recent action performed by the reader.
deviceSwVersion String: The current software version of the reader.
deviceType String: Device type of the reader.
id String: The provider-assigned unique ID for this managed resource.
ipAddress String: The local IP address of the reader.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object String: String representing the object's type. Objects of the same type share the same value.
serialNumber String: Serial number of the reader.
status String: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action TerminalReaderAction: The most recent action performed by the reader.
deviceSwVersion string: The current software version of the reader.
deviceType string: Device type of the reader.
id string: The provider-assigned unique ID for this managed resource.
ipAddress string: The local IP address of the reader.
livemode boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object string: String representing the object's type. Objects of the same type share the same value.
serialNumber string: Serial number of the reader.
status string: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action TerminalReaderAction: The most recent action performed by the reader.
device_sw_version str: The current software version of the reader.
device_type str: Device type of the reader.
id str: The provider-assigned unique ID for this managed resource.
ip_address str: The local IP address of the reader.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object str: String representing the object's type. Objects of the same type share the same value.
serial_number str: Serial number of the reader.
status str: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action Property Map: The most recent action performed by the reader.
deviceSwVersion String: The current software version of the reader.
deviceType String: Device type of the reader.
id String: The provider-assigned unique ID for this managed resource.
ipAddress String: The local IP address of the reader.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object String: String representing the object's type. Objects of the same type share the same value.
serialNumber String: Serial number of the reader.
status String: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

Look up Existing TerminalReader Resource

Get an existing TerminalReader resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TerminalReaderState, opts?: CustomResourceOptions): TerminalReader

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[TerminalReaderActionArgs] = None,
        device_sw_version: Optional[str] = None,
        device_type: Optional[str] = None,
        ip_address: Optional[str] = None,
        label: Optional[str] = None,
        livemode: Optional[bool] = None,
        location: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        object: Optional[str] = None,
        registration_code: Optional[str] = None,
        serial_number: Optional[str] = None,
        status: Optional[str] = None) -> TerminalReader

func GetTerminalReader(ctx *Context, name string, id IDInput, state *TerminalReaderState, opts ...ResourceOption) (*TerminalReader, error)

public static TerminalReader Get(string name, Input<string> id, TerminalReaderState? state, CustomResourceOptions? opts = null)

public static TerminalReader get(String name, Output<String> id, TerminalReaderState state, CustomResourceOptions options)

resources:  _:    type: stripe:TerminalReader    get:      id: ${id}

import {
  to = stripe_terminal_reader.example
  id = "${id}"
}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Action TerminalReaderAction: The most recent action performed by the reader.
DeviceSwVersion string: The current software version of the reader.
DeviceType string: Device type of the reader.
IpAddress string: The local IP address of the reader.
Label string: Custom label given to the reader for easier identification.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Location string: The location identifier of the reader.
Metadata Dictionary<string, string>: 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.
Object string: String representing the object's type. Objects of the same type share the same value.
RegistrationCode string: A code generated by the reader used for registering to an account.
SerialNumber string: Serial number of the reader.
Status string: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

Action TerminalReaderActionArgs: The most recent action performed by the reader.
DeviceSwVersion string: The current software version of the reader.
DeviceType string: Device type of the reader.
IpAddress string: The local IP address of the reader.
Label string: Custom label given to the reader for easier identification.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Location string: The location identifier of the reader.
Metadata map[string]string: 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.
Object string: String representing the object's type. Objects of the same type share the same value.
RegistrationCode string: A code generated by the reader used for registering to an account.
SerialNumber string: Serial number of the reader.
Status string: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action object: The most recent action performed by the reader.
device_sw_version string: The current software version of the reader.
device_type string: Device type of the reader.
ip_address string: The local IP address of the reader.
label string: Custom label given to the reader for easier identification.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
location string: The location identifier of the reader.
metadata map(string): 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.
object string: String representing the object's type. Objects of the same type share the same value.
registration_code string: A code generated by the reader used for registering to an account.
serial_number string: Serial number of the reader.
status string: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action TerminalReaderAction: The most recent action performed by the reader.
deviceSwVersion String: The current software version of the reader.
deviceType String: Device type of the reader.
ipAddress String: The local IP address of the reader.
label String: Custom label given to the reader for easier identification.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
location String: The location identifier of the reader.
metadata Map<String,String>: 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.
object String: String representing the object's type. Objects of the same type share the same value.
registrationCode String: A code generated by the reader used for registering to an account.
serialNumber String: Serial number of the reader.
status String: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action TerminalReaderAction: The most recent action performed by the reader.
deviceSwVersion string: The current software version of the reader.
deviceType string: Device type of the reader.
ipAddress string: The local IP address of the reader.
label string: Custom label given to the reader for easier identification.
livemode boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
location string: The location identifier of the reader.
metadata {[key: string]: string}: 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.
object string: String representing the object's type. Objects of the same type share the same value.
registrationCode string: A code generated by the reader used for registering to an account.
serialNumber string: Serial number of the reader.
status string: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action TerminalReaderActionArgs: The most recent action performed by the reader.
device_sw_version str: The current software version of the reader.
device_type str: Device type of the reader.
ip_address str: The local IP address of the reader.
label str: Custom label given to the reader for easier identification.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
location str: The location identifier of the reader.
metadata Mapping[str, str]: 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.
object str: String representing the object's type. Objects of the same type share the same value.
registration_code str: A code generated by the reader used for registering to an account.
serial_number str: Serial number of the reader.
status str: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

action Property Map: The most recent action performed by the reader.
deviceSwVersion String: The current software version of the reader.
deviceType String: Device type of the reader.
ipAddress String: The local IP address of the reader.
label String: Custom label given to the reader for easier identification.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
location String: The location identifier of the reader.
metadata Map<String>: 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.
object String: String representing the object's type. Objects of the same type share the same value.
registrationCode String: A code generated by the reader used for registering to an account.
serialNumber String: Serial number of the reader.
status String: The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

Supporting Types

TerminalReaderAction, TerminalReaderActionArgs

ApiError TerminalReaderActionApiError: The reader action failed due to an API error. Only present when status is failed and the underlying failure was an API error. Avoid parsing the message field for programmatic logic; use type or code instead. The message field is for display to humans only and may be updated at anytime. Requires reader version 2.42 or later. Readers on older versions always return null.
CollectInputs TerminalReaderActionCollectInputs: Represents a reader action to collect customer inputs
CollectPaymentMethod TerminalReaderActionCollectPaymentMethod: Represents a reader action to collect a payment method
ConfirmPaymentIntent TerminalReaderActionConfirmPaymentIntent: Represents a reader action to confirm a payment
FailureCode string: Failure code, only set if status is failed.
FailureMessage string: Detailed failure message, only set if status is failed.
PrintContent TerminalReaderActionPrintContent: Represents a reader action to print content
ProcessPaymentIntent TerminalReaderActionProcessPaymentIntent: Represents a reader action to process a payment intent
ProcessSetupIntent TerminalReaderActionProcessSetupIntent: Represents a reader action to process a setup intent
RefundPayment TerminalReaderActionRefundPayment: Represents a reader action to refund a payment
SetReaderDisplay TerminalReaderActionSetReaderDisplay: Represents a reader action to set the reader display
Status string: Status of the action performed by the reader.
Type string: Type of action performed by the reader.

ApiError TerminalReaderActionApiError: The reader action failed due to an API error. Only present when status is failed and the underlying failure was an API error. Avoid parsing the message field for programmatic logic; use type or code instead. The message field is for display to humans only and may be updated at anytime. Requires reader version 2.42 or later. Readers on older versions always return null.
CollectInputs TerminalReaderActionCollectInputs: Represents a reader action to collect customer inputs
CollectPaymentMethod TerminalReaderActionCollectPaymentMethod: Represents a reader action to collect a payment method
ConfirmPaymentIntent TerminalReaderActionConfirmPaymentIntent: Represents a reader action to confirm a payment
FailureCode string: Failure code, only set if status is failed.
FailureMessage string: Detailed failure message, only set if status is failed.
PrintContent TerminalReaderActionPrintContent: Represents a reader action to print content
ProcessPaymentIntent TerminalReaderActionProcessPaymentIntent: Represents a reader action to process a payment intent
ProcessSetupIntent TerminalReaderActionProcessSetupIntent: Represents a reader action to process a setup intent
RefundPayment TerminalReaderActionRefundPayment: Represents a reader action to refund a payment
SetReaderDisplay TerminalReaderActionSetReaderDisplay: Represents a reader action to set the reader display
Status string: Status of the action performed by the reader.
Type string: Type of action performed by the reader.

api_error object: The reader action failed due to an API error. Only present when status is failed and the underlying failure was an API error. Avoid parsing the message field for programmatic logic; use type or code instead. The message field is for display to humans only and may be updated at anytime. Requires reader version 2.42 or later. Readers on older versions always return null.
collect_inputs object: Represents a reader action to collect customer inputs
collect_payment_method object: Represents a reader action to collect a payment method
confirm_payment_intent object: Represents a reader action to confirm a payment
failure_code string: Failure code, only set if status is failed.
failure_message string: Detailed failure message, only set if status is failed.
print_content object: Represents a reader action to print content
process_payment_intent object: Represents a reader action to process a payment intent
process_setup_intent object: Represents a reader action to process a setup intent
refund_payment object: Represents a reader action to refund a payment
set_reader_display object: Represents a reader action to set the reader display
status string: Status of the action performed by the reader.
type string: Type of action performed by the reader.

apiError TerminalReaderActionApiError: The reader action failed due to an API error. Only present when status is failed and the underlying failure was an API error. Avoid parsing the message field for programmatic logic; use type or code instead. The message field is for display to humans only and may be updated at anytime. Requires reader version 2.42 or later. Readers on older versions always return null.
collectInputs TerminalReaderActionCollectInputs: Represents a reader action to collect customer inputs
collectPaymentMethod TerminalReaderActionCollectPaymentMethod: Represents a reader action to collect a payment method
confirmPaymentIntent TerminalReaderActionConfirmPaymentIntent: Represents a reader action to confirm a payment
failureCode String: Failure code, only set if status is failed.
failureMessage String: Detailed failure message, only set if status is failed.
printContent TerminalReaderActionPrintContent: Represents a reader action to print content
processPaymentIntent TerminalReaderActionProcessPaymentIntent: Represents a reader action to process a payment intent
processSetupIntent TerminalReaderActionProcessSetupIntent: Represents a reader action to process a setup intent
refundPayment TerminalReaderActionRefundPayment: Represents a reader action to refund a payment
setReaderDisplay TerminalReaderActionSetReaderDisplay: Represents a reader action to set the reader display
status String: Status of the action performed by the reader.
type String: Type of action performed by the reader.

apiError TerminalReaderActionApiError: The reader action failed due to an API error. Only present when status is failed and the underlying failure was an API error. Avoid parsing the message field for programmatic logic; use type or code instead. The message field is for display to humans only and may be updated at anytime. Requires reader version 2.42 or later. Readers on older versions always return null.
collectInputs TerminalReaderActionCollectInputs: Represents a reader action to collect customer inputs
collectPaymentMethod TerminalReaderActionCollectPaymentMethod: Represents a reader action to collect a payment method
confirmPaymentIntent TerminalReaderActionConfirmPaymentIntent: Represents a reader action to confirm a payment
failureCode string: Failure code, only set if status is failed.
failureMessage string: Detailed failure message, only set if status is failed.
printContent TerminalReaderActionPrintContent: Represents a reader action to print content
processPaymentIntent TerminalReaderActionProcessPaymentIntent: Represents a reader action to process a payment intent
processSetupIntent TerminalReaderActionProcessSetupIntent: Represents a reader action to process a setup intent
refundPayment TerminalReaderActionRefundPayment: Represents a reader action to refund a payment
setReaderDisplay TerminalReaderActionSetReaderDisplay: Represents a reader action to set the reader display
status string: Status of the action performed by the reader.
type string: Type of action performed by the reader.

api_error TerminalReaderActionApiError: The reader action failed due to an API error. Only present when status is failed and the underlying failure was an API error. Avoid parsing the message field for programmatic logic; use type or code instead. The message field is for display to humans only and may be updated at anytime. Requires reader version 2.42 or later. Readers on older versions always return null.
collect_inputs TerminalReaderActionCollectInputs: Represents a reader action to collect customer inputs
collect_payment_method TerminalReaderActionCollectPaymentMethod: Represents a reader action to collect a payment method
confirm_payment_intent TerminalReaderActionConfirmPaymentIntent: Represents a reader action to confirm a payment
failure_code str: Failure code, only set if status is failed.
failure_message str: Detailed failure message, only set if status is failed.
print_content TerminalReaderActionPrintContent: Represents a reader action to print content
process_payment_intent TerminalReaderActionProcessPaymentIntent: Represents a reader action to process a payment intent
process_setup_intent TerminalReaderActionProcessSetupIntent: Represents a reader action to process a setup intent
refund_payment TerminalReaderActionRefundPayment: Represents a reader action to refund a payment
set_reader_display TerminalReaderActionSetReaderDisplay: Represents a reader action to set the reader display
status str: Status of the action performed by the reader.
type str: Type of action performed by the reader.

apiError Property Map: The reader action failed due to an API error. Only present when status is failed and the underlying failure was an API error. Avoid parsing the message field for programmatic logic; use type or code instead. The message field is for display to humans only and may be updated at anytime. Requires reader version 2.42 or later. Readers on older versions always return null.
collectInputs Property Map: Represents a reader action to collect customer inputs
collectPaymentMethod Property Map: Represents a reader action to collect a payment method
confirmPaymentIntent Property Map: Represents a reader action to confirm a payment
failureCode String: Failure code, only set if status is failed.
failureMessage String: Detailed failure message, only set if status is failed.
printContent Property Map: Represents a reader action to print content
processPaymentIntent Property Map: Represents a reader action to process a payment intent
processSetupIntent Property Map: Represents a reader action to process a setup intent
refundPayment Property Map: Represents a reader action to refund a payment
setReaderDisplay Property Map: Represents a reader action to set the reader display
status String: Status of the action performed by the reader.
type String: Type of action performed by the reader.

TerminalReaderActionApiError, TerminalReaderActionApiErrorArgs

AdviceCode string

For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.

Charge string

For card errors, the ID of the failed charge.

Code string

For some errors that could be handled programmatically, a short string indicating the error code reported.

DeclineCode string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

DocUrl string

A URL to more information about the error code reported.

Message string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

NetworkAdviceCode string

For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.

NetworkDeclineCode string

For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.

Param string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

PaymentIntent string

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

PaymentMethod string

PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

PaymentMethodType string

If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

RequestLogUrl string

A URL to the request log entry in your dashboard.

SetupIntent string

A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

Related guide: Setup Intents API

Source string

Type string

The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

AdviceCode string

For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.

Charge string

For card errors, the ID of the failed charge.

Code string

For some errors that could be handled programmatically, a short string indicating the error code reported.

DeclineCode string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

DocUrl string

A URL to more information about the error code reported.

Message string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

NetworkAdviceCode string

For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.

NetworkDeclineCode string

For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.

Param string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

PaymentIntent string

PaymentMethod string

Related guides: Payment Methods and More Payment Scenarios.

PaymentMethodType string

If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

RequestLogUrl string

A URL to the request log entry in your dashboard.

SetupIntent string

By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

Related guide: Setup Intents API

Source string

Type string

The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

advice_code string

For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.

charge string

For card errors, the ID of the failed charge.

code string

For some errors that could be handled programmatically, a short string indicating the error code reported.

decline_code string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

doc_url string

A URL to more information about the error code reported.

message string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

network_advice_code string

For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.

network_decline_code string

For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.

param string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

payment_intent string

payment_method string

Related guides: Payment Methods and More Payment Scenarios.

payment_method_type string

If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

request_log_url string

A URL to the request log entry in your dashboard.

setup_intent string

By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

Related guide: Setup Intents API

source string

type string

The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

adviceCode String

For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.

charge String

For card errors, the ID of the failed charge.

code String

For some errors that could be handled programmatically, a short string indicating the error code reported.

declineCode String

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

docUrl String

A URL to more information about the error code reported.

message String

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

networkAdviceCode String

For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.

networkDeclineCode String

For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.

param String

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

paymentIntent String

paymentMethod String

Related guides: Payment Methods and More Payment Scenarios.

paymentMethodType String

If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

requestLogUrl String

A URL to the request log entry in your dashboard.

setupIntent String

By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

Related guide: Setup Intents API

source String

type String

The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

adviceCode string

For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.

charge string

For card errors, the ID of the failed charge.

code string

For some errors that could be handled programmatically, a short string indicating the error code reported.

declineCode string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

docUrl string

A URL to more information about the error code reported.

message string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

networkAdviceCode string

For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.

networkDeclineCode string

For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.

param string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

paymentIntent string

paymentMethod string

Related guides: Payment Methods and More Payment Scenarios.

paymentMethodType string

If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

requestLogUrl string

A URL to the request log entry in your dashboard.

setupIntent string

By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

Related guide: Setup Intents API

source string

type string

The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

advice_code str

For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.

charge str

For card errors, the ID of the failed charge.

code str

For some errors that could be handled programmatically, a short string indicating the error code reported.

decline_code str

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

doc_url str

A URL to more information about the error code reported.

message str

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

network_advice_code str

For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.

network_decline_code str

For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.

param str

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

payment_intent str

payment_method str

Related guides: Payment Methods and More Payment Scenarios.

payment_method_type str

If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

request_log_url str

A URL to the request log entry in your dashboard.

setup_intent str

By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

Related guide: Setup Intents API

source str

type str

The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

adviceCode String

For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.

charge String

For card errors, the ID of the failed charge.

code String

For some errors that could be handled programmatically, a short string indicating the error code reported.

declineCode String

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

docUrl String

A URL to more information about the error code reported.

message String

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

networkAdviceCode String

For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.

networkDeclineCode String

For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.

param String

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

paymentIntent String

paymentMethod String

Related guides: Payment Methods and More Payment Scenarios.

paymentMethodType String

If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

requestLogUrl String

A URL to the request log entry in your dashboard.

setupIntent String

By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

Related guide: Setup Intents API

source String

type String

The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

TerminalReaderActionCollectInputs, TerminalReaderActionCollectInputsArgs

Inputs List<TerminalReaderActionCollectInputsInput>: List of inputs to be collected.
Metadata Dictionary<string, string>: 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.

Inputs []TerminalReaderActionCollectInputsInputType: List of inputs to be collected.
Metadata map[string]string: 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.

inputs list(object): List of inputs to be collected.
metadata map(string): 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.

inputs List<TerminalReaderActionCollectInputsInput>: List of inputs to be collected.
metadata Map<String,String>: 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.

inputs TerminalReaderActionCollectInputsInput[]: List of inputs to be collected.
metadata {[key: string]: string}: 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.

inputs Sequence[TerminalReaderActionCollectInputsInput]: List of inputs to be collected.
metadata Mapping[str, str]: 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.

inputs List<Property Map>: List of inputs to be collected.
metadata Map<String>: 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.

TerminalReaderActionCollectInputsInput, TerminalReaderActionCollectInputsInputArgs

CustomText TerminalReaderActionCollectInputsInputCustomText: Default text of input being collected.
Email TerminalReaderActionCollectInputsInputEmail: Information about a email being collected using a reader
Numeric TerminalReaderActionCollectInputsInputNumeric: Information about a number being collected using a reader
Phone TerminalReaderActionCollectInputsInputPhone: Information about a phone number being collected using a reader
Required bool: Indicate that this input is required, disabling the skip button.
Selection TerminalReaderActionCollectInputsInputSelection: Information about a selection being collected using a reader
Signature TerminalReaderActionCollectInputsInputSignature: Information about a signature being collected using a reader
Skipped bool: Indicate that this input was skipped by the user.
Text TerminalReaderActionCollectInputsInputText: Information about text being collected using a reader
Toggles List<TerminalReaderActionCollectInputsInputToggle>: List of toggles being collected. Values are present if collection is complete.
Type string: Type of input being collected.

CustomText TerminalReaderActionCollectInputsInputCustomText: Default text of input being collected.
Email TerminalReaderActionCollectInputsInputEmail: Information about a email being collected using a reader
Numeric TerminalReaderActionCollectInputsInputNumeric: Information about a number being collected using a reader
Phone TerminalReaderActionCollectInputsInputPhone: Information about a phone number being collected using a reader
Required bool: Indicate that this input is required, disabling the skip button.
Selection TerminalReaderActionCollectInputsInputSelection: Information about a selection being collected using a reader
Signature TerminalReaderActionCollectInputsInputSignature: Information about a signature being collected using a reader
Skipped bool: Indicate that this input was skipped by the user.
Text TerminalReaderActionCollectInputsInputText: Information about text being collected using a reader
Toggles []TerminalReaderActionCollectInputsInputToggle: List of toggles being collected. Values are present if collection is complete.
Type string: Type of input being collected.

custom_text object: Default text of input being collected.
email object: Information about a email being collected using a reader
numeric object: Information about a number being collected using a reader
phone object: Information about a phone number being collected using a reader
required bool: Indicate that this input is required, disabling the skip button.
selection object: Information about a selection being collected using a reader
signature object: Information about a signature being collected using a reader
skipped bool: Indicate that this input was skipped by the user.
text object: Information about text being collected using a reader
toggles list(object): List of toggles being collected. Values are present if collection is complete.
type string: Type of input being collected.

customText TerminalReaderActionCollectInputsInputCustomText: Default text of input being collected.
email TerminalReaderActionCollectInputsInputEmail: Information about a email being collected using a reader
numeric TerminalReaderActionCollectInputsInputNumeric: Information about a number being collected using a reader
phone TerminalReaderActionCollectInputsInputPhone: Information about a phone number being collected using a reader
required Boolean: Indicate that this input is required, disabling the skip button.
selection TerminalReaderActionCollectInputsInputSelection: Information about a selection being collected using a reader
signature TerminalReaderActionCollectInputsInputSignature: Information about a signature being collected using a reader
skipped Boolean: Indicate that this input was skipped by the user.
text TerminalReaderActionCollectInputsInputText: Information about text being collected using a reader
toggles List<TerminalReaderActionCollectInputsInputToggle>: List of toggles being collected. Values are present if collection is complete.
type String: Type of input being collected.

customText TerminalReaderActionCollectInputsInputCustomText: Default text of input being collected.
email TerminalReaderActionCollectInputsInputEmail: Information about a email being collected using a reader
numeric TerminalReaderActionCollectInputsInputNumeric: Information about a number being collected using a reader
phone TerminalReaderActionCollectInputsInputPhone: Information about a phone number being collected using a reader
required boolean: Indicate that this input is required, disabling the skip button.
selection TerminalReaderActionCollectInputsInputSelection: Information about a selection being collected using a reader
signature TerminalReaderActionCollectInputsInputSignature: Information about a signature being collected using a reader
skipped boolean: Indicate that this input was skipped by the user.
text TerminalReaderActionCollectInputsInputText: Information about text being collected using a reader
toggles TerminalReaderActionCollectInputsInputToggle[]: List of toggles being collected. Values are present if collection is complete.
type string: Type of input being collected.

custom_text TerminalReaderActionCollectInputsInputCustomText: Default text of input being collected.
email TerminalReaderActionCollectInputsInputEmail: Information about a email being collected using a reader
numeric TerminalReaderActionCollectInputsInputNumeric: Information about a number being collected using a reader
phone TerminalReaderActionCollectInputsInputPhone: Information about a phone number being collected using a reader
required bool: Indicate that this input is required, disabling the skip button.
selection TerminalReaderActionCollectInputsInputSelection: Information about a selection being collected using a reader
signature TerminalReaderActionCollectInputsInputSignature: Information about a signature being collected using a reader
skipped bool: Indicate that this input was skipped by the user.
text TerminalReaderActionCollectInputsInputText: Information about text being collected using a reader
toggles Sequence[TerminalReaderActionCollectInputsInputToggle]: List of toggles being collected. Values are present if collection is complete.
type str: Type of input being collected.

customText Property Map: Default text of input being collected.
email Property Map: Information about a email being collected using a reader
numeric Property Map: Information about a number being collected using a reader
phone Property Map: Information about a phone number being collected using a reader
required Boolean: Indicate that this input is required, disabling the skip button.
selection Property Map: Information about a selection being collected using a reader
signature Property Map: Information about a signature being collected using a reader
skipped Boolean: Indicate that this input was skipped by the user.
text Property Map: Information about text being collected using a reader
toggles List<Property Map>: List of toggles being collected. Values are present if collection is complete.
type String: Type of input being collected.

TerminalReaderActionCollectInputsInputCustomText, TerminalReaderActionCollectInputsInputCustomTextArgs

Description string: Customize the default description for this input
SkipButton string: Customize the default label for this input's skip button
SubmitButton string: Customize the default label for this input's submit button
Title string: Customize the default title for this input

Description string: Customize the default description for this input
SkipButton string: Customize the default label for this input's skip button
SubmitButton string: Customize the default label for this input's submit button
Title string: Customize the default title for this input

description string: Customize the default description for this input
skip_button string: Customize the default label for this input's skip button
submit_button string: Customize the default label for this input's submit button
title string: Customize the default title for this input

description String: Customize the default description for this input
skipButton String: Customize the default label for this input's skip button
submitButton String: Customize the default label for this input's submit button
title String: Customize the default title for this input

description string: Customize the default description for this input
skipButton string: Customize the default label for this input's skip button
submitButton string: Customize the default label for this input's submit button
title string: Customize the default title for this input

description str: Customize the default description for this input
skip_button str: Customize the default label for this input's skip button
submit_button str: Customize the default label for this input's submit button
title str: Customize the default title for this input

description String: Customize the default description for this input
skipButton String: Customize the default label for this input's skip button
submitButton String: Customize the default label for this input's submit button
title String: Customize the default title for this input

TerminalReaderActionCollectInputsInputEmail, TerminalReaderActionCollectInputsInputEmailArgs

Value string: The collected email address

Value string: The collected email address

value string: The collected email address

value String: The collected email address

value string: The collected email address

value str: The collected email address

value String: The collected email address

TerminalReaderActionCollectInputsInputNumeric, TerminalReaderActionCollectInputsInputNumericArgs

Value string: The collected number

Value string: The collected number

value string: The collected number

value String: The collected number

value string: The collected number

value str: The collected number

value String: The collected number

TerminalReaderActionCollectInputsInputPhone, TerminalReaderActionCollectInputsInputPhoneArgs

Value string: The collected phone number

Value string: The collected phone number

value string: The collected phone number

value String: The collected phone number

value string: The collected phone number

value str: The collected phone number

value String: The collected phone number

TerminalReaderActionCollectInputsInputSelection, TerminalReaderActionCollectInputsInputSelectionArgs

Choices List<TerminalReaderActionCollectInputsInputSelectionChoice>: List of possible choices to be selected
Id string: The id of the selected choice
Text string: The text of the selected choice

Choices []TerminalReaderActionCollectInputsInputSelectionChoice: List of possible choices to be selected
Id string: The id of the selected choice
Text string: The text of the selected choice

choices list(object): List of possible choices to be selected
id string: The id of the selected choice
text string: The text of the selected choice

choices List<TerminalReaderActionCollectInputsInputSelectionChoice>: List of possible choices to be selected
id String: The id of the selected choice
text String: The text of the selected choice

choices TerminalReaderActionCollectInputsInputSelectionChoice[]: List of possible choices to be selected
id string: The id of the selected choice
text string: The text of the selected choice

choices Sequence[TerminalReaderActionCollectInputsInputSelectionChoice]: List of possible choices to be selected
id str: The id of the selected choice
text str: The text of the selected choice

choices List<Property Map>: List of possible choices to be selected
id String: The id of the selected choice
text String: The text of the selected choice

TerminalReaderActionCollectInputsInputSelectionChoice, TerminalReaderActionCollectInputsInputSelectionChoiceArgs

Id string: The identifier for the selected choice. Maximum 50 characters.
Style string: The button style for the choice. Can be primary or secondary.
Text string: The text to be selected. Maximum 30 characters.

Id string: The identifier for the selected choice. Maximum 50 characters.
Style string: The button style for the choice. Can be primary or secondary.
Text string: The text to be selected. Maximum 30 characters.

id string: The identifier for the selected choice. Maximum 50 characters.
style string: The button style for the choice. Can be primary or secondary.
text string: The text to be selected. Maximum 30 characters.

id String: The identifier for the selected choice. Maximum 50 characters.
style String: The button style for the choice. Can be primary or secondary.
text String: The text to be selected. Maximum 30 characters.

id string: The identifier for the selected choice. Maximum 50 characters.
style string: The button style for the choice. Can be primary or secondary.
text string: The text to be selected. Maximum 30 characters.

id str: The identifier for the selected choice. Maximum 50 characters.
style str: The button style for the choice. Can be primary or secondary.
text str: The text to be selected. Maximum 30 characters.

id String: The identifier for the selected choice. Maximum 50 characters.
style String: The button style for the choice. Can be primary or secondary.
text String: The text to be selected. Maximum 30 characters.

TerminalReaderActionCollectInputsInputSignature, TerminalReaderActionCollectInputsInputSignatureArgs

Value string: The File ID of a collected signature image

Value string: The File ID of a collected signature image

value string: The File ID of a collected signature image

value String: The File ID of a collected signature image

value string: The File ID of a collected signature image

value str: The File ID of a collected signature image

value String: The File ID of a collected signature image

TerminalReaderActionCollectInputsInputText, TerminalReaderActionCollectInputsInputTextArgs

Value string: The collected text value

Value string: The collected text value

value string: The collected text value

value String: The collected text value

value string: The collected text value

value str: The collected text value

value String: The collected text value

TerminalReaderActionCollectInputsInputToggle, TerminalReaderActionCollectInputsInputToggleArgs

DefaultValue string: The toggle's default value. Can be enabled or disabled.
Description string: The toggle's description text. Maximum 50 characters.
Title string: The toggle's title text. Maximum 50 characters.
Value string: The toggle's collected value. Can be enabled or disabled.

DefaultValue string: The toggle's default value. Can be enabled or disabled.
Description string: The toggle's description text. Maximum 50 characters.
Title string: The toggle's title text. Maximum 50 characters.
Value string: The toggle's collected value. Can be enabled or disabled.

default_value string: The toggle's default value. Can be enabled or disabled.
description string: The toggle's description text. Maximum 50 characters.
title string: The toggle's title text. Maximum 50 characters.
value string: The toggle's collected value. Can be enabled or disabled.

defaultValue String: The toggle's default value. Can be enabled or disabled.
description String: The toggle's description text. Maximum 50 characters.
title String: The toggle's title text. Maximum 50 characters.
value String: The toggle's collected value. Can be enabled or disabled.

defaultValue string: The toggle's default value. Can be enabled or disabled.
description string: The toggle's description text. Maximum 50 characters.
title string: The toggle's title text. Maximum 50 characters.
value string: The toggle's collected value. Can be enabled or disabled.

default_value str: The toggle's default value. Can be enabled or disabled.
description str: The toggle's description text. Maximum 50 characters.
title str: The toggle's title text. Maximum 50 characters.
value str: The toggle's collected value. Can be enabled or disabled.

defaultValue String: The toggle's default value. Can be enabled or disabled.
description String: The toggle's description text. Maximum 50 characters.
title String: The toggle's title text. Maximum 50 characters.
value String: The toggle's collected value. Can be enabled or disabled.

TerminalReaderActionCollectPaymentMethod, TerminalReaderActionCollectPaymentMethodArgs

CollectConfig TerminalReaderActionCollectPaymentMethodCollectConfig: Represents a per-transaction override of a reader configuration
PaymentIntent string: Most recent PaymentIntent processed by the reader.
PaymentMethod string: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

CollectConfig TerminalReaderActionCollectPaymentMethodCollectConfig: Represents a per-transaction override of a reader configuration
PaymentIntent string: Most recent PaymentIntent processed by the reader.
PaymentMethod string: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

collect_config object: Represents a per-transaction override of a reader configuration
payment_intent string: Most recent PaymentIntent processed by the reader.
payment_method string: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

collectConfig TerminalReaderActionCollectPaymentMethodCollectConfig: Represents a per-transaction override of a reader configuration
paymentIntent String: Most recent PaymentIntent processed by the reader.
paymentMethod String: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

collectConfig TerminalReaderActionCollectPaymentMethodCollectConfig: Represents a per-transaction override of a reader configuration
paymentIntent string: Most recent PaymentIntent processed by the reader.
paymentMethod string: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

collect_config TerminalReaderActionCollectPaymentMethodCollectConfig: Represents a per-transaction override of a reader configuration
payment_intent str: Most recent PaymentIntent processed by the reader.
payment_method str: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

collectConfig Property Map: Represents a per-transaction override of a reader configuration
paymentIntent String: Most recent PaymentIntent processed by the reader.
paymentMethod String: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

TerminalReaderActionCollectPaymentMethodCollectConfig, TerminalReaderActionCollectPaymentMethodCollectConfigArgs

EnableCustomerCancellation bool: Enable customer-initiated cancellation when processing this payment.
SkipTipping bool: Override showing a tipping selection screen on this transaction.
Tipping TerminalReaderActionCollectPaymentMethodCollectConfigTipping: Represents a per-transaction tipping configuration

EnableCustomerCancellation bool: Enable customer-initiated cancellation when processing this payment.
SkipTipping bool: Override showing a tipping selection screen on this transaction.
Tipping TerminalReaderActionCollectPaymentMethodCollectConfigTipping: Represents a per-transaction tipping configuration

enable_customer_cancellation bool: Enable customer-initiated cancellation when processing this payment.
skip_tipping bool: Override showing a tipping selection screen on this transaction.
tipping object: Represents a per-transaction tipping configuration

enableCustomerCancellation Boolean: Enable customer-initiated cancellation when processing this payment.
skipTipping Boolean: Override showing a tipping selection screen on this transaction.
tipping TerminalReaderActionCollectPaymentMethodCollectConfigTipping: Represents a per-transaction tipping configuration

enableCustomerCancellation boolean: Enable customer-initiated cancellation when processing this payment.
skipTipping boolean: Override showing a tipping selection screen on this transaction.
tipping TerminalReaderActionCollectPaymentMethodCollectConfigTipping: Represents a per-transaction tipping configuration

enable_customer_cancellation bool: Enable customer-initiated cancellation when processing this payment.
skip_tipping bool: Override showing a tipping selection screen on this transaction.
tipping TerminalReaderActionCollectPaymentMethodCollectConfigTipping: Represents a per-transaction tipping configuration

enableCustomerCancellation Boolean: Enable customer-initiated cancellation when processing this payment.
skipTipping Boolean: Override showing a tipping selection screen on this transaction.
tipping Property Map: Represents a per-transaction tipping configuration

TerminalReaderActionCollectPaymentMethodCollectConfigTipping, TerminalReaderActionCollectPaymentMethodCollectConfigTippingArgs

AmountEligible double: 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).

AmountEligible float64: 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).

amount_eligible number: 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).

amountEligible Double: 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).

amountEligible number: 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).

amount_eligible float: 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).

amountEligible Number: 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).

TerminalReaderActionConfirmPaymentIntent, TerminalReaderActionConfirmPaymentIntentArgs

ConfirmConfig TerminalReaderActionConfirmPaymentIntentConfirmConfig: Represents a per-transaction override of a reader configuration
PaymentIntent string: Most recent PaymentIntent processed by the reader.

ConfirmConfig TerminalReaderActionConfirmPaymentIntentConfirmConfig: Represents a per-transaction override of a reader configuration
PaymentIntent string: Most recent PaymentIntent processed by the reader.

confirm_config object: Represents a per-transaction override of a reader configuration
payment_intent string: Most recent PaymentIntent processed by the reader.

confirmConfig TerminalReaderActionConfirmPaymentIntentConfirmConfig: Represents a per-transaction override of a reader configuration
paymentIntent String: Most recent PaymentIntent processed by the reader.

confirmConfig TerminalReaderActionConfirmPaymentIntentConfirmConfig: Represents a per-transaction override of a reader configuration
paymentIntent string: Most recent PaymentIntent processed by the reader.

confirm_config TerminalReaderActionConfirmPaymentIntentConfirmConfig: Represents a per-transaction override of a reader configuration
payment_intent str: Most recent PaymentIntent processed by the reader.

confirmConfig Property Map: Represents a per-transaction override of a reader configuration
paymentIntent String: Most recent PaymentIntent processed by the reader.

TerminalReaderActionConfirmPaymentIntentConfirmConfig, TerminalReaderActionConfirmPaymentIntentConfirmConfigArgs

ReturnUrl string: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.

ReturnUrl string: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.

return_url string: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.

returnUrl String: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.

returnUrl string: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.

return_url str: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.

returnUrl String: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.

TerminalReaderActionPrintContent, TerminalReaderActionPrintContentArgs

Image TerminalReaderActionPrintContentImage: Metadata of an uploaded file
Type string: The type of content to print. Currently supports image.

Image TerminalReaderActionPrintContentImage: Metadata of an uploaded file
Type string: The type of content to print. Currently supports image.

image object: Metadata of an uploaded file
type string: The type of content to print. Currently supports image.

image TerminalReaderActionPrintContentImage: Metadata of an uploaded file
type String: The type of content to print. Currently supports image.

image TerminalReaderActionPrintContentImage: Metadata of an uploaded file
type string: The type of content to print. Currently supports image.

image TerminalReaderActionPrintContentImage: Metadata of an uploaded file
type str: The type of content to print. Currently supports image.

image Property Map: Metadata of an uploaded file
type String: The type of content to print. Currently supports image.

TerminalReaderActionPrintContentImage, TerminalReaderActionPrintContentImageArgs

CreatedAt double: Creation time of the object (in seconds since the Unix epoch).
Filename string: The original name of the uploaded file (e.g. receipt.png).
Size double: The size (in bytes) of the uploaded file.
Type string: The format of the uploaded file.

CreatedAt float64: Creation time of the object (in seconds since the Unix epoch).
Filename string: The original name of the uploaded file (e.g. receipt.png).
Size float64: The size (in bytes) of the uploaded file.
Type string: The format of the uploaded file.

created_at number: Creation time of the object (in seconds since the Unix epoch).
filename string: The original name of the uploaded file (e.g. receipt.png).
size number: The size (in bytes) of the uploaded file.
type string: The format of the uploaded file.

createdAt Double: Creation time of the object (in seconds since the Unix epoch).
filename String: The original name of the uploaded file (e.g. receipt.png).
size Double: The size (in bytes) of the uploaded file.
type String: The format of the uploaded file.

createdAt number: Creation time of the object (in seconds since the Unix epoch).
filename string: The original name of the uploaded file (e.g. receipt.png).
size number: The size (in bytes) of the uploaded file.
type string: The format of the uploaded file.

created_at float: Creation time of the object (in seconds since the Unix epoch).
filename str: The original name of the uploaded file (e.g. receipt.png).
size float: The size (in bytes) of the uploaded file.
type str: The format of the uploaded file.

createdAt Number: Creation time of the object (in seconds since the Unix epoch).
filename String: The original name of the uploaded file (e.g. receipt.png).
size Number: The size (in bytes) of the uploaded file.
type String: The format of the uploaded file.

TerminalReaderActionProcessPaymentIntent, TerminalReaderActionProcessPaymentIntentArgs

PaymentIntent string: Most recent PaymentIntent processed by the reader.
ProcessConfig TerminalReaderActionProcessPaymentIntentProcessConfig: Represents a per-transaction override of a reader configuration

PaymentIntent string: Most recent PaymentIntent processed by the reader.
ProcessConfig TerminalReaderActionProcessPaymentIntentProcessConfig: Represents a per-transaction override of a reader configuration

payment_intent string: Most recent PaymentIntent processed by the reader.
process_config object: Represents a per-transaction override of a reader configuration

paymentIntent String: Most recent PaymentIntent processed by the reader.
processConfig TerminalReaderActionProcessPaymentIntentProcessConfig: Represents a per-transaction override of a reader configuration

paymentIntent string: Most recent PaymentIntent processed by the reader.
processConfig TerminalReaderActionProcessPaymentIntentProcessConfig: Represents a per-transaction override of a reader configuration

payment_intent str: Most recent PaymentIntent processed by the reader.
process_config TerminalReaderActionProcessPaymentIntentProcessConfig: Represents a per-transaction override of a reader configuration

paymentIntent String: Most recent PaymentIntent processed by the reader.
processConfig Property Map: Represents a per-transaction override of a reader configuration

TerminalReaderActionProcessPaymentIntentProcessConfig, TerminalReaderActionProcessPaymentIntentProcessConfigArgs

EnableCustomerCancellation bool: Enable customer-initiated cancellation when processing this payment.
ReturnUrl string: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
SkipTipping bool: Override showing a tipping selection screen on this transaction.
Tipping TerminalReaderActionProcessPaymentIntentProcessConfigTipping: Represents a per-transaction tipping configuration

EnableCustomerCancellation bool: Enable customer-initiated cancellation when processing this payment.
ReturnUrl string: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
SkipTipping bool: Override showing a tipping selection screen on this transaction.
Tipping TerminalReaderActionProcessPaymentIntentProcessConfigTipping: Represents a per-transaction tipping configuration

enable_customer_cancellation bool: Enable customer-initiated cancellation when processing this payment.
return_url string: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
skip_tipping bool: Override showing a tipping selection screen on this transaction.
tipping object: Represents a per-transaction tipping configuration

enableCustomerCancellation Boolean: Enable customer-initiated cancellation when processing this payment.
returnUrl String: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
skipTipping Boolean: Override showing a tipping selection screen on this transaction.
tipping TerminalReaderActionProcessPaymentIntentProcessConfigTipping: Represents a per-transaction tipping configuration

enableCustomerCancellation boolean: Enable customer-initiated cancellation when processing this payment.
returnUrl string: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
skipTipping boolean: Override showing a tipping selection screen on this transaction.
tipping TerminalReaderActionProcessPaymentIntentProcessConfigTipping: Represents a per-transaction tipping configuration

enable_customer_cancellation bool: Enable customer-initiated cancellation when processing this payment.
return_url str: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
skip_tipping bool: Override showing a tipping selection screen on this transaction.
tipping TerminalReaderActionProcessPaymentIntentProcessConfigTipping: Represents a per-transaction tipping configuration

enableCustomerCancellation Boolean: Enable customer-initiated cancellation when processing this payment.
returnUrl String: If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
skipTipping Boolean: Override showing a tipping selection screen on this transaction.
tipping Property Map: Represents a per-transaction tipping configuration

TerminalReaderActionProcessPaymentIntentProcessConfigTipping, TerminalReaderActionProcessPaymentIntentProcessConfigTippingArgs

AmountEligible double: 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).

AmountEligible float64: 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).

amount_eligible number: 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).

amountEligible Double: 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).

amountEligible number: 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).

amount_eligible float: 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).

amountEligible Number: 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).

TerminalReaderActionProcessSetupIntent, TerminalReaderActionProcessSetupIntentArgs

GeneratedCard 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.
ProcessConfig TerminalReaderActionProcessSetupIntentProcessConfig: Represents a per-setup override of a reader configuration
SetupIntent string: Most recent SetupIntent processed by the reader.

GeneratedCard 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.
ProcessConfig TerminalReaderActionProcessSetupIntentProcessConfig: Represents a per-setup override of a reader configuration
SetupIntent string: Most recent SetupIntent processed by the reader.

generated_card 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.
process_config object: Represents a per-setup override of a reader configuration
setup_intent string: Most recent SetupIntent processed by the reader.

generatedCard 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.
processConfig TerminalReaderActionProcessSetupIntentProcessConfig: Represents a per-setup override of a reader configuration
setupIntent String: Most recent SetupIntent processed by the reader.

generatedCard 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.
processConfig TerminalReaderActionProcessSetupIntentProcessConfig: Represents a per-setup override of a reader configuration
setupIntent string: Most recent SetupIntent processed by the reader.

generated_card str: 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.
process_config TerminalReaderActionProcessSetupIntentProcessConfig: Represents a per-setup override of a reader configuration
setup_intent str: Most recent SetupIntent processed by the reader.

generatedCard 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.
processConfig Property Map: Represents a per-setup override of a reader configuration
setupIntent String: Most recent SetupIntent processed by the reader.

TerminalReaderActionProcessSetupIntentProcessConfig, TerminalReaderActionProcessSetupIntentProcessConfigArgs

EnableCustomerCancellation bool: Enable customer-initiated cancellation when processing this SetupIntent.

EnableCustomerCancellation bool: Enable customer-initiated cancellation when processing this SetupIntent.

enable_customer_cancellation bool: Enable customer-initiated cancellation when processing this SetupIntent.

enableCustomerCancellation Boolean: Enable customer-initiated cancellation when processing this SetupIntent.

enableCustomerCancellation boolean: Enable customer-initiated cancellation when processing this SetupIntent.

enable_customer_cancellation bool: Enable customer-initiated cancellation when processing this SetupIntent.

enableCustomerCancellation Boolean: Enable customer-initiated cancellation when processing this SetupIntent.

TerminalReaderActionRefundPayment, TerminalReaderActionRefundPaymentArgs

Amount double: The amount being refunded.
Charge string: Charge that is being refunded.
Metadata Dictionary<string, string>: 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.
PaymentIntent string: Payment intent that is being refunded.
Reason string: The reason for the refund.
Refund string: Unique identifier for the refund object.
RefundApplicationFee bool: 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.
RefundPaymentConfig TerminalReaderActionRefundPaymentRefundPaymentConfig: Represents a per-transaction override of a reader configuration
ReverseTransfer bool: 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.

Amount float64: The amount being refunded.
Charge string: Charge that is being refunded.
Metadata map[string]string: 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.
PaymentIntent string: Payment intent that is being refunded.
Reason string: The reason for the refund.
Refund string: Unique identifier for the refund object.
RefundApplicationFee bool: 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.
RefundPaymentConfig TerminalReaderActionRefundPaymentRefundPaymentConfig: Represents a per-transaction override of a reader configuration
ReverseTransfer bool: 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.

amount number: The amount being refunded.
charge string: Charge that is being refunded.
metadata map(string): 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.
payment_intent string: Payment intent that is being refunded.
reason string: The reason for the refund.
refund string: Unique identifier for the refund object.
refund_application_fee bool: 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.
refund_payment_config object: Represents a per-transaction override of a reader configuration
reverse_transfer bool: 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.

amount Double: The amount being refunded.
charge String: Charge that is being refunded.
metadata Map<String,String>: 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.
paymentIntent String: Payment intent that is being refunded.
reason String: The reason for the refund.
refund String: Unique identifier for the refund object.
refundApplicationFee 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.
refundPaymentConfig TerminalReaderActionRefundPaymentRefundPaymentConfig: Represents a per-transaction override of a reader configuration
reverseTransfer 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.

amount number: The amount being refunded.
charge string: Charge that is being refunded.
metadata {[key: string]: string}: 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.
paymentIntent string: Payment intent that is being refunded.
reason string: The reason for the refund.
refund string: Unique identifier for the refund object.
refundApplicationFee 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.
refundPaymentConfig TerminalReaderActionRefundPaymentRefundPaymentConfig: Represents a per-transaction override of a reader configuration
reverseTransfer 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.

amount float: The amount being refunded.
charge str: Charge that is being refunded.
metadata Mapping[str, str]: 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.
payment_intent str: Payment intent that is being refunded.
reason str: The reason for the refund.
refund str: Unique identifier for the refund object.
refund_application_fee bool: 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.
refund_payment_config TerminalReaderActionRefundPaymentRefundPaymentConfig: Represents a per-transaction override of a reader configuration
reverse_transfer bool: 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.

amount Number: The amount being refunded.
charge String: Charge that is being refunded.
metadata Map<String>: 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.
paymentIntent String: Payment intent that is being refunded.
reason String: The reason for the refund.
refund String: Unique identifier for the refund object.
refundApplicationFee 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.
refundPaymentConfig Property Map: Represents a per-transaction override of a reader configuration
reverseTransfer 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.

TerminalReaderActionRefundPaymentRefundPaymentConfig, TerminalReaderActionRefundPaymentRefundPaymentConfigArgs

EnableCustomerCancellation bool: Enable customer-initiated cancellation when refunding this payment.

EnableCustomerCancellation bool: Enable customer-initiated cancellation when refunding this payment.

enable_customer_cancellation bool: Enable customer-initiated cancellation when refunding this payment.

enableCustomerCancellation Boolean: Enable customer-initiated cancellation when refunding this payment.

enableCustomerCancellation boolean: Enable customer-initiated cancellation when refunding this payment.

enable_customer_cancellation bool: Enable customer-initiated cancellation when refunding this payment.

enableCustomerCancellation Boolean: Enable customer-initiated cancellation when refunding this payment.

TerminalReaderActionSetReaderDisplay, TerminalReaderActionSetReaderDisplayArgs

Cart TerminalReaderActionSetReaderDisplayCart: Cart object to be displayed by the reader, including line items, amounts, and currency.
Type string: Type of information to be displayed by the reader. Only cart is currently supported.

Cart TerminalReaderActionSetReaderDisplayCart: Cart object to be displayed by the reader, including line items, amounts, and currency.
Type string: Type of information to be displayed by the reader. Only cart is currently supported.

cart object: Cart object to be displayed by the reader, including line items, amounts, and currency.
type string: Type of information to be displayed by the reader. Only cart is currently supported.

cart TerminalReaderActionSetReaderDisplayCart: Cart object to be displayed by the reader, including line items, amounts, and currency.
type String: Type of information to be displayed by the reader. Only cart is currently supported.

cart TerminalReaderActionSetReaderDisplayCart: Cart object to be displayed by the reader, including line items, amounts, and currency.
type string: Type of information to be displayed by the reader. Only cart is currently supported.

cart TerminalReaderActionSetReaderDisplayCart: Cart object to be displayed by the reader, including line items, amounts, and currency.
type str: Type of information to be displayed by the reader. Only cart is currently supported.

cart Property Map: Cart object to be displayed by the reader, including line items, amounts, and currency.
type String: Type of information to be displayed by the reader. Only cart is currently supported.

TerminalReaderActionSetReaderDisplayCart, TerminalReaderActionSetReaderDisplayCartArgs

Currency string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
LineItems List<TerminalReaderActionSetReaderDisplayCartLineItem>: List of line items in the cart.
Tax double: Tax amount for the entire cart. A positive integer in the smallest currency unit.
Total double: Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.

Currency string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
LineItems []TerminalReaderActionSetReaderDisplayCartLineItem: List of line items in the cart.
Tax float64: Tax amount for the entire cart. A positive integer in the smallest currency unit.
Total float64: Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.

currency string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
line_items list(object): List of line items in the cart.
tax number: Tax amount for the entire cart. A positive integer in the smallest currency unit.
total number: Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.

currency String: Three-letter ISO currency code, in lowercase. Must be a supported currency.
lineItems List<TerminalReaderActionSetReaderDisplayCartLineItem>: List of line items in the cart.
tax Double: Tax amount for the entire cart. A positive integer in the smallest currency unit.
total Double: Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.

currency string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
lineItems TerminalReaderActionSetReaderDisplayCartLineItem[]: List of line items in the cart.
tax number: Tax amount for the entire cart. A positive integer in the smallest currency unit.
total number: Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.

currency str: Three-letter ISO currency code, in lowercase. Must be a supported currency.
line_items Sequence[TerminalReaderActionSetReaderDisplayCartLineItem]: List of line items in the cart.
tax float: Tax amount for the entire cart. A positive integer in the smallest currency unit.
total float: Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.

currency String: Three-letter ISO currency code, in lowercase. Must be a supported currency.
lineItems List<Property Map>: List of line items in the cart.
tax Number: Tax amount for the entire cart. A positive integer in the smallest currency unit.
total Number: Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.

TerminalReaderActionSetReaderDisplayCartLineItem, TerminalReaderActionSetReaderDisplayCartLineItemArgs

Amount double: The amount of the line item. A positive integer in the smallest currency unit.
Description string: Description of the line item.
Quantity double: The quantity of the line item.

Amount float64: The amount of the line item. A positive integer in the smallest currency unit.
Description string: Description of the line item.
Quantity float64: The quantity of the line item.

amount number: The amount of the line item. A positive integer in the smallest currency unit.
description string: Description of the line item.
quantity number: The quantity of the line item.

amount Double: The amount of the line item. A positive integer in the smallest currency unit.
description String: Description of the line item.
quantity Double: The quantity of the line item.

amount number: The amount of the line item. A positive integer in the smallest currency unit.
description string: Description of the line item.
quantity number: The quantity of the line item.

amount float: The amount of the line item. A positive integer in the smallest currency unit.
description str: Description of the line item.
quantity float: The quantity of the line item.

amount Number: The amount of the line item. A positive integer in the smallest currency unit.
description String: Description of the line item.
quantity Number: The quantity of the line item.

Package Details

Repository: stripe stripe/terraform-provider-stripe
License
Notes: This Pulumi package is based on the stripe Terraform Provider.

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

Schema (JSON)

stripe/terraform-provider-stripe

stripe.TerminalReader

On this page

On this page

Create TerminalReader Resource

Constructor syntax

Parameters

Constructor example

TerminalReader Resource Properties

Inputs

Outputs

Look up Existing TerminalReader Resource

Supporting Types

TerminalReaderAction, TerminalReaderActionArgs

TerminalReaderActionApiError, TerminalReaderActionApiErrorArgs

TerminalReaderActionCollectInputs, TerminalReaderActionCollectInputsArgs

TerminalReaderActionCollectInputsInput, TerminalReaderActionCollectInputsInputArgs

TerminalReaderActionCollectInputsInputCustomText, TerminalReaderActionCollectInputsInputCustomTextArgs

TerminalReaderActionCollectInputsInputEmail, TerminalReaderActionCollectInputsInputEmailArgs

TerminalReaderActionCollectInputsInputNumeric, TerminalReaderActionCollectInputsInputNumericArgs

TerminalReaderActionCollectInputsInputPhone, TerminalReaderActionCollectInputsInputPhoneArgs

TerminalReaderActionCollectInputsInputSelection, TerminalReaderActionCollectInputsInputSelectionArgs

TerminalReaderActionCollectInputsInputSelectionChoice, TerminalReaderActionCollectInputsInputSelectionChoiceArgs

TerminalReaderActionCollectInputsInputSignature, TerminalReaderActionCollectInputsInputSignatureArgs

TerminalReaderActionCollectInputsInputText, TerminalReaderActionCollectInputsInputTextArgs

TerminalReaderActionCollectInputsInputToggle, TerminalReaderActionCollectInputsInputToggleArgs

TerminalReaderActionCollectPaymentMethod, TerminalReaderActionCollectPaymentMethodArgs

TerminalReaderActionCollectPaymentMethodCollectConfig, TerminalReaderActionCollectPaymentMethodCollectConfigArgs

TerminalReaderActionCollectPaymentMethodCollectConfigTipping, TerminalReaderActionCollectPaymentMethodCollectConfigTippingArgs

TerminalReaderActionConfirmPaymentIntent, TerminalReaderActionConfirmPaymentIntentArgs

TerminalReaderActionConfirmPaymentIntentConfirmConfig, TerminalReaderActionConfirmPaymentIntentConfirmConfigArgs

TerminalReaderActionPrintContent, TerminalReaderActionPrintContentArgs

TerminalReaderActionPrintContentImage, TerminalReaderActionPrintContentImageArgs

TerminalReaderActionProcessPaymentIntent, TerminalReaderActionProcessPaymentIntentArgs

TerminalReaderActionProcessPaymentIntentProcessConfig, TerminalReaderActionProcessPaymentIntentProcessConfigArgs

TerminalReaderActionProcessPaymentIntentProcessConfigTipping, TerminalReaderActionProcessPaymentIntentProcessConfigTippingArgs

TerminalReaderActionProcessSetupIntent, TerminalReaderActionProcessSetupIntentArgs

TerminalReaderActionProcessSetupIntentProcessConfig, TerminalReaderActionProcessSetupIntentProcessConfigArgs

TerminalReaderActionRefundPayment, TerminalReaderActionRefundPaymentArgs

TerminalReaderActionRefundPaymentRefundPaymentConfig, TerminalReaderActionRefundPaymentRefundPaymentConfigArgs

TerminalReaderActionSetReaderDisplay, TerminalReaderActionSetReaderDisplayArgs

TerminalReaderActionSetReaderDisplayCart, TerminalReaderActionSetReaderDisplayCartArgs

TerminalReaderActionSetReaderDisplayCartLineItem, TerminalReaderActionSetReaderDisplayCartLineItemArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.