Skip to main content
Manja / Stripe
Schema2020-08-27object

bitcoin_receiver

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

BitcoinReceiver

object
active boolean
required

True when this bitcoin receiver has received a non-zero amount of bitcoin.

amount integer
required

The amount of `currency` that you are collecting as payment.

amount_received integer
required

The amount of `currency` to which `bitcoin_amount_received` has been converted.

bitcoin_amount integer
required

The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.

bitcoin_amount_received integer
required

The amount of bitcoin that has been sent by the customer to this receiver.

bitcoin_uri string
required

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).

maxLength:5000

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string
required

Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted.

customer string
optionalnullable

The customer ID of the bitcoin receiver.

maxLength:5000

description string
optionalnullable

An arbitrary string attached to the object. Often useful for displaying to users.

maxLength:5000

email string
optionalnullable

The customer's email address, set by the API call that creates the receiver.

maxLength:5000

filled boolean
required

This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver.

id string
required

Unique identifier for the object.

maxLength:5000

inbound_address string
required

A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.

maxLength:5000

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata object
optionalnullable

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "bitcoin_receiver"

payment string
optionalnullable

The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.

maxLength:5000

refund_address string
optionalnullable

The refund address of this bitcoin receiver.

maxLength:5000

transactions BitcoinTransactionList object
optional

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.

uncaptured_funds boolean
required

This receiver contains uncaptured funds that can be used for a payment or refunded.

used_for_payment boolean
optionalnullable

Indicate if this source is used for payment.