You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
121 lines
4.4 KiB
121 lines
4.4 KiB
<?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|\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 Type of reader, one of <code>bbpos_wisepad3</code>, <code>stripe_m2</code>, <code>bbpos_chipper2x</code>, <code>bbpos_wisepos_e</code>, <code>verifone_P400</code>, or <code>simulated_wisepos_e</code>.
|
|
* @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|string|\Stripe\Terminal\Location $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.
|
|
*/
|
|
class Reader extends \Stripe\ApiResource
|
|
{
|
|
const OBJECT_NAME = 'terminal.reader';
|
|
|
|
use \Stripe\ApiOperations\All;
|
|
use \Stripe\ApiOperations\Create;
|
|
use \Stripe\ApiOperations\Delete;
|
|
use \Stripe\ApiOperations\Retrieve;
|
|
use \Stripe\ApiOperations\Update;
|
|
|
|
/**
|
|
* @param null|array $params
|
|
* @param null|array|string $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Terminal\Reader the canceled reader
|
|
*/
|
|
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
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Terminal\Reader the processed reader
|
|
*/
|
|
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
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Terminal\Reader the processed reader
|
|
*/
|
|
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
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Terminal\Reader the refunded reader
|
|
*/
|
|
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
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Terminal\Reader the seted reader
|
|
*/
|
|
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;
|
|
}
|
|
}
|
|
|