Reader ​
A Reader represents a physical device for accepting payment details.
Related guide: Connecting to a reader
Endpoints ​
Create a Reader ​
- POST /v1/terminal/readers
Update a Reader ​
- POST /v1/terminal/readers/:id
Retrieve a Reader ​
- GET /v1/terminal/readers/:id
List all Readers ​
- GET /v1/terminal/readers
Delete a Reader ​
- DELETE /v1/terminal/readers/:id
Cancel the current reader action ​
- POST /v1/terminal/readers/:id/cancel_action
Collect inputs using a Reader ​
- POST /v1/terminal/readers/:id/collect_inputs
Confirm a PaymentIntent on the Reader ​
- POST /v1/terminal/readers/:id/confirm_payment_intent
Hand off a PaymentIntent to a Reader and collect card details ​
- POST /v1/terminal/readers/:id/collect_payment_method
Hand-off a PaymentIntent to a Reader ​
- POST /v1/terminal/readers/:id/process_payment_intent
Hand-off a SetupIntent to a Reader ​
- POST /v1/terminal/readers/:id/process_setup_intent
Refund a Charge or a PaymentIntent in-person ​
- POST /v1/terminal/readers/:id/refund_payment
Set reader display ​
- POST /v1/terminal/readers/:id/set_reader_display
Simulate a successful input collection ​
- POST /v1/test_helpers/terminal/readers/:id/succeed_input_collection
Simulate an input collection timeout ​
- POST /v1/test_helpers/terminal/readers/:id/timeout_input_collection
Simulate presenting a payment method ​
- POST /v1/test_helpers/terminal/readers/:id/present_payment_method
Events ​
terminal.reader.action_failedOccurs whenever an action sent to a Terminal reader failed.terminal.reader.action_succeededOccurs whenever an action sent to a Terminal reader was successful.terminal.reader.action_updatedOccurs whenever an action sent to a Terminal reader is updated.