123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191 |
- <?php
- namespace Stripe;
- /**
- * Class Charge
- *
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int $amount_refunded
- * @property string $application
- * @property string $application_fee
- * @property string $balance_transaction
- * @property bool $captured
- * @property int $created
- * @property string $currency
- * @property string $customer
- * @property string $description
- * @property string $destination
- * @property string $dispute
- * @property string $failure_code
- * @property string $failure_message
- * @property mixed $fraud_details
- * @property string $invoice
- * @property bool $livemode
- * @property StripeObject $metadata
- * @property string $on_behalf_of
- * @property string $order
- * @property mixed $outcome
- * @property bool $paid
- * @property string $receipt_email
- * @property string $receipt_number
- * @property bool $refunded
- * @property Collection $refunds
- * @property string $review
- * @property mixed $shipping
- * @property mixed $source
- * @property string $source_transfer
- * @property string $statement_descriptor
- * @property string $status
- * @property string $transfer
- * @property string $transfer_group
- *
- * @package Stripe
- */
- class Charge extends ApiResource
- {
- const OBJECT_NAME = "charge";
- use ApiOperations\All;
- use ApiOperations\Create;
- use ApiOperations\Retrieve;
- use ApiOperations\Update;
- /**
- * Possible string representations of decline codes.
- * These strings are applicable to the decline_code property of the \Stripe\Error\Card exception.
- * @link https://stripe.com/docs/declines/codes
- */
- const DECLINED_APPROVE_WITH_ID = 'approve_with_id';
- const DECLINED_CALL_ISSUER = 'call_issuer';
- const DECLINED_CARD_NOT_SUPPORTED = 'card_not_supported';
- const DECLINED_CARD_VELOCITY_EXCEEDED = 'card_velocity_exceeded';
- const DECLINED_CURRENCY_NOT_SUPPORTED = 'currency_not_supported';
- const DECLINED_DO_NOT_HONOR = 'do_not_honor';
- const DECLINED_DO_NOT_TRY_AGAIN = 'do_not_try_again';
- const DECLINED_DUPLICATED_TRANSACTION = 'duplicate_transaction';
- const DECLINED_EXPIRED_CARD = 'expired_card';
- const DECLINED_FRAUDULENT = 'fraudulent';
- const DECLINED_GENERIC_DECLINE = 'generic_decline';
- const DECLINED_INCORRECT_NUMBER = 'incorrect_number';
- const DECLINED_INCORRECT_CVC = 'incorrect_cvc';
- const DECLINED_INCORRECT_PIN = 'incorrect_pin';
- const DECLINED_INCORRECT_ZIP = 'incorrect_zip';
- const DECLINED_INSUFFICIENT_FUNDS = 'insufficient_funds';
- const DECLINED_INVALID_ACCOUNT = 'invalid_account';
- const DECLINED_INVALID_AMOUNT = 'invalid_amount';
- const DECLINED_INVALID_CVC = 'invalid_cvc';
- const DECLINED_INVALID_EXPIRY_YEAR = 'invalid_expiry_year';
- const DECLINED_INVALID_NUMBER = 'invalid_number';
- const DECLINED_INVALID_PIN = 'invalid_pin';
- const DECLINED_ISSUER_NOT_AVAILABLE = 'issuer_not_available';
- const DECLINED_LOST_CARD = 'lost_card';
- const DECLINED_NEW_ACCOUNT_INFORMATION_AVAILABLE = 'new_account_information_available';
- const DECLINED_NO_ACTION_TAKEN = 'no_action_taken';
- const DECLINED_NOT_PERMITTED = 'not_permitted';
- const DECLINED_PICKUP_CARD = 'pickup_card';
- const DECLINED_PIN_TRY_EXCEEDED = 'pin_try_exceeded';
- const DECLINED_PROCESSING_ERROR = 'processing_error';
- const DECLINED_REENTER_TRANSACTION = 'reenter_transaction';
- const DECLINED_RESTRICTED_CARD = 'restricted_card';
- const DECLINED_REVOCATION_OF_ALL_AUTHORIZATIONS = 'revocation_of_all_authorizations';
- const DECLINED_REVOCATION_OF_AUTHORIZATION = 'revocation_of_authorization';
- const DECLINED_SECURITY_VIOLATION = 'security_violation';
- const DECLINED_SERVICE_NOT_ALLOWED = 'service_not_allowed';
- const DECLINED_STOLEN_CARD = 'stolen_card';
- const DECLINED_STOP_PAYMENT_ORDER = 'stop_payment_order';
- const DECLINED_TESTMODE_DECLINE = 'testmode_decline';
- const DECLINED_TRANSACTION_NOT_ALLOWED = 'transaction_not_allowed';
- const DECLINED_TRY_AGAIN_LATER = 'try_again_later';
- const DECLINED_WITHDRAWAL_COUNT_LIMIT_EXCEEDED = 'withdrawal_count_limit_exceeded';
- /**
- * @param array|null $params
- * @param array|string|null $options
- *
- * @return Charge The refunded charge.
- */
- public function refund($params = null, $options = null)
- {
- $url = $this->instanceUrl() . '/refund';
- list($response, $opts) = $this->_request('post', $url, $params, $options);
- $this->refreshFrom($response, $opts);
- return $this;
- }
- /**
- * @param array|null $params
- * @param array|string|null $options
- *
- * @return Charge The captured charge.
- */
- public function capture($params = null, $options = null)
- {
- $url = $this->instanceUrl() . '/capture';
- list($response, $opts) = $this->_request('post', $url, $params, $options);
- $this->refreshFrom($response, $opts);
- return $this;
- }
- /**
- * @param array|null $params
- * @param array|string|null $options
- *
- * @deprecated Use the `save` method on the Dispute object
- *
- * @return array The updated dispute.
- */
- public function updateDispute($params = null, $options = null)
- {
- $url = $this->instanceUrl() . '/dispute';
- list($response, $opts) = $this->_request('post', $url, $params, $options);
- $this->refreshFrom(['dispute' => $response], $opts, true);
- return $this->dispute;
- }
- /**
- * @param array|string|null $options
- *
- * @deprecated Use the `close` method on the Dispute object
- *
- * @return Charge The updated charge.
- */
- public function closeDispute($options = null)
- {
- $url = $this->instanceUrl() . '/dispute/close';
- list($response, $opts) = $this->_request('post', $url, null, $options);
- $this->refreshFrom($response, $opts);
- return $this;
- }
- /**
- * @param array|string|null $opts
- *
- * @return Charge The updated charge.
- */
- public function markAsFraudulent($opts = null)
- {
- $params = ['fraud_details' => ['user_report' => 'fraudulent']];
- $url = $this->instanceUrl();
- list($response, $opts) = $this->_request('post', $url, $params, $opts);
- $this->refreshFrom($response, $opts);
- return $this;
- }
- /**
- * @param array|string|null $opts
- *
- * @return Charge The updated charge.
- */
- public function markAsSafe($opts = null)
- {
- $params = ['fraud_details' => ['user_report' => 'safe']];
- $url = $this->instanceUrl();
- list($response, $opts) = $this->_request('post', $url, $params, $opts);
- $this->refreshFrom($response, $opts);
- return $this;
- }
- }
|