The Source objectDeprecated
Attributes
- idstring
Unique identifier for the object.
- amountnullable integer
A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for
single_
sources.use - currencynullable enum
Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for
single_
sources.use - customernullable string
The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
- metadatanullable object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- ownernullable object
Information about the owner of the payment instrument that may be used or required by particular source types.
- redirectnullable object
Information related to the redirect flow. Present if the source is authenticated by a redirect (
flow
isredirect
). - statement_
descriptornullable string Extra information about a source. This will appear on your customer’s statement every time you charge the source.
- statusstring
The status of the source, one of
canceled
,chargeable
,consumed
,failed
, orpending
. Onlychargeable
sources can be used to create a charge. - typeenum
The
type
of the source. Thetype
is a payment method, one ofach_
,credit_ transfer ach_
,debit alipay
,bancontact
,card
,card_
,present eps
,giropay
,ideal
,multibanco
,klarna
,p24
,sepa_
,debit sofort
,three_
, ord_ secure wechat
. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.Possible enum valuesach_
credit_ transfer ach_
debit alipay
bancontact
card
card_
present eps
giropay
ideal
klarna
Show 6 more
More attributes
- objectstring
- client_
secretstring - code_
verificationnullable object - createdtimestamp
- flowstring
- livemodeboolean
- receivernullable object
- source_
ordernullable object - usagenullable string
{ "id": "src_1N3lxdLkdIwHu7ixPHXy8UcI", "object": "source", "ach_credit_transfer": { "account_number": "test_eb829353ed79", "bank_name": "TEST BANK", "fingerprint": "kBQsBk9KtfCgjEYK", "refund_account_holder_name": null, "refund_account_holder_type": null, "refund_routing_number": null, "routing_number": "110000000", "swift_code": "TSTEZ122" }, "amount": null, "client_secret": "src_client_secret_ZaOIRUD8a9uGmQobLxGvqKSr", "created": 1683144457, "currency": "usd", "flow": "receiver", "livemode": false, "metadata": {}, "owner": { "address": null, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": null, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "110000000-test_eb829353ed79", "amount_charged": 0, "amount_received": 0, "amount_returned": 0, "refund_attributes_method": "email", "refund_attributes_status": "missing" }, "statement_descriptor": null, "status": "pending", "type": "ach_credit_transfer", "usage": "reusable"}
Creates a new source object.
Parameters
- typestringRequired
The
type
of the source to create. Required unlesscustomer
andoriginal_
are specified (see the Cloning card Sources guide)source - amountinteger
Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for
single_
sources. Not supported foruse receiver
type sources, where charge amount may not be specified until funds land. - currencyenum
Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - ownerobject
Information about the owner of the payment instrument that may be used or required by particular source types.
- redirectobject
Parameters required for the redirect flow. Required if the source is authenticated by a redirect (
flow
isredirect
). - statement_
descriptorstring An arbitrary string to be displayed on your customer’s statement. As an example, if your website is
RunClub
and the item you’re charging for is a race ticket, you may want to specify astatement_
ofdescriptor RunClub 5K race ticket.
While many payment types will display this information, some may not display it at all.
More parameters
- flowstring
- mandateobject
- receiverobject
- source_
orderobject - tokenstring
- usagestring
Returns
Returns a newly created source.
{ "id": "src_1N3lxdLkdIwHu7ixPHXy8UcI", "object": "source", "ach_credit_transfer": { "account_number": "test_eb829353ed79", "bank_name": "TEST BANK", "fingerprint": "kBQsBk9KtfCgjEYK", "refund_account_holder_name": null, "refund_account_holder_type": null, "refund_routing_number": null, "routing_number": "110000000", "swift_code": "TSTEZ122" }, "amount": null, "client_secret": "src_client_secret_ZaOIRUD8a9uGmQobLxGvqKSr", "created": 1683144457, "currency": "usd", "flow": "receiver", "livemode": false, "metadata": {}, "owner": { "address": null, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": null, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "110000000-test_eb829353ed79", "amount_charged": 0, "amount_received": 0, "amount_returned": 0, "refund_attributes_method": "email", "refund_attributes_status": "missing" }, "statement_descriptor": null, "status": "pending", "type": "ach_credit_transfer", "usage": "reusable"}
Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts the metadata
and owner
as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.
Parameters
- amountinteger
Amount associated with the source.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - ownerobject
Information about the owner of the payment instrument that may be used or required by particular source types.
More parameters
- mandateobject
- source_
orderobject
Returns
Returns the source object if the update succeeded. This call will raise an error if update parameters are invalid.
{ "id": "src_1N3lxdLkdIwHu7ixPHXy8UcI", "object": "source", "ach_credit_transfer": { "account_number": "test_eb829353ed79", "bank_name": "TEST BANK", "fingerprint": "kBQsBk9KtfCgjEYK", "refund_account_holder_name": null, "refund_account_holder_type": null, "refund_routing_number": null, "routing_number": "110000000", "swift_code": "TSTEZ122" }, "amount": null, "client_secret": "src_client_secret_ZaOIRUD8a9uGmQobLxGvqKSr", "created": 1683144457, "currency": "usd", "flow": "receiver", "livemode": false, "metadata": { "order_id": "6735" }, "owner": { "address": null, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": null, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "110000000-test_eb829353ed79", "amount_charged": 0, "amount_received": 0, "amount_returned": 0, "refund_attributes_method": "email", "refund_attributes_status": "missing" }, "statement_descriptor": null, "status": "pending", "type": "ach_credit_transfer", "usage": "reusable"}
Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
Parameters
No parameters.
More parameters
- client_
secretstring
Returns
Returns a source if a valid identifier was provided.
{ "id": "src_1N3lxdLkdIwHu7ixPHXy8UcI", "object": "source", "ach_credit_transfer": { "account_number": "test_eb829353ed79", "bank_name": "TEST BANK", "fingerprint": "kBQsBk9KtfCgjEYK", "refund_account_holder_name": null, "refund_account_holder_type": null, "refund_routing_number": null, "routing_number": "110000000", "swift_code": "TSTEZ122" }, "amount": null, "client_secret": "src_client_secret_ZaOIRUD8a9uGmQobLxGvqKSr", "created": 1683144457, "currency": "usd", "flow": "receiver", "livemode": false, "metadata": {}, "owner": { "address": null, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": null, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "110000000-test_eb829353ed79", "amount_charged": 0, "amount_received": 0, "amount_returned": 0, "refund_attributes_method": "email", "refund_attributes_status": "missing" }, "statement_descriptor": null, "status": "pending", "type": "ach_credit_transfer", "usage": "reusable"}
Attaches a Source object to a Customer. The source must be in a chargeable or pending state.
Parameters
- sourcestringRequired
The identifier of the source to be attached.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
Returns
Returns the attached Source object.
{ "id": "src_1NfRGv2eZvKYlo2Cv7NAImBL", "object": "source", "ach_credit_transfer": { "account_number": "test_52796e3294dc", "routing_number": "110000000", "fingerprint": "ecpwEzmBOSMOqQTL", "bank_name": "TEST BANK", "swift_code": "TSTEZ122" }, "amount": 1000, "client_secret": "src_client_secret_sBqfX18eq6GPfGxGvVfMByCp", "created": 1692121393, "currency": "usd", "customer": "cus_9s6XKzkNRiz8i3", "flow": "receiver", "livemode": false, "metadata": {}, "owner": { "address": null, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": null, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "121042882-38381234567890123", "amount_received": 1000, "amount_charged": 0, "amount_returned": 0, "refund_attributes_status": "missing", "refund_attributes_method": "email" }, "redaction": null, "statement_descriptor": null, "status": "chargeable", "type": "ach_credit_transfer", "usage": "reusable"}