Authorization.php
6 months ago
Card.php
6 months ago
CardDetails.php
6 months ago
Cardholder.php
6 months ago
Dispute.php
6 months ago
PersonalizationDesign.php
6 months ago
PhysicalBundle.php
6 months ago
Token.php
6 months ago
Transaction.php
6 months ago
Cardholder.php
112 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace AmeliaVendor\Stripe\Issuing; |
| 5 | |
| 6 | /** |
| 7 | * An Issuing <code>Cardholder</code> object represents an individual or business entity who is <a href="https://stripe.com/docs/issuing">issued</a> cards. |
| 8 | * |
| 9 | * Related guide: <a href="https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder">How to create a cardholder</a> |
| 10 | * |
| 11 | * @property string $id Unique identifier for the object. |
| 12 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 13 | * @property (object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\AmeliaVendor\Stripe\StripeObject)}&\AmeliaVendor\Stripe\StripeObject) $billing |
| 14 | * @property null|(object{tax_id_provided: bool}&\AmeliaVendor\Stripe\StripeObject) $company Additional information about a <code>company</code> cardholder. |
| 15 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 16 | * @property null|string $email The cardholder's email address. |
| 17 | * @property null|(object{card_issuing?: null|(object{user_terms_acceptance: null|(object{date: null|int, ip: null|string, user_agent: null|string}&\AmeliaVendor\Stripe\StripeObject)}&\AmeliaVendor\Stripe\StripeObject), dob: null|(object{day: null|int, month: null|int, year: null|int}&\AmeliaVendor\Stripe\StripeObject), first_name: null|string, last_name: null|string, verification: null|(object{document: null|(object{back: null|string|\AmeliaVendor\Stripe\File, front: null|string|\AmeliaVendor\Stripe\File}&\AmeliaVendor\Stripe\StripeObject)}&\AmeliaVendor\Stripe\StripeObject)}&\AmeliaVendor\Stripe\StripeObject) $individual Additional information about an <code>individual</code> cardholder. |
| 18 | * @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. |
| 19 | * @property \AmeliaVendor\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. |
| 20 | * @property string $name The cardholder's name. This will be printed on cards issued to them. |
| 21 | * @property null|string $phone_number The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the <a href="https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied">3D Secure documentation</a> for more details. |
| 22 | * @property null|string[] $preferred_locales The cardholder’s preferred locales (languages), ordered by preference. Locales can be <code>de</code>, <code>en</code>, <code>es</code>, <code>fr</code>, or <code>it</code>. This changes the language of the <a href="https://stripe.com/docs/issuing/3d-secure">3D Secure flow</a> and one-time password messages sent to the cardholder. |
| 23 | * @property (object{disabled_reason: null|string, past_due: null|string[]}&\AmeliaVendor\Stripe\StripeObject) $requirements |
| 24 | * @property null|(object{allowed_categories: null|string[], allowed_merchant_countries: null|string[], blocked_categories: null|string[], blocked_merchant_countries: null|string[], spending_limits: null|((object{amount: int, categories: null|string[], interval: string}&\AmeliaVendor\Stripe\StripeObject))[], spending_limits_currency: null|string}&\AmeliaVendor\Stripe\StripeObject) $spending_controls Rules that control spending across this cardholder's cards. Refer to our <a href="https://stripe.com/docs/issuing/controls/spending-controls">documentation</a> for more details. |
| 25 | * @property string $status Specifies whether to permit authorizations on this cardholder's cards. |
| 26 | * @property string $type One of <code>individual</code> or <code>company</code>. See <a href="https://stripe.com/docs/issuing/other/choose-cardholder">Choose a cardholder type</a> for more details. |
| 27 | */ |
| 28 | class Cardholder extends \AmeliaVendor\Stripe\ApiResource |
| 29 | { |
| 30 | const OBJECT_NAME = 'issuing.cardholder'; |
| 31 | use \AmeliaVendor\Stripe\ApiOperations\Update; |
| 32 | const STATUS_ACTIVE = 'active'; |
| 33 | const STATUS_BLOCKED = 'blocked'; |
| 34 | const STATUS_INACTIVE = 'inactive'; |
| 35 | const TYPE_COMPANY = 'company'; |
| 36 | const TYPE_INDIVIDUAL = 'individual'; |
| 37 | /** |
| 38 | * Creates a new Issuing <code>Cardholder</code> object that can be issued cards. |
| 39 | * |
| 40 | * @param null|array{billing: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}}, company?: array{tax_id?: string}, email?: string, expand?: string[], individual?: array{card_issuing?: array{user_terms_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, dob?: array{day: int, month: int, year: int}, first_name?: string, last_name?: string, verification?: array{document?: array{back?: string, front?: string}}}, metadata?: array<string, string>, name: string, phone_number?: string, preferred_locales?: string[], spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[], spending_limits_currency?: string}, status?: string, type?: string} $params |
| 41 | * @param null|array|string $options |
| 42 | * |
| 43 | * @return Cardholder the created resource |
| 44 | * |
| 45 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 46 | */ |
| 47 | public static function create($params = null, $options = null) |
| 48 | { |
| 49 | self::_validateParams($params); |
| 50 | $url = static::classUrl(); |
| 51 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 52 | $obj = \AmeliaVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 53 | $obj->setLastResponse($response); |
| 54 | return $obj; |
| 55 | } |
| 56 | /** |
| 57 | * Returns a list of Issuing <code>Cardholder</code> objects. The objects are |
| 58 | * sorted in descending order by creation date, with the most recently created |
| 59 | * object appearing first. |
| 60 | * |
| 61 | * @param null|array{created?: array|int, email?: string, ending_before?: string, expand?: string[], limit?: int, phone_number?: string, starting_after?: string, status?: string, type?: string} $params |
| 62 | * @param null|array|string $opts |
| 63 | * |
| 64 | * @return \AmeliaVendor\Stripe\Collection<Cardholder> of ApiResources |
| 65 | * |
| 66 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 67 | */ |
| 68 | public static function all($params = null, $opts = null) |
| 69 | { |
| 70 | $url = static::classUrl(); |
| 71 | return static::_requestPage($url, \AmeliaVendor\Stripe\Collection::class, $params, $opts); |
| 72 | } |
| 73 | /** |
| 74 | * Retrieves an Issuing <code>Cardholder</code> object. |
| 75 | * |
| 76 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 77 | * @param null|array|string $opts |
| 78 | * |
| 79 | * @return Cardholder |
| 80 | * |
| 81 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 82 | */ |
| 83 | public static function retrieve($id, $opts = null) |
| 84 | { |
| 85 | $opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts); |
| 86 | $instance = new static($id, $opts); |
| 87 | $instance->refresh(); |
| 88 | return $instance; |
| 89 | } |
| 90 | /** |
| 91 | * Updates the specified Issuing <code>Cardholder</code> object by setting the |
| 92 | * values of the parameters passed. Any parameters not provided will be left |
| 93 | * unchanged. |
| 94 | * |
| 95 | * @param string $id the ID of the resource to update |
| 96 | * @param null|array{billing?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}}, company?: array{tax_id?: string}, email?: string, expand?: string[], individual?: array{card_issuing?: array{user_terms_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, dob?: array{day: int, month: int, year: int}, first_name?: string, last_name?: string, verification?: array{document?: array{back?: string, front?: string}}}, metadata?: array<string, string>, phone_number?: string, preferred_locales?: string[], spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[], spending_limits_currency?: string}, status?: string} $params |
| 97 | * @param null|array|string $opts |
| 98 | * |
| 99 | * @return Cardholder the updated resource |
| 100 | * |
| 101 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 102 | */ |
| 103 | public static function update($id, $params = null, $opts = null) |
| 104 | { |
| 105 | self::_validateParams($params); |
| 106 | $url = static::resourceUrl($id); |
| 107 | list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); |
| 108 | $obj = \AmeliaVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 109 | $obj->setLastResponse($response); |
| 110 | return $obj; |
| 111 | } |
| 112 | } |