%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
// File generated from our OpenAPI spec
namespace Stripe\Terminal;
/**
* A Reader represents a physical device for accepting payment details.
*
* Related guide: <a href="https://stripe.com/docs/terminal/payments/connect-reader">Connecting to a reader</a>
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property null|(object{collect_inputs?: (object{inputs: ((object{custom_text: null|(object{description: null|string, skip_button: null|string, submit_button: null|string, title: null|string}&\Stripe\StripeObject), email?: (object{value: null|string}&\Stripe\StripeObject), numeric?: (object{value: null|string}&\Stripe\StripeObject), phone?: (object{value: null|string}&\Stripe\StripeObject), required: null|bool, selection?: (object{choices: ((object{id: null|string, style: null|string, text: string}&\Stripe\StripeObject))[], id: null|string, text: null|string}&\Stripe\StripeObject), signature?: (object{value: null|string}&\Stripe\StripeObject), skipped?: bool, text?: (object{value: null|string}&\Stripe\StripeObject), toggles: null|((object{default_value: null|string, description: null|string, title: null|string, value: null|string}&\Stripe\StripeObject))[], type: string}&\Stripe\StripeObject))[], metadata: null|\Stripe\StripeObject}&\Stripe\StripeObject), failure_code: null|string, failure_message: null|string, process_payment_intent?: (object{payment_intent: string|\Stripe\PaymentIntent, process_config?: (object{enable_customer_cancellation?: bool, return_url?: string, skip_tipping?: bool, tipping?: (object{amount_eligible?: int}&\Stripe\StripeObject)}&\Stripe\StripeObject)}&\Stripe\StripeObject), process_setup_intent?: (object{generated_card?: string, process_config?: (object{enable_customer_cancellation?: bool}&\Stripe\StripeObject), setup_intent: string|\Stripe\SetupIntent}&\Stripe\StripeObject), refund_payment?: (object{amount?: int, charge?: string|\Stripe\Charge, metadata?: \Stripe\StripeObject, payment_intent?: string|\Stripe\PaymentIntent, reason?: string, refund?: string|\Stripe\Refund, refund_application_fee?: bool, refund_payment_config?: (object{enable_customer_cancellation?: bool}&\Stripe\StripeObject), reverse_transfer?: bool}&\Stripe\StripeObject), set_reader_display?: (object{cart: null|(object{currency: string, line_items: (object{amount: int, description: string, quantity: int}&\Stripe\StripeObject)[], tax: null|int, total: int}&\Stripe\StripeObject), type: string}&\Stripe\StripeObject), status: string, type: string}&\Stripe\StripeObject) $action The most recent action performed by the reader.
* @property null|string $device_sw_version The current software version of the reader.
* @property string $device_type Device type of the reader.
* @property null|string $ip_address The local IP address of the reader.
* @property string $label Custom label given to the reader for easier identification.
* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
* @property null|Location|string $location The location identifier of the reader.
* @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* @property string $serial_number Serial number of the reader.
* @property null|string $status The networking status of the reader. We do not recommend using this field in flows that may block taking payments.
*/
class Reader extends \Stripe\ApiResource
{
const OBJECT_NAME = 'terminal.reader';
use \Stripe\ApiOperations\Update;
const DEVICE_TYPE_BBPOS_CHIPPER2X = 'bbpos_chipper2x';
const DEVICE_TYPE_BBPOS_WISEPAD3 = 'bbpos_wisepad3';
const DEVICE_TYPE_BBPOS_WISEPOS_E = 'bbpos_wisepos_e';
const DEVICE_TYPE_MOBILE_PHONE_READER = 'mobile_phone_reader';
const DEVICE_TYPE_SIMULATED_STRIPE_S700 = 'simulated_stripe_s700';
const DEVICE_TYPE_SIMULATED_WISEPOS_E = 'simulated_wisepos_e';
const DEVICE_TYPE_STRIPE_M2 = 'stripe_m2';
const DEVICE_TYPE_STRIPE_S700 = 'stripe_s700';
const DEVICE_TYPE_VERIFONE_P400 = 'verifone_P400';
const STATUS_OFFLINE = 'offline';
const STATUS_ONLINE = 'online';
/**
* Creates a new <code>Reader</code> object.
*
* @param null|array{expand?: string[], label?: string, location?: string, metadata?: null|array<string, string>, registration_code: string} $params
* @param null|array|string $options
*
* @return Reader the created resource
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
* Deletes a <code>Reader</code> object.
*
* @param null|array $params
* @param null|array|string $opts
*
* @return Reader the deleted resource
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function delete($params = null, $opts = null)
{
self::_validateParams($params);
$url = $this->instanceUrl();
list($response, $opts) = $this->_request('delete', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
/**
* Returns a list of <code>Reader</code> objects.
*
* @param null|array{device_type?: string, ending_before?: string, expand?: string[], limit?: int, location?: string, serial_number?: string, starting_after?: string, status?: string} $params
* @param null|array|string $opts
*
* @return \Stripe\Collection<Reader> of ApiResources
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
}
/**
* Retrieves a <code>Reader</code> object.
*
* @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
* @param null|array|string $opts
*
* @return Reader
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
}
/**
* Updates a <code>Reader</code> object by setting the values of the parameters
* passed. Any parameters not provided will be left unchanged.
*
* @param string $id the ID of the resource to update
* @param null|array{expand?: string[], label?: null|string, metadata?: null|array<string, string>} $params
* @param null|array|string $opts
*
* @return Reader the updated resource
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public static function update($id, $params = null, $opts = null)
{
self::_validateParams($params);
$url = static::resourceUrl($id);
list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
* @param null|array $params
* @param null|array|string $opts
*
* @return Reader the canceled reader
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function cancelAction($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/cancel_action';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
/**
* @param null|array $params
* @param null|array|string $opts
*
* @return Reader the collected reader
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function collectInputs($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/collect_inputs';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
/**
* @param null|array $params
* @param null|array|string $opts
*
* @return Reader the processed reader
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function processPaymentIntent($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/process_payment_intent';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
/**
* @param null|array $params
* @param null|array|string $opts
*
* @return Reader the processed reader
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function processSetupIntent($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/process_setup_intent';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
/**
* @param null|array $params
* @param null|array|string $opts
*
* @return Reader the refunded reader
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function refundPayment($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/refund_payment';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
/**
* @param null|array $params
* @param null|array|string $opts
*
* @return Reader the seted reader
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function setReaderDisplay($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/set_reader_display';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
}
Zerion Mini Shell 1.0