Create a card
When you create a new debit card, you must specify a connected account to create it on. You can only specify connected accounts where account.controller.requirement_collection is application (includes Custom accounts).
If the account has no default destination card, then the new card will become the default. However, if the owner already has a default then it will not change. To change the default, you should set default_for_currency to true.
Parameters
- external_
accountobject | stringRequired A token, like the ones returned by Stripe.js or a dictionary containing a user’s card details (with the options shown below). Stripe will automatically validate the card.
- 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
- default_
for_ currencyboolean
Returns
Returns the card object
{ "id": "card_1NAiaG2eZvKYlo2CDXvcMb6m", "object": "card", "account": "acct_1032D82eZvKYlo2C", "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}Update a card
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"}Retrieve a card
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
No parameters.
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"}List all cards
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_after 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" } {...} {...} ],}Delete a card
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_for_currency set to true. You cannot delete a card if any of the following apply:
- The card’s
currencyis 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_for_currency with another external account in the same currency.
Parameters
No parameters.
Returns
Returns the deleted card object.
{ "id": "card_1NAz2x2eZvKYlo2C75wJ1YUs", "object": "card", "deleted": true}