ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
BitcoinReceiver.php
72 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * @deprecated Bitcoin receivers are deprecated. Please use the sources API instead. |
| 9 | * @see https://stripe.com/docs/sources/bitcoin |
| 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 bool $active True when this bitcoin receiver has received a non-zero amount of bitcoin. |
| 14 | * @property int $amount The amount of <code>currency</code> that you are collecting as payment. |
| 15 | * @property int $amount_received The amount of <code>currency</code> to which <code>bitcoin_amount_received</code> has been converted. |
| 16 | * @property int $bitcoin_amount The amount of bitcoin that the customer should send to fill the receiver. The <code>bitcoin_amount</code> is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. |
| 17 | * @property int $bitcoin_amount_received The amount of bitcoin that has been sent by the customer to this receiver. |
| 18 | * @property string $bitcoin_uri This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). |
| 19 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 20 | * @property string $currency Three-letter <a href="https://stripe.com/docs/currencies">ISO code for the currency</a> to which the bitcoin will be converted. |
| 21 | * @property null|string $customer The customer ID of the bitcoin receiver. |
| 22 | * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 23 | * @property null|string $email The customer's email address, set by the API call that creates the receiver. |
| 24 | * @property bool $filled This flag is initially false and updates to true when the customer sends the <code>bitcoin_amount</code> to this receiver. |
| 25 | * @property string $inbound_address A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. |
| 26 | * @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. |
| 27 | * @property null|\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. |
| 28 | * @property null|string $payment The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. |
| 29 | * @property null|string $refund_address The refund address of this bitcoin receiver. |
| 30 | * @property \Stripe\Collection<\Stripe\BitcoinTransaction> $transactions A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. |
| 31 | * @property bool $uncaptured_funds This receiver contains uncaptured funds that can be used for a payment or refunded. |
| 32 | * @property null|bool $used_for_payment Indicate if this source is used for payment. |
| 33 | */ |
| 34 | class BitcoinReceiver extends ApiResource |
| 35 | { |
| 36 | const OBJECT_NAME = 'bitcoin_receiver'; |
| 37 | |
| 38 | use ApiOperations\All; |
| 39 | use ApiOperations\Retrieve; |
| 40 | |
| 41 | /** |
| 42 | * @return string The class URL for this resource. It needs to be special |
| 43 | * cased because it doesn't fit into the standard resource pattern. |
| 44 | */ |
| 45 | public static function classUrl() |
| 46 | { |
| 47 | return '/v1/bitcoin/receivers'; |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * @return string The instance URL for this resource. It needs to be special |
| 52 | * cased because it doesn't fit into the standard resource pattern. |
| 53 | */ |
| 54 | public function instanceUrl() |
| 55 | { |
| 56 | if ($this['customer']) { |
| 57 | $base = Customer::classUrl(); |
| 58 | $parent = $this['customer']; |
| 59 | $path = 'sources'; |
| 60 | $parentExtn = \urlencode(Util\Util::utf8($parent)); |
| 61 | $extn = \urlencode(Util\Util::utf8($this['id'])); |
| 62 | |
| 63 | return "{$base}/{$parentExtn}/{$path}/{$extn}"; |
| 64 | } |
| 65 | |
| 66 | $base = BitcoinReceiver::classUrl(); |
| 67 | $extn = \urlencode(Util\Util::utf8($this['id'])); |
| 68 | |
| 69 | return "{$base}/{$extn}"; |
| 70 | } |
| 71 | } |
| 72 |