# bitcoin\_receiver From **Stripe API**. - Type: `object` ## Properties ### `active` - Required: true - Type: `boolean` True when this bitcoin receiver has received a non-zero amount of bitcoin. ### `amount` - Required: true - Type: `integer` The amount of `currency` that you are collecting as payment. ### `amount_received` - Required: true - Type: `integer` The amount of `currency` to which `bitcoin_amount_received` has been converted. ### `bitcoin_amount` - Required: true - Type: `integer` 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` - Required: true - Type: `integer` The amount of bitcoin that has been sent by the customer to this receiver. ### `bitcoin_uri` - Required: true - Type: `string` - maxLength: `5000` 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). ### `created` - Required: true - Type: `integer` - Format: `unix-time` Time at which the object was created. Measured in seconds since the Unix epoch. ### `currency` - Required: true - Type: `string` Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. ### `customer` - Required: false - Type: `string` - Nullable: true - maxLength: `5000` The customer ID of the bitcoin receiver. ### `description` - Required: false - Type: `string` - Nullable: true - maxLength: `5000` An arbitrary string attached to the object. Often useful for displaying to users. ### `email` - Required: false - Type: `string` - Nullable: true - maxLength: `5000` The customer's email address, set by the API call that creates the receiver. ### `filled` - Required: true - Type: `boolean` This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. ### `id` - Required: true - Type: `string` - maxLength: `5000` Unique identifier for the object. ### `inbound_address` - Required: true - Type: `string` - maxLength: `5000` A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. ### `livemode` - Required: true - Type: `boolean` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. ### `metadata` - Required: false - Type: `object` - Nullable: true 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` - Required: true - Type: `string` - Allowed values: `"bitcoin_receiver"` String representing the object's type. Objects of the same type share the same value. ### `payment` - Required: false - Type: `string` - Nullable: true - maxLength: `5000` The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. ### `refund_address` - Required: false - Type: `string` - Nullable: true - maxLength: `5000` The refund address of this bitcoin receiver. ### `transactions` - Required: false - Type: `object` 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` - Required: true - Type: `boolean` This receiver contains uncaptured funds that can be used for a payment or refunded. ### `used_for_payment` - Required: false - Type: `boolean` - Nullable: true Indicate if this source is used for payment. ## JSON Schema ```json {"properties":{"active":{"description":"True when this bitcoin receiver has received a non-zero amount of bitcoin.","type":"boolean"},"amount":{"description":"The amount of `currency` that you are collecting as payment.","type":"integer"},"amount_received":{"description":"The amount of `currency` to which `bitcoin_amount_received` has been converted.","type":"integer"},"bitcoin_amount":{"description":"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.","type":"integer"},"bitcoin_amount_received":{"description":"The amount of bitcoin that has been sent by the customer to this receiver.","type":"integer"},"bitcoin_uri":{"description":"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,"type":"string"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"currency":{"description":"Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted.","type":"string"},"customer":{"description":"The customer ID of the bitcoin receiver.","maxLength":5000,"nullable":true,"type":"string"},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","maxLength":5000,"nullable":true,"type":"string"},"email":{"description":"The customer's email address, set by the API call that creates the receiver.","maxLength":5000,"nullable":true,"type":"string"},"filled":{"description":"This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver.","type":"boolean"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"inbound_address":{"description":"A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"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.","nullable":true,"type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["bitcoin_receiver"],"type":"string"},"payment":{"description":"The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.","maxLength":5000,"nullable":true,"type":"string"},"refund_address":{"description":"The refund address of this bitcoin receiver.","maxLength":5000,"nullable":true,"type":"string"},"transactions":{"description":"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.","properties":{"data":{"description":"Details about each object.","items":{"$ref":"#/components/schemas/bitcoin_transaction"},"type":"array"},"has_more":{"description":"True if this list has another page of items after this one that can be fetched.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"],"type":"string"},"url":{"description":"The URL where this list can be accessed.","maxLength":5000,"type":"string"}},"required":["data","has_more","object","url"],"title":"BitcoinTransactionList","type":"object","x-expandableFields":["data"]},"uncaptured_funds":{"description":"This receiver contains uncaptured funds that can be used for a payment or refunded.","type":"boolean"},"used_for_payment":{"description":"Indicate if this source is used for payment.","nullable":true,"type":"boolean"}},"required":["active","amount","amount_received","bitcoin_amount","bitcoin_amount_received","bitcoin_uri","created","currency","filled","id","inbound_address","livemode","object","uncaptured_funds"],"title":"BitcoinReceiver","type":"object","x-expandableFields":["transactions"],"x-resourceId":"bitcoin_receiver"} ```