Authorization.php
2 months ago
Card.php
2 months ago
CardDetails.php
2 months ago
Cardholder.php
2 months ago
Dispute.php
2 months ago
PersonalizationDesign.php
2 months ago
PhysicalBundle.php
2 months ago
Token.php
2 months ago
Transaction.php
2 months ago
Card.php
125 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Issuing; |
| 5 | |
| 6 | /** |
| 7 | * You can <a href="https://stripe.com/docs/issuing">create physical or virtual cards</a> that are issued to cardholders. |
| 8 | * |
| 9 | * @property string $id Unique identifier for the object. |
| 10 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 11 | * @property string $brand The brand of the card. |
| 12 | * @property null|string $cancellation_reason The reason why the card was canceled. |
| 13 | * @property \Stripe\Issuing\Cardholder $cardholder <p>An Issuing <code>Cardholder</code> object represents an individual or business entity who is <a href="https://stripe.com/docs/issuing">issued</a> cards.</p><p>Related guide: <a href="https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder">How to create a cardholder</a></p> |
| 14 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 15 | * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Supported currencies are <code>usd</code> in the US, <code>eur</code> in the EU, and <code>gbp</code> in the UK. |
| 16 | * @property null|string $cvc The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with <a href="https://stripe.com/docs/api/expanding_objects">the <code>expand</code> parameter</a>. Additionally, it's only available via the <a href="https://stripe.com/docs/api/issuing/cards/retrieve">"Retrieve a card" endpoint</a>, not via "List all cards" or any other endpoint. |
| 17 | * @property int $exp_month The expiration month of the card. |
| 18 | * @property int $exp_year The expiration year of the card. |
| 19 | * @property null|string $financial_account The financial account this card is attached to. |
| 20 | * @property string $last4 The last 4 digits of the card number. |
| 21 | * @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. |
| 22 | * @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. |
| 23 | * @property null|string $number The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with <a href="https://stripe.com/docs/api/expanding_objects">the <code>expand</code> parameter</a>. Additionally, it's only available via the <a href="https://stripe.com/docs/api/issuing/cards/retrieve">"Retrieve a card" endpoint</a>, not via "List all cards" or any other endpoint. |
| 24 | * @property null|string|\Stripe\Issuing\PersonalizationDesign $personalization_design The personalization design object belonging to this card. |
| 25 | * @property null|string|\Stripe\Issuing\Card $replaced_by The latest card that replaces this card, if any. |
| 26 | * @property null|string|\Stripe\Issuing\Card $replacement_for The card this card replaces, if any. |
| 27 | * @property null|string $replacement_reason The reason why the previous card needed to be replaced. |
| 28 | * @property null|\Stripe\StripeObject $shipping Where and how the card will be shipped. |
| 29 | * @property \Stripe\StripeObject $spending_controls |
| 30 | * @property string $status Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to <code>inactive</code>. |
| 31 | * @property string $type The type of the card. |
| 32 | * @property null|\Stripe\StripeObject $wallets Information relating to digital wallets (like Apple Pay and Google Pay). |
| 33 | */ |
| 34 | class Card extends \ProfilePressVendor\Stripe\ApiResource |
| 35 | { |
| 36 | const OBJECT_NAME = 'issuing.card'; |
| 37 | use \ProfilePressVendor\Stripe\ApiOperations\Update; |
| 38 | const CANCELLATION_REASON_DESIGN_REJECTED = 'design_rejected'; |
| 39 | const CANCELLATION_REASON_LOST = 'lost'; |
| 40 | const CANCELLATION_REASON_STOLEN = 'stolen'; |
| 41 | const REPLACEMENT_REASON_DAMAGED = 'damaged'; |
| 42 | const REPLACEMENT_REASON_EXPIRED = 'expired'; |
| 43 | const REPLACEMENT_REASON_LOST = 'lost'; |
| 44 | const REPLACEMENT_REASON_STOLEN = 'stolen'; |
| 45 | const STATUS_ACTIVE = 'active'; |
| 46 | const STATUS_CANCELED = 'canceled'; |
| 47 | const STATUS_INACTIVE = 'inactive'; |
| 48 | const TYPE_PHYSICAL = 'physical'; |
| 49 | const TYPE_VIRTUAL = 'virtual'; |
| 50 | /** |
| 51 | * Creates an Issuing <code>Card</code> object. |
| 52 | * |
| 53 | * @param null|array $params |
| 54 | * @param null|array|string $options |
| 55 | * |
| 56 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 57 | * |
| 58 | * @return \Stripe\Issuing\Card the created resource |
| 59 | */ |
| 60 | public static function create($params = null, $options = null) |
| 61 | { |
| 62 | self::_validateParams($params); |
| 63 | $url = static::classUrl(); |
| 64 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 65 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 66 | $obj->setLastResponse($response); |
| 67 | return $obj; |
| 68 | } |
| 69 | /** |
| 70 | * Returns a list of Issuing <code>Card</code> objects. The objects are sorted in |
| 71 | * descending order by creation date, with the most recently created object |
| 72 | * appearing first. |
| 73 | * |
| 74 | * @param null|array $params |
| 75 | * @param null|array|string $opts |
| 76 | * |
| 77 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 78 | * |
| 79 | * @return \Stripe\Collection<\Stripe\Issuing\Card> of ApiResources |
| 80 | */ |
| 81 | public static function all($params = null, $opts = null) |
| 82 | { |
| 83 | $url = static::classUrl(); |
| 84 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 85 | } |
| 86 | /** |
| 87 | * Retrieves an Issuing <code>Card</code> object. |
| 88 | * |
| 89 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 90 | * @param null|array|string $opts |
| 91 | * |
| 92 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 93 | * |
| 94 | * @return \Stripe\Issuing\Card |
| 95 | */ |
| 96 | public static function retrieve($id, $opts = null) |
| 97 | { |
| 98 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 99 | $instance = new static($id, $opts); |
| 100 | $instance->refresh(); |
| 101 | return $instance; |
| 102 | } |
| 103 | /** |
| 104 | * Updates the specified Issuing <code>Card</code> object by setting the values of |
| 105 | * the parameters passed. Any parameters not provided will be left unchanged. |
| 106 | * |
| 107 | * @param string $id the ID of the resource to update |
| 108 | * @param null|array $params |
| 109 | * @param null|array|string $opts |
| 110 | * |
| 111 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 112 | * |
| 113 | * @return \Stripe\Issuing\Card the updated resource |
| 114 | */ |
| 115 | public static function update($id, $params = null, $opts = null) |
| 116 | { |
| 117 | self::_validateParams($params); |
| 118 | $url = static::resourceUrl($id); |
| 119 | list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); |
| 120 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 121 | $obj->setLastResponse($response); |
| 122 | return $obj; |
| 123 | } |
| 124 | } |
| 125 |