Return a Stripe Payment Intent

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/stripe/payment_intents/{id} \
  --header 'X-Spree-Order-Token: <api-key>'

{
  "data": {
    "id": "980a80d5-f51b-4065-b3a0-622fc5cb6bf6",
    "type": "payment_intent",
    "attributes": {
      "stripe_id": "pi_3QhUuj2ESifGlJez0ADSS4tu",
      "client_secret": "pi_3KQRG2DcAgmy0ota09WCW6nf_secret_8XTxRbOyg7oEkvvIOvnP75dRw",
      "ephemeral_key_secret": "ek_test_YWNjdF8xTGtSb1lJaFIwZ0llZ0llyG1LbFhsVU9XWHY1SlNyMXRKVzNJb0hyQ2JZam1HY28_007lGgvGaA",
      "customer_id": "cus_Q9uqUz6gVQFku2",
      "amount": "44.0",
      "stripe_payment_method_id": "pm_1Qedd42ESifGlJez0IOx5AZ3"
    }
  }
}

GET

api

storefront

stripe

payment_intents

{id}

Return a Stripe Payment Intent

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/stripe/payment_intents/{id} \
  --header 'X-Spree-Order-Token: <api-key>'

{
  "data": {
    "id": "980a80d5-f51b-4065-b3a0-622fc5cb6bf6",
    "type": "payment_intent",
    "attributes": {
      "stripe_id": "pi_3QhUuj2ESifGlJez0ADSS4tu",
      "client_secret": "pi_3KQRG2DcAgmy0ota09WCW6nf_secret_8XTxRbOyg7oEkvvIOvnP75dRw",
      "ephemeral_key_secret": "ek_test_YWNjdF8xTGtSb1lJaFIwZ0llZ0llyG1LbFhsVU9XWHY1SlNyMXRKVzNJb0hyQ2JZam1HY28_007lGgvGaA",
      "customer_id": "cus_Q9uqUz6gVQFku2",
      "amount": "44.0",
      "stripe_payment_method_id": "pm_1Qedd42ESifGlJez0IOx5AZ3"
    }
  }
}

Authorizations

X-Spree-Order-Token

string

header

required

Order token to authorize Cart and Checkout requests.

How to obtain X-Spree-Order-Token

Response

200 Success - Returns the Stripe Payment Intent with the Stripe ID, client key, ephemeral_key, customer_id, amount and Stripe Payment Method ID.

data

object

Show child attributes

data.id

string

Example:

"980a80d5-f51b-4065-b3a0-622fc5cb6bf6"

data.type

string

default:payment_intent

data.attributes

object

Show child attributes

data.attributes.stripe_id

string

The Stripe internal ID of the Payment Intent

data.attributes.client_secret

string

The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

data.attributes.ephemeral_key_secret

string

Secret of the created ephemeral key.

data.attributes.customer_id

string

Stripe's customer ID of the authenticated user (or new one if unauthenticated).

data.attributes.amount

number

The payment amount

data.attributes.stripe_payment_method_id

string

This is the same stripe_payment_method_id that was sent in the parameters. It can be used to confirm Stripe intent that was not confirmed before

Remove Store Credit

Create a Stripe Payment Intent

⌘I

API basics

Tutorials

Storefront API

Platform API

Return a Stripe Payment Intent

Authorizations

Response