Authorization.php
2 years ago
Card.php
2 years ago
CardDetails.php
4 years ago
Cardholder.php
4 years ago
Dispute.php
2 years ago
Transaction.php
4 years ago
Authorization.php
82 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe\Issuing; |
| 6 | |
| 7 | /** |
| 8 | * When an <a href="https://stripe.com/docs/issuing">issued card</a> is used to |
| 9 | * make a purchase, an Issuing <code>Authorization</code> object is created. <a |
| 10 | * href="https://stripe.com/docs/issuing/purchases/authorizations">Authorizations</a> |
| 11 | * must be approved for the purchase to be completed successfully. |
| 12 | * |
| 13 | * Related guide: <a |
| 14 | * href="https://stripe.com/docs/issuing/purchases/authorizations">Issued Card |
| 15 | * Authorizations</a>. |
| 16 | * |
| 17 | * @property string $id Unique identifier for the object. |
| 18 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 19 | * @property int $amount The total amount that was authorized or rejected. This amount is in the card's currency and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. |
| 20 | * @property null|\Stripe\StripeObject $amount_details Detailed breakdown of amount components. These amounts are denominated in <code>currency</code> and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. |
| 21 | * @property bool $approved Whether the authorization has been approved. |
| 22 | * @property string $authorization_method How the card details were provided. |
| 23 | * @property \Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with this authorization. |
| 24 | * @property \Stripe\Issuing\Card $card You can <a href="https://stripe.com/docs/issuing/cards">create physical or virtual cards</a> that are issued to cardholders. |
| 25 | * @property null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this authorization belongs. |
| 26 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 27 | * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>. |
| 28 | * @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. |
| 29 | * @property int $merchant_amount The total amount that was authorized or rejected. This amount is in the <code>merchant_currency</code> and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. |
| 30 | * @property string $merchant_currency The currency that was presented to the cardholder for the authorization. Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>. |
| 31 | * @property \Stripe\StripeObject $merchant_data |
| 32 | * @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. |
| 33 | * @property null|\Stripe\StripeObject $pending_request The pending authorization request. This field will only be non-null during an <code>issuing_authorization.request</code> webhook. |
| 34 | * @property \Stripe\StripeObject[] $request_history History of every time <code>pending_request</code> was approved/denied, either by you directly or by Stripe (e.g. based on your <code>spending_controls</code>). If the merchant changes the authorization by performing an <a href="https://stripe.com/docs/issuing/purchases/authorizations">incremental authorization</a>, you can look at this field to see the previous requests for the authorization. |
| 35 | * @property string $status The current status of the authorization in its lifecycle. |
| 36 | * @property \Stripe\Issuing\Transaction[] $transactions List of <a href="https://stripe.com/docs/api/issuing/transactions">transactions</a> associated with this authorization. |
| 37 | * @property \Stripe\StripeObject $verification_data |
| 38 | * @property null|string $wallet The digital wallet used for this authorization. One of <code>apple_pay</code>, <code>google_pay</code>, or <code>samsung_pay</code>. |
| 39 | */ |
| 40 | class Authorization extends \Stripe\ApiResource |
| 41 | { |
| 42 | const OBJECT_NAME = 'issuing.authorization'; |
| 43 | |
| 44 | use \Stripe\ApiOperations\All; |
| 45 | use \Stripe\ApiOperations\Retrieve; |
| 46 | use \Stripe\ApiOperations\Update; |
| 47 | |
| 48 | /** |
| 49 | * @param null|array $params |
| 50 | * @param null|array|string $opts |
| 51 | * |
| 52 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 53 | * |
| 54 | * @return \Stripe\Issuing\Authorization the approved authorization |
| 55 | */ |
| 56 | public function approve($params = null, $opts = null) |
| 57 | { |
| 58 | $url = $this->instanceUrl() . '/approve'; |
| 59 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 60 | $this->refreshFrom($response, $opts); |
| 61 | |
| 62 | return $this; |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * @param null|array $params |
| 67 | * @param null|array|string $opts |
| 68 | * |
| 69 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 70 | * |
| 71 | * @return \Stripe\Issuing\Authorization the declined authorization |
| 72 | */ |
| 73 | public function decline($params = null, $opts = null) |
| 74 | { |
| 75 | $url = $this->instanceUrl() . '/decline'; |
| 76 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 77 | $this->refreshFrom($response, $opts); |
| 78 | |
| 79 | return $this; |
| 80 | } |
| 81 | } |
| 82 |