Fail a testmode card

Changed on

Updates the shipping status of the specified Issuing Card object to failure.

post/v1/test_helpers/issuing/cards/{card}/shipping/fail

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/test_helpers/issuing/cards/{card}/shipping/fail
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

cardstring required

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

brandstring required

The brand of the card.

cancellation_reason'design_rejected' | 'fulfillment_error' | 'lost' | 'stolen' nullable

The reason why the card was canceled.

createdinteger required

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

currencystring currency required

Three-letter ISO currency code, in lowercase. Supported currencies are usd in the US, eur in the EU, and gbp in the UK.

cvcstring

The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it's only available via the "Retrieve a card" endpoint, not via "List all cards" or any other endpoint.

exp_monthinteger required

The expiration month of the card.

exp_yearinteger required

The expiration year of the card.

financial_accountstring nullable

The financial account this card is attached to.

idstring required

Unique identifier for the object.

last4string required

The last 4 digits of the card number.

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 required

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.

numberstring

The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it's only available via the "Retrieve a card" endpoint, not via "List all cards" or any other endpoint.

object'issuing.card' required

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

replacement_reason'damaged' | 'expired' | 'fulfillment_error' | 'lost' | 'stolen' nullable

The reason why the previous card needed to be replaced.

second_linestring nullable

Text separate from cardholder name, printed on the card.

status'active' | 'canceled' | 'inactive' required

Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive.

type'physical' | 'virtual' required

The type of the card.

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.