Sign in

Hand-off a SetupIntent to a Reader

Initiates a setup intent flow on a Reader.

post/v1/terminal/readers/{reader}/process_setup_intent

Path parameters

readerstring required

Response

Successful response.

device_sw_versionstring nullable

The current software version of the reader.

device_type'bbpos_chipper2x' | 'bbpos_wisepad3' | 'bbpos_wisepos_e' | 'mobile_phone_reader' | 'simulated_wisepos_e' | 'stripe_m2' | 'stripe_s700' | 'verifone_P400' required

Type of reader, one of bbpos_wisepad3, stripe_m2, stripe_s700, bbpos_chipper2x, bbpos_wisepos_e, verifone_P400, simulated_wisepos_e, or mobile_phone_reader.

idstring required

Unique identifier for the object.

ip_addressstring nullable

The local IP address of the reader.

labelstring required

Custom label given to the reader for easier identification.

livemodeboolean required

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

metadataobject required

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'terminal.reader' required

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

serial_numberstring required

Serial number of the reader.

status'offline' | 'online' nullable

The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

Changes