Blocks
2 months ago
Concerns
6 months ago
Traits
2 weeks ago
Wordpress
1 year ago
AbandonedCheckout.php
1 year ago
AbandonedCheckoutProtocol.php
3 years ago
Account.php
10 months ago
AccountPortalSession.php
3 years ago
Activation.php
1 year ago
Affiliation.php
1 year ago
AffiliationProduct.php
1 year ago
AffiliationProtocol.php
2 years ago
AffiliationRequest.php
1 year ago
ApiToken.php
6 months ago
AutoFee.php
5 months ago
AutoFeeProtocol.php
5 months ago
BalanceTransaction.php
1 year ago
Batch.php
3 days ago
Brand.php
4 months ago
BulkAction.php
2 years ago
Bump.php
1 year ago
BuyLink.php
2 years ago
CancellationAct.php
1 year ago
CancellationReason.php
3 years ago
Charge.php
9 months ago
Checkout.php
2 months ago
Click.php
1 year ago
Collection.php
3 months ago
CommissionStructure.php
2 years ago
Component.php
4 months ago
Coupon.php
2 months ago
Customer.php
2 weeks ago
CustomerLink.php
3 years ago
CustomerNotificationProtocol.php
3 years ago
CustomerPortalProtocol.php
1 year ago
DatabaseModel.php
2 months ago
Discount.php
1 year ago
DisplayCurrency.php
1 year ago
Dispute.php
9 months ago
Download.php
3 years ago
Event.php
3 years ago
Export.php
2 years ago
ExternalApiModel.php
3 months ago
Fee.php
1 year ago
Form.php
3 years ago
Fulfillment.php
1 year ago
FulfillmentItem.php
1 year ago
GalleryItem.php
9 months ago
GalleryItemAttachment.php
5 months ago
GalleryItemImageAttachment.php
3 months ago
GalleryItemMedia.php
1 year ago
GalleryItemProductMedia.php
1 month ago
GalleryItemVideoAttachment.php
3 months ago
Import.php
6 months ago
ImportRow.php
2 months ago
IncomingWebhook.php
1 year ago
Integration.php
2 years ago
IntegrationCatalog.php
3 days ago
Invoice.php
1 year ago
License.php
1 year ago
LineItem.php
9 months ago
ManualPaymentMethod.php
1 year ago
Media.php
1 month ago
Model.php
3 days ago
ModelInterface.php
3 years ago
Order.php
2 weeks ago
OrderProtocol.php
3 years ago
ParcelTemplate.php
3 months ago
PaymentFailure.php
1 year ago
PaymentInstrument.php
2 months ago
PaymentIntent.php
1 year ago
PaymentMethod.php
1 year ago
Payout.php
1 year ago
PayoutGroup.php
2 years ago
Period.php
1 year ago
PlatformFee.php
1 year ago
PortalSession.php
3 years ago
Price.php
6 months ago
Processor.php
1 year ago
Product.php
3 days ago
ProductCollection.php
1 year ago
ProductCollectionImport.php
6 months ago
ProductGroup.php
1 year ago
ProductImport.php
6 months ago
ProductMedia.php
4 months ago
Promotion.php
1 year ago
ProvisionalAccount.php
2 months ago
Purchase.php
2 years ago
Referral.php
1 year ago
ReferralItem.php
2 years ago
Refund.php
1 year ago
RefundItem.php
1 year ago
RegisteredWebhook.php
2 months ago
ReturnItem.php
2 years ago
ReturnReason.php
2 years ago
ReturnRequest.php
1 year ago
Review.php
4 months ago
ReviewProtocol.php
4 months ago
RuleSchema.php
5 months ago
ServiceFee.php
1 year ago
ShippingChoice.php
1 year ago
ShippingMethod.php
3 years ago
ShippingProfile.php
3 years ago
ShippingProtocol.php
3 years ago
ShippingRate.php
3 years ago
ShippingZone.php
3 years ago
Statistic.php
3 years ago
Subscription.php
2 weeks ago
SubscriptionProtocol.php
3 years ago
Swap.php
1 year ago
TaxOverride.php
2 years ago
TaxProtocol.php
3 years ago
TaxRegistration.php
1 year ago
TaxZone.php
3 years ago
Upload.php
3 years ago
Upsell.php
1 year ago
UpsellFunnel.php
1 year ago
User.php
1 month ago
Variant.php
3 days ago
VariantOption.php
2 years ago
VariantOptionValue.php
1 year ago
VariantValue.php
2 years ago
VerificationCode.php
3 years ago
Webhook.php
1 year ago
WebhookRegistration.php
2 years ago
Charge.php
159 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Models; |
| 4 | |
| 5 | use SureCart\Models\Traits\HasCustomer; |
| 6 | use SureCart\Models\Traits\HasDates; |
| 7 | use SureCart\Models\Traits\HasDisputes; |
| 8 | use SureCart\Models\Traits\HasOrder; |
| 9 | use SureCart\Models\Traits\HasPaymentMethod; |
| 10 | use SureCart\Models\Traits\HasSubscription; |
| 11 | use SureCart\Models\Traits\HasPaymentIntent; |
| 12 | use SureCart\Support\Currency; |
| 13 | |
| 14 | /** |
| 15 | * Subscription model |
| 16 | */ |
| 17 | class Charge extends Model { |
| 18 | use HasCustomer; |
| 19 | use HasOrder; |
| 20 | use HasSubscription; |
| 21 | use HasDates; |
| 22 | use HasPaymentMethod; |
| 23 | use HasPaymentIntent; |
| 24 | use HasDisputes; |
| 25 | |
| 26 | /** |
| 27 | * Rest API endpoint |
| 28 | * |
| 29 | * @var string |
| 30 | */ |
| 31 | protected $endpoint = 'charges'; |
| 32 | |
| 33 | /** |
| 34 | * Object name |
| 35 | * |
| 36 | * @var string |
| 37 | */ |
| 38 | protected $object_name = 'charge'; |
| 39 | |
| 40 | /** |
| 41 | * Refund this specific charge |
| 42 | * |
| 43 | * @return \SureCart\Models\Refund |
| 44 | */ |
| 45 | protected function refund() { |
| 46 | return new Refund( [ 'charge' => $this->id ] ); |
| 47 | } |
| 48 | |
| 49 | /** |
| 50 | * Get the display amount attribute. |
| 51 | * |
| 52 | * @return string |
| 53 | */ |
| 54 | protected function getDisplayAmountAttribute() { |
| 55 | return Currency::format( $this->amount, $this->currency ); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Get the human discount attribute. |
| 60 | * |
| 61 | * @return string|null |
| 62 | */ |
| 63 | public function getExternalChargeLinkAttribute() { |
| 64 | if ( ! $this->payment_method || ! $this->payment_method->processor_type ) { |
| 65 | return null; |
| 66 | } |
| 67 | |
| 68 | $payment_type = $this->payment_method->processor_type; |
| 69 | |
| 70 | if ( ! in_array( $payment_type, [ 'stripe', 'paypal' ], true ) ) { |
| 71 | return null; |
| 72 | } |
| 73 | |
| 74 | if ( ! $this->external_charge_id ) { |
| 75 | return null; |
| 76 | } |
| 77 | |
| 78 | $external_charge_id = $this->external_charge_id; |
| 79 | $is_live_mode = $this->live_mode; |
| 80 | |
| 81 | if ( 'stripe' === $payment_type ) { |
| 82 | return 'https://dashboard.stripe.com/' . ( ! $is_live_mode ? 'test/' : '' ) . 'charges/' . $external_charge_id; |
| 83 | } |
| 84 | if ( 'paypal' === $payment_type ) { |
| 85 | return 'https://www.' . ( ! $is_live_mode ? 'sandbox.' : '' ) . 'paypal.com/activity/payment/' . $external_charge_id; |
| 86 | } |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Get the display amount attribute. |
| 91 | * |
| 92 | * @return string |
| 93 | */ |
| 94 | public function getAmountDisplayAmountAttribute() { |
| 95 | return Currency::format( $this->amount, $this->currency ); |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Get the refunded display amount attribute. |
| 100 | * |
| 101 | * @return string |
| 102 | */ |
| 103 | public function getRefundedDisplayAmountAttribute() { |
| 104 | return Currency::format( $this->refunded_amount, $this->currency ); |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Get the dispute status attribute. |
| 109 | * |
| 110 | * @return string |
| 111 | */ |
| 112 | public function getDisputeStatusAttribute(): string { |
| 113 | if ( ! $this->disputed_amount ) { |
| 114 | return ''; |
| 115 | } |
| 116 | |
| 117 | if ( ! empty( $this->disputes->data ) && count( $this->disputes->data ) > 1 ) { |
| 118 | return __( 'Multiple Disputes', 'surecart' ); |
| 119 | } |
| 120 | |
| 121 | return $this->disputes->data[0]->status_display ?? ''; |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * Get the dispute status type attribute. |
| 126 | * |
| 127 | * @return string |
| 128 | */ |
| 129 | public function getDisputeStatusTypeAttribute(): string { |
| 130 | if ( ! $this->disputed_amount ) { |
| 131 | return ''; |
| 132 | } |
| 133 | |
| 134 | if ( ! empty( $this->disputes->data ) && count( $this->disputes->data ) > 1 ) { |
| 135 | return 'warning'; |
| 136 | } |
| 137 | |
| 138 | return $this->disputes->data[0]->status_type ?? ''; |
| 139 | } |
| 140 | |
| 141 | /** |
| 142 | * Get the disputed amount attribute. |
| 143 | * |
| 144 | * @return string |
| 145 | */ |
| 146 | public function getDisputedDisplayAmountAttribute(): string { |
| 147 | return ! empty( $this->disputed_amount ) ? Currency::format( $this->disputed_amount, $this->currency ) : ''; |
| 148 | } |
| 149 | |
| 150 | /** |
| 151 | * Get the fully disputed attribute. |
| 152 | * |
| 153 | * @return bool |
| 154 | */ |
| 155 | public function getFullyDisputedAttribute(): bool { |
| 156 | return $this->disputed_amount && ( $this->disputed_amount >= $this->amount ); |
| 157 | } |
| 158 | } |
| 159 |