TerminalReaderReader
A Reader represents a physical device for accepting payment details.
Related guide: Connecting to a reader
Summary
Functions
Cancel the current reader action
Collect inputs using a Reader
Hand off a PaymentIntent to a Reader and collect card details
Confirm a PaymentIntent on the Reader
Create a Reader
Delete a Reader
List all Readers
Hand-off a PaymentIntent to a Reader
Hand-off a SetupIntent to a Reader
Refund a Charge or a PaymentIntent in-person
Retrieve a Reader
Set reader display
Update a Reader
Functions
@spec cancel_action(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Cancel the current reader action
Cancels the current reader action. See Programmatic Cancellation for more details.
@spec collect_inputs(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Collect inputs using a Reader
Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
@spec collect_payment_method(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Hand off a PaymentIntent to a Reader and collect card details
Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.
@spec confirm_payment_intent(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Confirm a PaymentIntent on the Reader
Finalizes a payment on a Reader. See Confirming a Payment for more details.
@spec create(Stripe.Client.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Create a Reader
Creates a new Reader object.
@spec delete(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Delete a Reader
Deletes a Reader object.
@spec list(Stripe.Client.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
List all Readers
Returns a list of Reader objects.
@spec process_payment_intent(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Hand-off a PaymentIntent to a Reader
Initiates a payment flow on a Reader. See process the payment for more details.
@spec process_setup_intent(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Hand-off a SetupIntent to a Reader
Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.
@spec refund_payment(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Refund a Charge or a PaymentIntent in-person
Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.
@spec retrieve(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Retrieve a Reader
Retrieves a Reader object.
@spec set_reader_display(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Set reader display
Sets the reader display to show cart details.
@spec update(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Update a Reader
Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.