class Stripe::TerminalApi
- Stripe::TerminalApi
- Reference
- Object
Defined in:
stripe/api/terminal_api.crConstant Summary
-
DELETE_TERMINAL_CONFIGURATIONS_CONFIGURATION_MAX_LENGTH_FOR_CONFIGURATION =
5000
-
DELETE_TERMINAL_LOCATIONS_LOCATION_MAX_LENGTH_FOR_LOCATION =
5000
-
DELETE_TERMINAL_READERS_READER_MAX_LENGTH_FOR_READER =
5000
-
GET_TERMINAL_CONFIGURATIONS_CONFIGURATION_MAX_LENGTH_FOR_CONFIGURATION =
5000
-
GET_TERMINAL_CONFIGURATIONS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_TERMINAL_CONFIGURATIONS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_TERMINAL_LOCATIONS_LOCATION_MAX_LENGTH_FOR_LOCATION =
5000
-
GET_TERMINAL_LOCATIONS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_TERMINAL_LOCATIONS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_TERMINAL_READERS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_TERMINAL_READERS_MAX_LENGTH_FOR_LOCATION =
5000
-
GET_TERMINAL_READERS_MAX_LENGTH_FOR_SERIAL_NUMBER =
5000
-
GET_TERMINAL_READERS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_TERMINAL_READERS_READER_MAX_LENGTH_FOR_READER =
5000
-
GET_TERMINAL_READERS_VALID_VALUES_FOR_DEVICE_TYPE =
String.static_array("bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", "stripe_s700", "verifone_P400")
-
GET_TERMINAL_READERS_VALID_VALUES_FOR_STATUS =
String.static_array("offline", "online")
-
POST_TERMINAL_CONFIGURATIONS_CONFIGURATION_MAX_LENGTH_FOR_CONFIGURATION =
5000
-
POST_TERMINAL_CONFIGURATIONS_CONFIGURATION_MAX_LENGTH_FOR_NAME =
100
-
POST_TERMINAL_CONFIGURATIONS_MAX_LENGTH_FOR_NAME =
100
-
POST_TERMINAL_CONNECTION_TOKENS_MAX_LENGTH_FOR_LOCATION =
5000
-
POST_TERMINAL_LOCATIONS_LOCATION_MAX_LENGTH_FOR_DISPLAY_NAME =
1000
-
POST_TERMINAL_LOCATIONS_LOCATION_MAX_LENGTH_FOR_LOCATION =
5000
-
POST_TERMINAL_LOCATIONS_MAX_LENGTH_FOR_CONFIGURATION_OVERRIDES =
1000
-
POST_TERMINAL_LOCATIONS_MAX_LENGTH_FOR_DISPLAY_NAME =
1000
-
POST_TERMINAL_READERS_MAX_LENGTH_FOR_LABEL =
5000
-
POST_TERMINAL_READERS_MAX_LENGTH_FOR_LOCATION =
5000
-
POST_TERMINAL_READERS_MAX_LENGTH_FOR_REGISTRATION_CODE =
5000
-
POST_TERMINAL_READERS_READER_CANCEL_ACTION_MAX_LENGTH_FOR_READER =
5000
-
POST_TERMINAL_READERS_READER_MAX_LENGTH_FOR_READER =
5000
-
POST_TERMINAL_READERS_READER_PROCESS_PAYMENT_INTENT_MAX_LENGTH_FOR_PAYMENT_INTENT =
5000
-
POST_TERMINAL_READERS_READER_PROCESS_PAYMENT_INTENT_MAX_LENGTH_FOR_READER =
5000
-
POST_TERMINAL_READERS_READER_PROCESS_SETUP_INTENT_MAX_LENGTH_FOR_READER =
5000
-
POST_TERMINAL_READERS_READER_PROCESS_SETUP_INTENT_MAX_LENGTH_FOR_SETUP_INTENT =
5000
-
POST_TERMINAL_READERS_READER_REFUND_PAYMENT_MAX_LENGTH_FOR_CHARGE =
5000
-
POST_TERMINAL_READERS_READER_REFUND_PAYMENT_MAX_LENGTH_FOR_PAYMENT_INTENT =
5000
-
POST_TERMINAL_READERS_READER_REFUND_PAYMENT_MAX_LENGTH_FOR_READER =
5000
-
POST_TERMINAL_READERS_READER_SET_READER_DISPLAY_MAX_LENGTH_FOR_READER =
5000
-
POST_TERMINAL_READERS_READER_SET_READER_DISPLAY_VALID_VALUES_FOR__TYPE =
String.static_array("cart")
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_delete_terminal_configurations_configuration(*, configuration : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete_terminal_locations_location(*, location : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete_terminal_readers_reader(*, reader : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_terminal_configurations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, is_account_default : Bool | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_terminal_configurations_configuration(*, configuration : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_terminal_locations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_terminal_locations_location(*, location : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_terminal_readers(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, location : String | Nil = nil, status : String | Nil = nil, device_type : String | Nil = nil, serial_number : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_terminal_readers_reader(*, reader : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_configurations(*, bbpos_wisepos_e : Stripe::BbposWisePose | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil, offline : Stripe::PostTerminalConfigurationsRequestOffline | Nil = nil, reboot_window : Stripe::RebootWindow | Nil = nil, stripe_s700 : Stripe::StripeS700 | Nil = nil, tipping : Stripe::PostTerminalConfigurationsRequestTipping | Nil = nil, verifone_p400 : Stripe::VerifoneP400 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_configurations_configuration(*, configuration : String | Nil = nil, bbpos_wisepos_e : Stripe::PostTerminalConfigurationsConfigurationRequestBbposWiseposE | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil, offline : Stripe::PostTerminalConfigurationsRequestOffline | Nil = nil, reboot_window : Stripe::PostTerminalConfigurationsConfigurationRequestRebootWindow | Nil = nil, stripe_s700 : Stripe::PostTerminalConfigurationsConfigurationRequestStripeS700 | Nil = nil, tipping : Stripe::PostTerminalConfigurationsRequestTipping | Nil = nil, verifone_p400 : Stripe::PostTerminalConfigurationsConfigurationRequestVerifoneP400 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_connection_tokens(*, expand : Array(String) | Nil = nil, location : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_locations(*, address : Stripe::CreateLocationAddressParam | Nil = nil, display_name : String | Nil = nil, configuration_overrides : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_locations_location(*, location : String | Nil = nil, address : Stripe::OptionalFieldsAddress | Nil = nil, configuration_overrides : Stripe::PostTerminalLocationsLocationRequestConfigurationOverrides | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_readers(*, registration_code : String | Nil = nil, expand : Array(String) | Nil = nil, label : String | Nil = nil, location : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_readers_reader(*, reader : String | Nil = nil, expand : Array(String) | Nil = nil, label : Stripe::PostTerminalReadersReaderRequestLabel | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_readers_reader_cancel_action(*, reader : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_readers_reader_process_payment_intent(*, reader : String | Nil = nil, payment_intent : String | Nil = nil, expand : Array(String) | Nil = nil, process_config : Stripe::ProcessConfig | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_readers_reader_process_setup_intent(*, reader : String | Nil = nil, setup_intent : String | Nil = nil, customer_consent_collected : Bool | Nil = nil, expand : Array(String) | Nil = nil, process_config : Stripe::ProcessSetupConfig | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_readers_reader_refund_payment(*, reader : String | Nil = nil, amount : Int64 | Nil = nil, charge : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, payment_intent : String | Nil = nil, refund_application_fee : Bool | Nil = nil, refund_payment_config : Stripe::RefundPaymentConfig | Nil = nil, reverse_transfer : Bool | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_terminal_readers_reader_set_reader_display(*, reader : String | Nil = nil, _type : String | Nil = nil, cart : Stripe::Cart | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#delete_terminal_configurations_configuration(*, configuration : String | Nil = nil) : Stripe::DeletedTerminalConfiguration
Deletes a
@required @param configuration [String?] @return [Stripe::DeletedTerminalConfiguration]Configuration
object. -
#delete_terminal_configurations_configuration(*, configuration : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Deletes a <code>Configuration</code> object.</p> @required @param configuration [String?] @return nil
-
#delete_terminal_configurations_configuration_with_http_info(*, configuration : String | Nil = nil) : Tuple(Stripe::DeletedTerminalConfiguration, Int32, Hash(String, Array(String) | String))
<p>Deletes a <code>Configuration</code> object.</p> @required @param configuration [String?] @return [Tuple(Stripe::DeletedTerminalConfiguration, Integer, Hash)] Stripe::DeletedTerminalConfiguration, response status code and response headers
-
#delete_terminal_locations_location(*, location : String | Nil = nil) : Stripe::DeletedTerminalLocation
Deletes a
@required @param location [String?] @return [Stripe::DeletedTerminalLocation]Location
object. -
#delete_terminal_locations_location(*, location : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Deletes a <code>Location</code> object.</p> @required @param location [String?] @return nil
-
#delete_terminal_locations_location_with_http_info(*, location : String | Nil = nil) : Tuple(Stripe::DeletedTerminalLocation, Int32, Hash(String, Array(String) | String))
<p>Deletes a <code>Location</code> object.</p> @required @param location [String?] @return [Tuple(Stripe::DeletedTerminalLocation, Integer, Hash)] Stripe::DeletedTerminalLocation, response status code and response headers
-
#delete_terminal_readers_reader(*, reader : String | Nil = nil) : Stripe::DeletedTerminalReader
Deletes a
@required @param reader [String?] @return [Stripe::DeletedTerminalReader]Reader
object. -
#delete_terminal_readers_reader(*, reader : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Deletes a <code>Reader</code> object.</p> @required @param reader [String?] @return nil
-
#delete_terminal_readers_reader_with_http_info(*, reader : String | Nil = nil) : Tuple(Stripe::DeletedTerminalReader, Int32, Hash(String, Array(String) | String))
<p>Deletes a <code>Reader</code> object.</p> @required @param reader [String?] @return [Tuple(Stripe::DeletedTerminalReader, Integer, Hash)] Stripe::DeletedTerminalReader, response status code and response headers
-
#get_terminal_configurations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, is_account_default : Bool | Nil = nil) : Stripe::TerminalConfigurationConfigurationList
Returns a list of
@optional @param ending_before [String?] A cursor for use in pagination.Configuration
objects. -
#get_terminal_configurations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, is_account_default : Bool | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of <code>Configuration</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_terminal_configurations_configuration(*, configuration : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::GetTerminalConfigurationsConfiguration200Response
Retrieves a
@required @param configuration [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.Configuration
object. -
#get_terminal_configurations_configuration(*, configuration : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a <code>Configuration</code> object.</p> @required @param configuration [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_terminal_configurations_configuration_with_http_info(*, configuration : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::GetTerminalConfigurationsConfiguration200Response, Int32, Hash(String, Array(String) | String))
<p>Retrieves a <code>Configuration</code> object.</p> @required @param configuration [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_terminal_configurations_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, is_account_default : Bool | Nil = nil) : Tuple(Stripe::TerminalConfigurationConfigurationList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of <code>Configuration</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_terminal_locations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TerminalLocationLocationList
Returns a list of
@optional @param ending_before [String?] A cursor for use in pagination.Location
objects. -
#get_terminal_locations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of <code>Location</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_terminal_locations_location(*, location : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::GetTerminalLocationsLocation200Response
Retrieves a
@required @param location [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.Location
object. -
#get_terminal_locations_location(*, location : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a <code>Location</code> object.</p> @required @param location [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_terminal_locations_location_with_http_info(*, location : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::GetTerminalLocationsLocation200Response, Int32, Hash(String, Array(String) | String))
<p>Retrieves a <code>Location</code> object.</p> @required @param location [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_terminal_locations_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TerminalLocationLocationList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of <code>Location</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_terminal_readers(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, location : String | Nil = nil, status : String | Nil = nil, device_type : String | Nil = nil, serial_number : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TerminalReaderRetrieveReader
Returns a list of
@optional @param ending_before [String?] A cursor for use in pagination.Reader
objects. -
#get_terminal_readers(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, location : String | Nil = nil, status : String | Nil = nil, device_type : String | Nil = nil, serial_number : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of <code>Reader</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_terminal_readers_reader(*, reader : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::GetTerminalReadersReader200Response
Retrieves a
@required @param reader [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.Reader
object. -
#get_terminal_readers_reader(*, reader : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a <code>Reader</code> object.</p> @required @param reader [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_terminal_readers_reader_with_http_info(*, reader : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::GetTerminalReadersReader200Response, Int32, Hash(String, Array(String) | String))
<p>Retrieves a <code>Reader</code> object.</p> @required @param reader [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_terminal_readers_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, location : String | Nil = nil, status : String | Nil = nil, device_type : String | Nil = nil, serial_number : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TerminalReaderRetrieveReader, Int32, Hash(String, Array(String) | String))
<p>Returns a list of <code>Reader</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#post_terminal_configurations(*, bbpos_wisepos_e : Stripe::BbposWisePose | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil, offline : Stripe::PostTerminalConfigurationsRequestOffline | Nil = nil, reboot_window : Stripe::RebootWindow | Nil = nil, stripe_s700 : Stripe::StripeS700 | Nil = nil, tipping : Stripe::PostTerminalConfigurationsRequestTipping | Nil = nil, verifone_p400 : Stripe::VerifoneP400 | Nil = nil) : Stripe::TerminalConfiguration
Creates a new
@optional @param bbpos_wisepos_e [Stripe::BbposWisePose?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.Configuration
object. -
#post_terminal_configurations(*, bbpos_wisepos_e : Stripe::BbposWisePose | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil, offline : Stripe::PostTerminalConfigurationsRequestOffline | Nil = nil, reboot_window : Stripe::RebootWindow | Nil = nil, stripe_s700 : Stripe::StripeS700 | Nil = nil, tipping : Stripe::PostTerminalConfigurationsRequestTipping | Nil = nil, verifone_p400 : Stripe::VerifoneP400 | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a new <code>Configuration</code> object.</p> @optional @param bbpos_wisepos_e [Stripe::BbposWisePose?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_configurations_configuration(*, configuration : String | Nil = nil, bbpos_wisepos_e : Stripe::PostTerminalConfigurationsConfigurationRequestBbposWiseposE | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil, offline : Stripe::PostTerminalConfigurationsRequestOffline | Nil = nil, reboot_window : Stripe::PostTerminalConfigurationsConfigurationRequestRebootWindow | Nil = nil, stripe_s700 : Stripe::PostTerminalConfigurationsConfigurationRequestStripeS700 | Nil = nil, tipping : Stripe::PostTerminalConfigurationsRequestTipping | Nil = nil, verifone_p400 : Stripe::PostTerminalConfigurationsConfigurationRequestVerifoneP400 | Nil = nil) : Stripe::GetTerminalConfigurationsConfiguration200Response
Updates a new
@required @param configuration [String?] @optional @param bbpos_wisepos_e [Stripe::PostTerminalConfigurationsConfigurationRequestBbposWiseposE?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.Configuration
object. -
#post_terminal_configurations_configuration(*, configuration : String | Nil = nil, bbpos_wisepos_e : Stripe::PostTerminalConfigurationsConfigurationRequestBbposWiseposE | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil, offline : Stripe::PostTerminalConfigurationsRequestOffline | Nil = nil, reboot_window : Stripe::PostTerminalConfigurationsConfigurationRequestRebootWindow | Nil = nil, stripe_s700 : Stripe::PostTerminalConfigurationsConfigurationRequestStripeS700 | Nil = nil, tipping : Stripe::PostTerminalConfigurationsRequestTipping | Nil = nil, verifone_p400 : Stripe::PostTerminalConfigurationsConfigurationRequestVerifoneP400 | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates a new <code>Configuration</code> object.</p> @required @param configuration [String?] @optional @param bbpos_wisepos_e [Stripe::PostTerminalConfigurationsConfigurationRequestBbposWiseposE?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_configurations_configuration_with_http_info(*, configuration : String | Nil = nil, bbpos_wisepos_e : Stripe::PostTerminalConfigurationsConfigurationRequestBbposWiseposE | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil, offline : Stripe::PostTerminalConfigurationsRequestOffline | Nil = nil, reboot_window : Stripe::PostTerminalConfigurationsConfigurationRequestRebootWindow | Nil = nil, stripe_s700 : Stripe::PostTerminalConfigurationsConfigurationRequestStripeS700 | Nil = nil, tipping : Stripe::PostTerminalConfigurationsRequestTipping | Nil = nil, verifone_p400 : Stripe::PostTerminalConfigurationsConfigurationRequestVerifoneP400 | Nil = nil) : Tuple(Stripe::GetTerminalConfigurationsConfiguration200Response, Int32, Hash(String, Array(String) | String))
<p>Updates a new <code>Configuration</code> object.</p> @required @param configuration [String?] @optional @param bbpos_wisepos_e [Stripe::PostTerminalConfigurationsConfigurationRequestBbposWiseposE?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_configurations_with_http_info(*, bbpos_wisepos_e : Stripe::BbposWisePose | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil, offline : Stripe::PostTerminalConfigurationsRequestOffline | Nil = nil, reboot_window : Stripe::RebootWindow | Nil = nil, stripe_s700 : Stripe::StripeS700 | Nil = nil, tipping : Stripe::PostTerminalConfigurationsRequestTipping | Nil = nil, verifone_p400 : Stripe::VerifoneP400 | Nil = nil) : Tuple(Stripe::TerminalConfiguration, Int32, Hash(String, Array(String) | String))
<p>Creates a new <code>Configuration</code> object.</p> @optional @param bbpos_wisepos_e [Stripe::BbposWisePose?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_connection_tokens(*, expand : Array(String) | Nil = nil, location : String | Nil = nil) : Stripe::TerminalConnectionToken
To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server.
-
#post_terminal_connection_tokens(*, expand : Array(String) | Nil = nil, location : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server.
-
#post_terminal_connection_tokens_with_http_info(*, expand : Array(String) | Nil = nil, location : String | Nil = nil) : Tuple(Stripe::TerminalConnectionToken, Int32, Hash(String, Array(String) | String))
<p>To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server.
-
#post_terminal_locations(*, address : Stripe::CreateLocationAddressParam | Nil = nil, display_name : String | Nil = nil, configuration_overrides : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::TerminalLocation
Creates a new
Location
object. -
#post_terminal_locations(*, address : Stripe::CreateLocationAddressParam | Nil = nil, display_name : String | Nil = nil, configuration_overrides : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a new <code>Location</code> object.
-
#post_terminal_locations_location(*, location : String | Nil = nil, address : Stripe::OptionalFieldsAddress | Nil = nil, configuration_overrides : Stripe::PostTerminalLocationsLocationRequestConfigurationOverrides | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::GetTerminalLocationsLocation200Response
Updates a
Location
object by setting the values of the parameters passed. -
#post_terminal_locations_location(*, location : String | Nil = nil, address : Stripe::OptionalFieldsAddress | Nil = nil, configuration_overrides : Stripe::PostTerminalLocationsLocationRequestConfigurationOverrides | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates a <code>Location</code> object by setting the values of the parameters passed.
-
#post_terminal_locations_location_with_http_info(*, location : String | Nil = nil, address : Stripe::OptionalFieldsAddress | Nil = nil, configuration_overrides : Stripe::PostTerminalLocationsLocationRequestConfigurationOverrides | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::GetTerminalLocationsLocation200Response, Int32, Hash(String, Array(String) | String))
<p>Updates a <code>Location</code> object by setting the values of the parameters passed.
-
#post_terminal_locations_with_http_info(*, address : Stripe::CreateLocationAddressParam | Nil = nil, display_name : String | Nil = nil, configuration_overrides : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::TerminalLocation, Int32, Hash(String, Array(String) | String))
<p>Creates a new <code>Location</code> object.
-
#post_terminal_readers(*, registration_code : String | Nil = nil, expand : Array(String) | Nil = nil, label : String | Nil = nil, location : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::TerminalReader
Creates a new
@required @param registration_code [String?] A code generated by the reader used for registering to an account.Reader
object. -
#post_terminal_readers(*, registration_code : String | Nil = nil, expand : Array(String) | Nil = nil, label : String | Nil = nil, location : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a new <code>Reader</code> object.</p> @required @param registration_code [String?] A code generated by the reader used for registering to an account.
-
#post_terminal_readers_reader(*, reader : String | Nil = nil, expand : Array(String) | Nil = nil, label : Stripe::PostTerminalReadersReaderRequestLabel | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::GetTerminalReadersReader200Response
Updates a
Reader
object by setting the values of the parameters passed. -
#post_terminal_readers_reader(*, reader : String | Nil = nil, expand : Array(String) | Nil = nil, label : Stripe::PostTerminalReadersReaderRequestLabel | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates a <code>Reader</code> object by setting the values of the parameters passed.
-
#post_terminal_readers_reader_cancel_action(*, reader : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::TerminalReader
Cancels the current reader action.
@required @param reader [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. -
#post_terminal_readers_reader_cancel_action(*, reader : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Cancels the current reader action.</p> @required @param reader [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_readers_reader_cancel_action_with_http_info(*, reader : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::TerminalReader, Int32, Hash(String, Array(String) | String))
<p>Cancels the current reader action.</p> @required @param reader [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_readers_reader_process_payment_intent(*, reader : String | Nil = nil, payment_intent : String | Nil = nil, expand : Array(String) | Nil = nil, process_config : Stripe::ProcessConfig | Nil = nil) : Stripe::TerminalReader
Initiates a payment flow on a Reader.
@required @param reader [String?] @required @param payment_intent [String?] PaymentIntent ID @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. -
#post_terminal_readers_reader_process_payment_intent(*, reader : String | Nil = nil, payment_intent : String | Nil = nil, expand : Array(String) | Nil = nil, process_config : Stripe::ProcessConfig | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Initiates a payment flow on a Reader.</p> @required @param reader [String?] @required @param payment_intent [String?] PaymentIntent ID @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_readers_reader_process_payment_intent_with_http_info(*, reader : String | Nil = nil, payment_intent : String | Nil = nil, expand : Array(String) | Nil = nil, process_config : Stripe::ProcessConfig | Nil = nil) : Tuple(Stripe::TerminalReader, Int32, Hash(String, Array(String) | String))
<p>Initiates a payment flow on a Reader.</p> @required @param reader [String?] @required @param payment_intent [String?] PaymentIntent ID @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_readers_reader_process_setup_intent(*, reader : String | Nil = nil, setup_intent : String | Nil = nil, customer_consent_collected : Bool | Nil = nil, expand : Array(String) | Nil = nil, process_config : Stripe::ProcessSetupConfig | Nil = nil) : Stripe::TerminalReader
Initiates a setup intent flow on a Reader.
@required @param reader [String?] @required @param setup_intent [String?] SetupIntent ID @optional @param customer_consent_collected [Bool?] Customer Consent Collected @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. -
#post_terminal_readers_reader_process_setup_intent(*, reader : String | Nil = nil, setup_intent : String | Nil = nil, customer_consent_collected : Bool | Nil = nil, expand : Array(String) | Nil = nil, process_config : Stripe::ProcessSetupConfig | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Initiates a setup intent flow on a Reader.</p> @required @param reader [String?] @required @param setup_intent [String?] SetupIntent ID @optional @param customer_consent_collected [Bool?] Customer Consent Collected @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_readers_reader_process_setup_intent_with_http_info(*, reader : String | Nil = nil, setup_intent : String | Nil = nil, customer_consent_collected : Bool | Nil = nil, expand : Array(String) | Nil = nil, process_config : Stripe::ProcessSetupConfig | Nil = nil) : Tuple(Stripe::TerminalReader, Int32, Hash(String, Array(String) | String))
<p>Initiates a setup intent flow on a Reader.</p> @required @param reader [String?] @required @param setup_intent [String?] SetupIntent ID @optional @param customer_consent_collected [Bool?] Customer Consent Collected @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_readers_reader_refund_payment(*, reader : String | Nil = nil, amount : Int64 | Nil = nil, charge : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, payment_intent : String | Nil = nil, refund_application_fee : Bool | Nil = nil, refund_payment_config : Stripe::RefundPaymentConfig | Nil = nil, reverse_transfer : Bool | Nil = nil) : Stripe::TerminalReader
Initiates a refund on a Reader
@required @param reader [String?] @optional @param amount [Int32?] A positive integer in __cents__ representing how much of this charge to refund. -
#post_terminal_readers_reader_refund_payment(*, reader : String | Nil = nil, amount : Int64 | Nil = nil, charge : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, payment_intent : String | Nil = nil, refund_application_fee : Bool | Nil = nil, refund_payment_config : Stripe::RefundPaymentConfig | Nil = nil, reverse_transfer : Bool | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Initiates a refund on a Reader</p> @required @param reader [String?] @optional @param amount [Int32?] A positive integer in cents representing how much of this charge to refund.
-
#post_terminal_readers_reader_refund_payment_with_http_info(*, reader : String | Nil = nil, amount : Int64 | Nil = nil, charge : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, payment_intent : String | Nil = nil, refund_application_fee : Bool | Nil = nil, refund_payment_config : Stripe::RefundPaymentConfig | Nil = nil, reverse_transfer : Bool | Nil = nil) : Tuple(Stripe::TerminalReader, Int32, Hash(String, Array(String) | String))
<p>Initiates a refund on a Reader</p> @required @param reader [String?] @optional @param amount [Int32?] A positive integer in cents representing how much of this charge to refund.
-
#post_terminal_readers_reader_set_reader_display(*, reader : String | Nil = nil, _type : String | Nil = nil, cart : Stripe::Cart | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::TerminalReader
Sets reader display to show cart details.
@required @param reader [String?] @required @param _type [String?] Type @optional @param cart [Stripe::Cart?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. -
#post_terminal_readers_reader_set_reader_display(*, reader : String | Nil = nil, _type : String | Nil = nil, cart : Stripe::Cart | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Sets reader display to show cart details.</p> @required @param reader [String?] @required @param _type [String?] Type @optional @param cart [Stripe::Cart?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_readers_reader_set_reader_display_with_http_info(*, reader : String | Nil = nil, _type : String | Nil = nil, cart : Stripe::Cart | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::TerminalReader, Int32, Hash(String, Array(String) | String))
<p>Sets reader display to show cart details.</p> @required @param reader [String?] @required @param _type [String?] Type @optional @param cart [Stripe::Cart?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_terminal_readers_reader_with_http_info(*, reader : String | Nil = nil, expand : Array(String) | Nil = nil, label : Stripe::PostTerminalReadersReaderRequestLabel | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::GetTerminalReadersReader200Response, Int32, Hash(String, Array(String) | String))
<p>Updates a <code>Reader</code> object by setting the values of the parameters passed.
-
#post_terminal_readers_with_http_info(*, registration_code : String | Nil = nil, expand : Array(String) | Nil = nil, label : String | Nil = nil, location : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::TerminalReader, Int32, Hash(String, Array(String) | String))
<p>Creates a new <code>Reader</code> object.</p> @required @param registration_code [String?] A code generated by the reader used for registering to an account.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Deletes a Configuration
object.
<p>Deletes a <code>Configuration</code> object.</p> @required @param configuration [String?] @return nil
<p>Deletes a <code>Configuration</code> object.</p> @required @param configuration [String?] @return [Tuple(Stripe::DeletedTerminalConfiguration, Integer, Hash)] Stripe::DeletedTerminalConfiguration, response status code and response headers
Deletes a Location
object.
<p>Deletes a <code>Location</code> object.</p> @required @param location [String?] @return nil
<p>Deletes a <code>Location</code> object.</p> @required @param location [String?] @return [Tuple(Stripe::DeletedTerminalLocation, Integer, Hash)] Stripe::DeletedTerminalLocation, response status code and response headers
Deletes a Reader
object.
<p>Deletes a <code>Reader</code> object.</p> @required @param reader [String?] @return nil
<p>Deletes a <code>Reader</code> object.</p> @required @param reader [String?] @return [Tuple(Stripe::DeletedTerminalReader, Integer, Hash)] Stripe::DeletedTerminalReader, response status code and response headers
Returns a list of Configuration
objects.
<p>Returns a list of <code>Configuration</code> objects.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@optional @param is_account_default [Bool?] if present, only return the account default or non-default configurations.
@return nil
Retrieves a Configuration
object.
<p>Retrieves a <code>Configuration</code> object.</p> @required @param configuration [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a <code>Configuration</code> object.</p> @required @param configuration [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::GetTerminalConfigurationsConfiguration200Response, Integer, Hash)] Stripe::GetTerminalConfigurationsConfiguration200Response, response status code and response headers
<p>Returns a list of <code>Configuration</code> objects.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@optional @param is_account_default [Bool?] if present, only return the account default or non-default configurations.
@return [Tuple(Stripe::TerminalConfigurationConfigurationList, Integer, Hash)] Stripe::TerminalConfigurationConfigurationList, response status code and response headers
Returns a list of Location
objects.
<p>Returns a list of <code>Location</code> objects.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves a Location
object.
<p>Retrieves a <code>Location</code> object.</p> @required @param location [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a <code>Location</code> object.</p> @required @param location [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::GetTerminalLocationsLocation200Response, Integer, Hash)] Stripe::GetTerminalLocationsLocation200Response, response status code and response headers
<p>Returns a list of <code>Location</code> objects.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::TerminalLocationLocationList, Integer, Hash)] Stripe::TerminalLocationLocationList, response status code and response headers
Returns a list of Reader
objects.
<p>Returns a list of <code>Reader</code> objects.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param location [String?] A location ID to filter the response list to only readers at the specific location
@optional @param status [String?] A status filter to filter readers to only offline or online readers
@optional @param device_type [String?] Filters readers by device type
@optional @param serial_number [String?] Filters readers by serial number
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves a Reader
object.
<p>Retrieves a <code>Reader</code> object.</p> @required @param reader [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a <code>Reader</code> object.</p> @required @param reader [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::GetTerminalReadersReader200Response, Integer, Hash)] Stripe::GetTerminalReadersReader200Response, response status code and response headers
<p>Returns a list of <code>Reader</code> objects.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param location [String?] A location ID to filter the response list to only readers at the specific location
@optional @param status [String?] A status filter to filter readers to only offline or online readers
@optional @param device_type [String?] Filters readers by device type
@optional @param serial_number [String?] Filters readers by serial number
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::TerminalReaderRetrieveReader, Integer, Hash)] Stripe::TerminalReaderRetrieveReader, response status code and response headers
Creates a new Configuration
object.
<p>Creates a new <code>Configuration</code> object.</p> @optional @param bbpos_wisepos_e [Stripe::BbposWisePose?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param name [String?] Name of the configuration @optional @param offline [Stripe::PostTerminalConfigurationsRequestOffline?] @optional @param reboot_window [Stripe::RebootWindow?] @optional @param stripe_s700 [Stripe::StripeS700?] @optional @param tipping [Stripe::PostTerminalConfigurationsRequestTipping?] @optional @param verifone_p400 [Stripe::VerifoneP400?] @return nil
Updates a new Configuration
object.
<p>Updates a new <code>Configuration</code> object.</p> @required @param configuration [String?] @optional @param bbpos_wisepos_e [Stripe::PostTerminalConfigurationsConfigurationRequestBbposWiseposE?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param name [String?] Name of the configuration @optional @param offline [Stripe::PostTerminalConfigurationsRequestOffline?] @optional @param reboot_window [Stripe::PostTerminalConfigurationsConfigurationRequestRebootWindow?] @optional @param stripe_s700 [Stripe::PostTerminalConfigurationsConfigurationRequestStripeS700?] @optional @param tipping [Stripe::PostTerminalConfigurationsRequestTipping?] @optional @param verifone_p400 [Stripe::PostTerminalConfigurationsConfigurationRequestVerifoneP400?] @return nil
<p>Updates a new <code>Configuration</code> object.</p> @required @param configuration [String?] @optional @param bbpos_wisepos_e [Stripe::PostTerminalConfigurationsConfigurationRequestBbposWiseposE?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param name [String?] Name of the configuration @optional @param offline [Stripe::PostTerminalConfigurationsRequestOffline?] @optional @param reboot_window [Stripe::PostTerminalConfigurationsConfigurationRequestRebootWindow?] @optional @param stripe_s700 [Stripe::PostTerminalConfigurationsConfigurationRequestStripeS700?] @optional @param tipping [Stripe::PostTerminalConfigurationsRequestTipping?] @optional @param verifone_p400 [Stripe::PostTerminalConfigurationsConfigurationRequestVerifoneP400?] @return [Tuple(Stripe::GetTerminalConfigurationsConfiguration200Response, Integer, Hash)] Stripe::GetTerminalConfigurationsConfiguration200Response, response status code and response headers
<p>Creates a new <code>Configuration</code> object.</p> @optional @param bbpos_wisepos_e [Stripe::BbposWisePose?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param name [String?] Name of the configuration @optional @param offline [Stripe::PostTerminalConfigurationsRequestOffline?] @optional @param reboot_window [Stripe::RebootWindow?] @optional @param stripe_s700 [Stripe::StripeS700?] @optional @param tipping [Stripe::PostTerminalConfigurationsRequestTipping?] @optional @param verifone_p400 [Stripe::VerifoneP400?] @return [Tuple(Stripe::TerminalConfiguration, Integer, Hash)] Stripe::TerminalConfiguration, response status code and response headers
To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param location [String?] The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens). @return [Stripe::TerminalConnectionToken]<p>To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.</p> @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param location [String?] The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see the docs on scoping connection tokens. @return nil
<p>To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.</p> @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param location [String?] The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see the docs on scoping connection tokens. @return [Tuple(Stripe::TerminalConnectionToken, Integer, Hash)] Stripe::TerminalConnectionToken, response status code and response headers
Creates a new Location
object. For further details, including which address fields are required in each country, see the Manage locations guide.
<p>Creates a new <code>Location</code> object. For further details, including which address fields are required in each country, see the <a href="/docs/terminal/fleet/locations">Manage locations</a> guide.</p> @required @param address [Stripe::CreateLocationAddressParam?] @required @param display_name [String?] A name for the location. @optional @param configuration_overrides [String?] The ID of a configuration that will be used to customize all readers in this location. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil
Updates a Location
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
<p>Updates a <code>Location</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> @required @param location [String?] @optional @param address [Stripe::OptionalFieldsAddress?] @optional @param configuration_overrides [Stripe::PostTerminalLocationsLocationRequestConfigurationOverrides?] @optional @param display_name [String?] A name for the location. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil
<p>Updates a <code>Location</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> @required @param location [String?] @optional @param address [Stripe::OptionalFieldsAddress?] @optional @param configuration_overrides [Stripe::PostTerminalLocationsLocationRequestConfigurationOverrides?] @optional @param display_name [String?] A name for the location. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::GetTerminalLocationsLocation200Response, Integer, Hash)] Stripe::GetTerminalLocationsLocation200Response, response status code and response headers
<p>Creates a new <code>Location</code> object. For further details, including which address fields are required in each country, see the <a href="/docs/terminal/fleet/locations">Manage locations</a> guide.</p> @required @param address [Stripe::CreateLocationAddressParam?] @required @param display_name [String?] A name for the location. @optional @param configuration_overrides [String?] The ID of a configuration that will be used to customize all readers in this location. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::TerminalLocation, Integer, Hash)] Stripe::TerminalLocation, response status code and response headers
Creates a new Reader
object.
<p>Creates a new <code>Reader</code> object.</p> @required @param registration_code [String?] A code generated by the reader used for registering to an account. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param label [String?] Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. @optional @param location [String?] The location to assign the reader to. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil
Updates a Reader
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
<p>Updates a <code>Reader</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> @required @param reader [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param label [Stripe::PostTerminalReadersReaderRequestLabel?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil
Cancels the current reader action.
@required @param reader [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::TerminalReader]<p>Cancels the current reader action.</p> @required @param reader [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Cancels the current reader action.</p> @required @param reader [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TerminalReader, Integer, Hash)] Stripe::TerminalReader, response status code and response headers
Initiates a payment flow on a Reader.
@required @param reader [String?] @required @param payment_intent [String?] PaymentIntent ID @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param process_config [Stripe::ProcessConfig?] @return [Stripe::TerminalReader]<p>Initiates a payment flow on a Reader.</p> @required @param reader [String?] @required @param payment_intent [String?] PaymentIntent ID @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param process_config [Stripe::ProcessConfig?] @return nil
<p>Initiates a payment flow on a Reader.</p> @required @param reader [String?] @required @param payment_intent [String?] PaymentIntent ID @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param process_config [Stripe::ProcessConfig?] @return [Tuple(Stripe::TerminalReader, Integer, Hash)] Stripe::TerminalReader, response status code and response headers
Initiates a setup intent flow on a Reader.
@required @param reader [String?] @required @param setup_intent [String?] SetupIntent ID @optional @param customer_consent_collected [Bool?] Customer Consent Collected @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param process_config [Stripe::ProcessSetupConfig?] @return [Stripe::TerminalReader]<p>Initiates a setup intent flow on a Reader.</p> @required @param reader [String?] @required @param setup_intent [String?] SetupIntent ID @optional @param customer_consent_collected [Bool?] Customer Consent Collected @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param process_config [Stripe::ProcessSetupConfig?] @return nil
<p>Initiates a setup intent flow on a Reader.</p> @required @param reader [String?] @required @param setup_intent [String?] SetupIntent ID @optional @param customer_consent_collected [Bool?] Customer Consent Collected @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param process_config [Stripe::ProcessSetupConfig?] @return [Tuple(Stripe::TerminalReader, Integer, Hash)] Stripe::TerminalReader, response status code and response headers
Initiates a refund on a Reader
@required @param reader [String?] @optional @param amount [Int32?] A positive integer in __cents__ representing how much of this charge to refund. @optional @param charge [String?] ID of the Charge to refund. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param payment_intent [String?] ID of the PaymentIntent to refund. @optional @param 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. @optional @param refund_payment_config [Stripe::RefundPaymentConfig?] @optional @param 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. @return [Stripe::TerminalReader]<p>Initiates a refund on a Reader</p> @required @param reader [String?] @optional @param amount [Int32?] A positive integer in cents representing how much of this charge to refund. @optional @param charge [String?] ID of the Charge to refund. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param payment_intent [String?] ID of the PaymentIntent to refund. @optional @param 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. @optional @param refund_payment_config [Stripe::RefundPaymentConfig?] @optional @param 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. @return nil
<p>Initiates a refund on a Reader</p> @required @param reader [String?] @optional @param amount [Int32?] A positive integer in cents representing how much of this charge to refund. @optional @param charge [String?] ID of the Charge to refund. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param payment_intent [String?] ID of the PaymentIntent to refund. @optional @param 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. @optional @param refund_payment_config [Stripe::RefundPaymentConfig?] @optional @param 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. @return [Tuple(Stripe::TerminalReader, Integer, Hash)] Stripe::TerminalReader, response status code and response headers
Sets reader display to show cart details.
@required @param reader [String?] @required @param _type [String?] Type @optional @param cart [Stripe::Cart?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::TerminalReader]<p>Sets reader display to show cart details.</p> @required @param reader [String?] @required @param _type [String?] Type @optional @param cart [Stripe::Cart?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Sets reader display to show cart details.</p> @required @param reader [String?] @required @param _type [String?] Type @optional @param cart [Stripe::Cart?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TerminalReader, Integer, Hash)] Stripe::TerminalReader, response status code and response headers
<p>Updates a <code>Reader</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> @required @param reader [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param label [Stripe::PostTerminalReadersReaderRequestLabel?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::GetTerminalReadersReader200Response, Integer, Hash)] Stripe::GetTerminalReadersReader200Response, response status code and response headers
<p>Creates a new <code>Reader</code> object.</p> @required @param registration_code [String?] A code generated by the reader used for registering to an account. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param label [String?] Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. @optional @param location [String?] The location to assign the reader to. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::TerminalReader, Integer, Hash)] Stripe::TerminalReader, response status code and response headers