Create an ephemeral key

Changed on

Creates a short-lived API key for a given resource.

post/v1/ephemeral_keys

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/ephemeral_keys
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

customerstring

The ID of the Customer you'd like to modify using the resulting ephemeral key.

expandstring[]

Specifies which fields in the response should be expanded.

issuing_cardstring

The ID of the Issuing Card you'd like to access using the resulting ephemeral key.

noncestring

A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.

verification_sessionstring

The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key

Response

Successful response.

createdinteger required

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

expiresinteger required

Time at which the key will expire. Measured in seconds since the Unix epoch.

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.

object'ephemeral_key' required

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

secretstring

The key's secret. You can use this value to make authorized requests to the Stripe API.

Changes

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    This list may be incomplete.

    • info

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

Some revisions have not been checked yet.