ApiOperations
6 years ago
Checkout
6 years ago
Error
6 years ago
HttpClient
6 years ago
Issuing
6 years ago
Radar
6 years ago
Reporting
6 years ago
Sigma
6 years ago
Terminal
6 years ago
Util
6 years ago
Account.php
6 years ago
AccountLink.php
6 years ago
AlipayAccount.php
6 years ago
ApiRequestor.php
6 years ago
ApiResource.php
6 years ago
ApiResponse.php
6 years ago
ApplePayDomain.php
6 years ago
ApplicationFee.php
6 years ago
ApplicationFeeRefund.php
6 years ago
Balance.php
6 years ago
BalanceTransaction.php
6 years ago
BankAccount.php
6 years ago
BitcoinReceiver.php
6 years ago
BitcoinTransaction.php
6 years ago
Capability.php
6 years ago
Card.php
6 years ago
Charge.php
6 years ago
Collection.php
6 years ago
CountrySpec.php
6 years ago
Coupon.php
6 years ago
CreditNote.php
6 years ago
Customer.php
6 years ago
CustomerBalanceTransaction.php
6 years ago
Discount.php
6 years ago
Dispute.php
6 years ago
EphemeralKey.php
6 years ago
Event.php
6 years ago
ExchangeRate.php
6 years ago
File.php
6 years ago
FileLink.php
6 years ago
FileUpload.php
6 years ago
Invoice.php
6 years ago
InvoiceItem.php
6 years ago
InvoiceLineItem.php
6 years ago
IssuerFraudRecord.php
6 years ago
LoginLink.php
6 years ago
OAuth.php
6 years ago
Order.php
6 years ago
OrderItem.php
6 years ago
OrderReturn.php
6 years ago
PaymentIntent.php
6 years ago
PaymentMethod.php
6 years ago
Payout.php
6 years ago
Person.php
6 years ago
Plan.php
6 years ago
Product.php
6 years ago
Recipient.php
6 years ago
RecipientTransfer.php
6 years ago
Refund.php
6 years ago
RequestTelemetry.php
6 years ago
Review.php
6 years ago
SKU.php
6 years ago
SetupIntent.php
6 years ago
SingletonApiResource.php
6 years ago
Source.php
6 years ago
SourceTransaction.php
6 years ago
Stripe.php
6 years ago
StripeObject.php
6 years ago
Subscription.php
6 years ago
SubscriptionItem.php
6 years ago
SubscriptionSchedule.php
6 years ago
TaxId.php
6 years ago
TaxRate.php
6 years ago
ThreeDSecure.php
6 years ago
Token.php
6 years ago
Topup.php
6 years ago
Transfer.php
6 years ago
TransferReversal.php
6 years ago
UsageRecord.php
6 years ago
UsageRecordSummary.php
6 years ago
Webhook.php
6 years ago
WebhookEndpoint.php
6 years ago
WebhookSignature.php
6 years ago
Payout.php
93 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Stripe; |
| 4 | |
| 5 | /** |
| 6 | * Class Payout |
| 7 | * |
| 8 | * @property string $id |
| 9 | * @property string $object |
| 10 | * @property int $amount |
| 11 | * @property int $arrival_date |
| 12 | * @property bool $automatic |
| 13 | * @property string $balance_transaction |
| 14 | * @property int $created |
| 15 | * @property string $currency |
| 16 | * @property string $description |
| 17 | * @property string $destination |
| 18 | * @property string $failure_balance_transaction |
| 19 | * @property string $failure_code |
| 20 | * @property string $failure_message |
| 21 | * @property bool $livemode |
| 22 | * @property StripeObject $metadata |
| 23 | * @property string $method |
| 24 | * @property string $source_type |
| 25 | * @property string $statement_descriptor |
| 26 | * @property string $status |
| 27 | * @property string $type |
| 28 | * |
| 29 | * @package Stripe |
| 30 | */ |
| 31 | class Payout extends ApiResource |
| 32 | { |
| 33 | const OBJECT_NAME = "payout"; |
| 34 | |
| 35 | use ApiOperations\All; |
| 36 | use ApiOperations\Create; |
| 37 | use ApiOperations\Retrieve; |
| 38 | use ApiOperations\Update; |
| 39 | |
| 40 | /** |
| 41 | * Types of payout failure codes. |
| 42 | * @link https://stripe.com/docs/api#payout_failures |
| 43 | */ |
| 44 | const FAILURE_ACCOUNT_CLOSED = 'account_closed'; |
| 45 | const FAILURE_ACCOUNT_FROZEN = 'account_frozen'; |
| 46 | const FAILURE_BANK_ACCOUNT_RESTRICTED = 'bank_account_restricted'; |
| 47 | const FAILURE_BANK_OWNERSHIP_CHANGED = 'bank_ownership_changed'; |
| 48 | const FAILURE_COULD_NOT_PROCESS = 'could_not_process'; |
| 49 | const FAILURE_DEBIT_NOT_AUTHORIZED = 'debit_not_authorized'; |
| 50 | const FAILURE_DECLINED = 'declined'; |
| 51 | const FAILURE_INCORRECT_ACCOUNT_HOLDER_NAME = 'incorrect_account_holder_name'; |
| 52 | const FAILURE_INSUFFICIENT_FUNDS = 'insufficient_funds'; |
| 53 | const FAILURE_INVALID_ACCOUNT_NUMBER = 'invalid_account_number'; |
| 54 | const FAILURE_INVALID_CURRENCY = 'invalid_currency'; |
| 55 | const FAILURE_NO_ACCOUNT = 'no_account'; |
| 56 | const FAILURE_UNSUPPORTED_CARD = 'unsupported_card'; |
| 57 | |
| 58 | /** |
| 59 | * Possible string representations of the payout methods. |
| 60 | * @link https://stripe.com/docs/api/payouts/object#payout_object-method |
| 61 | */ |
| 62 | const METHOD_STANDARD = 'standard'; |
| 63 | const METHOD_INSTANT = 'instant'; |
| 64 | |
| 65 | /** |
| 66 | * Possible string representations of the status of the payout. |
| 67 | * @link https://stripe.com/docs/api/payouts/object#payout_object-status |
| 68 | */ |
| 69 | const STATUS_CANCELED = 'canceled'; |
| 70 | const STATUS_IN_TRANSIT = 'in_transit'; |
| 71 | const STATUS_FAILED = 'failed'; |
| 72 | const STATUS_PAID = 'paid'; |
| 73 | const STATUS_PENDING = 'pending'; |
| 74 | |
| 75 | /** |
| 76 | * Possible string representations of the type of payout. |
| 77 | * @link https://stripe.com/docs/api/payouts/object#payout_object-type |
| 78 | */ |
| 79 | const TYPE_BANK_ACCOUNT = 'bank_account'; |
| 80 | const TYPE_CARD = 'card'; |
| 81 | |
| 82 | /** |
| 83 | * @return Payout The canceled payout. |
| 84 | */ |
| 85 | public function cancel() |
| 86 | { |
| 87 | $url = $this->instanceUrl() . '/cancel'; |
| 88 | list($response, $opts) = $this->_request('post', $url); |
| 89 | $this->refreshFrom($response, $opts); |
| 90 | return $this; |
| 91 | } |
| 92 | } |
| 93 |