Current File : /home2/selectio/www/fms-worksuite/vendor/square/square/src/Models/CreateCardRequest.php
<?php
declare(strict_types=1);
namespace Square\Models;
use stdClass;
/**
* Creates a card from the source (nonce, payment id, etc). Accessible via
* HTTP requests at POST https://connect.squareup.com/v2/cards
*/
class CreateCardRequest implements \JsonSerializable
{
/**
* @var string
*/
private $idempotencyKey;
/**
* @var string
*/
private $sourceId;
/**
* @var string|null
*/
private $verificationToken;
/**
* @var Card
*/
private $card;
/**
* @param string $idempotencyKey
* @param string $sourceId
* @param Card $card
*/
public function __construct(string $idempotencyKey, string $sourceId, Card $card)
{
$this->idempotencyKey = $idempotencyKey;
$this->sourceId = $sourceId;
$this->card = $card;
}
/**
* Returns Idempotency Key.
*
* A unique string that identifies this CreateCard request. Keys can be
* any valid string and must be unique for every request.
*
* Max: 45 characters
*
* See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more
* information.
*/
public function getIdempotencyKey(): string
{
return $this->idempotencyKey;
}
/**
* Sets Idempotency Key.
*
* A unique string that identifies this CreateCard request. Keys can be
* any valid string and must be unique for every request.
*
* Max: 45 characters
*
* See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more
* information.
*
* @required
* @maps idempotency_key
*/
public function setIdempotencyKey(string $idempotencyKey): void
{
$this->idempotencyKey = $idempotencyKey;
}
/**
* Returns Source Id.
*
* The ID of the source which represents the card information to be stored. This can be a card nonce or
* a payment id.
*/
public function getSourceId(): string
{
return $this->sourceId;
}
/**
* Sets Source Id.
*
* The ID of the source which represents the card information to be stored. This can be a card nonce or
* a payment id.
*
* @required
* @maps source_id
*/
public function setSourceId(string $sourceId): void
{
$this->sourceId = $sourceId;
}
/**
* Returns Verification Token.
*
* An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.
* com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).
* Verification tokens encapsulate customer device information and 3-D Secure
* challenge results to indicate that Square has verified the buyer identity.
*
* See the [SCA Overview](https://developer.squareup.com/docs/sca-overview).
*/
public function getVerificationToken(): ?string
{
return $this->verificationToken;
}
/**
* Sets Verification Token.
*
* An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.
* com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).
* Verification tokens encapsulate customer device information and 3-D Secure
* challenge results to indicate that Square has verified the buyer identity.
*
* See the [SCA Overview](https://developer.squareup.com/docs/sca-overview).
*
* @maps verification_token
*/
public function setVerificationToken(?string $verificationToken): void
{
$this->verificationToken = $verificationToken;
}
/**
* Returns Card.
*
* Represents the payment details of a card to be used for payments. These
* details are determined by the payment token generated by Web Payments SDK.
*/
public function getCard(): Card
{
return $this->card;
}
/**
* Sets Card.
*
* Represents the payment details of a card to be used for payments. These
* details are determined by the payment token generated by Web Payments SDK.
*
* @required
* @maps card
*/
public function setCard(Card $card): void
{
$this->card = $card;
}
/**
* Encode this object to JSON
*
* @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields
* are set. (default: false)
*
* @return mixed
*/
public function jsonSerialize(bool $asArrayWhenEmpty = false)
{
$json = [];
$json['idempotency_key'] = $this->idempotencyKey;
$json['source_id'] = $this->sourceId;
if (isset($this->verificationToken)) {
$json['verification_token'] = $this->verificationToken;
}
$json['card'] = $this->card;
$json = array_filter($json, function ($val) {
return $val !== null;
});
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
}
}
Mini Shell