If you need to update only some card details, like the billing address or expiration date, you can do so without having to re-enter the full card details. Stripe also works directly with card networks so that your customers can continue using your service without interruption.
Parameters
- default_
for_ currencyboolean When set to true, this becomes the default external account for its currency.
- 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
.
More parameters
- address_
citystring - address_
countrystring - address_
line1string - address_
line2string - address_
statestring - address_
zipstring - exp_
monthstring - exp_
yearstring - namestring
Returns
Returns the card object.
{ "id": "card_1NBLeN2eZvKYlo2CIq1o7Pzs", "object": "card", "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "cvc_check": "pass", "dynamic_last4": null, "exp_month": 8, "exp_year": 2024, "fingerprint": "Xt5EWLLDS7FJjR1c", "funding": "credit", "last4": "4242", "metadata": { "order_id": "6735" }, "name": "Jenny Rosen", "redaction": null, "tokenization_method": null, "wallet": null, "account": "acct_1032D82eZvKYlo2C"}
By default, you can see the 10 most recent external accounts stored on a connected account directly on the object. You can also retrieve details about a specific card stored on the account.
Parameters
- idstringRequired
Unique identifier for the external account to be retrieved.
Returns
Returns the card object.
{ "id": "card_1NAinb2eZvKYlo2C1Fm9mZsu", "object": "card", "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "cvc_check": "pass", "dynamic_last4": null, "exp_month": 8, "exp_year": 2024, "fingerprint": "Xt5EWLLDS7FJjR1c", "funding": "credit", "last4": "4242", "metadata": {}, "name": null, "redaction": null, "tokenization_method": null, "wallet": null, "account": "acct_1032D82eZvKYlo2C"}
You can see a list of the cards that belong to a connected account. The 10 most recent external accounts are available on the account object. If you need more than 10, you can use this API method and the limit
and starting_
parameters to page through additional cards.
Parameters
No parameters.
More parameters
- ending_
beforestring - limitinteger
- objectstring
- starting_
afterstring
Returns
Returns a list of the cards stored on the account.
{ "object": "list", "url": "/v1/accounts/acct_1032D82eZvKYlo2C/external_accounts", "has_more": false, "data": [ { "id": "card_1NAz2x2eZvKYlo2C75wJ1YUs", "object": "card", "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "cvc_check": "pass", "dynamic_last4": null, "exp_month": 8, "exp_year": 2024, "fingerprint": "Xt5EWLLDS7FJjR1c", "funding": "credit", "last4": "4242", "metadata": {}, "name": null, "redaction": null, "tokenization_method": null, "wallet": null, "account": "acct_1032D82eZvKYlo2C" } ]}
You can delete cards from a connected account where controller.requirement_collection is application
(includes Custom accounts).
There are restrictions for deleting a card with default_
set to true. You cannot delete a card if any of the following apply:
- The card’s
currency
is the same as the connected account’s default_currency. - There is another external account (card or bank account) with the same currency as the card.
To delete a card, you must first replace the default external account by setting default_
with another external account in the same currency.
Parameters
- idstringRequired
Unique identifier for the external account to be deleted.
Returns
Returns the deleted card object.
{ "id": "card_1NAz2x2eZvKYlo2C75wJ1YUs", "object": "card", "deleted": true}
This is an object representing a person associated with a Stripe account.
A platform can only access a subset of data in a person for an account where account.controller.requirement_collection is stripe
, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.