Retrieve a source

Changed on

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.

get/v1/sources/{source}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/sources/{source}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

sourcestring required

Query parameters

client_secretstring

The client secret of the source. Required if a publishable key is used to retrieve the source.

expandstring[]

Specifies which fields in the response should be expanded.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

allow_redisplay'always' | 'limited' | 'unspecified' nullable

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

amountinteger nullable

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_use sources.

client_secretstring required

The client secret of the source. Used for client-side retrieval using a publishable key.

createdinteger required

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

currencystring currency nullable

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_use sources.

customerstring

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.

flowstring required

The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject nullable

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.

object'source' required

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

statement_descriptorstring nullable

Extra information about a source. This will appear on your customer's statement every time you charge the source.

statusstring required

The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.

type'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'alipay' | 'au_becs_debit' | 'bancontact' | 'card' | 'card_present' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'sepa_debit' | 'sofort' | 'three_d_secure' | 'wechat' required

The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or 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.

usagestring nullable

Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.