Create a payment request session
Description
Start a Shop Pay payment request session for a cart or order. The `sourceIdentifier` is your own identifier for that cart or order, and must be unique for each session. The response returns a `token` and a `checkoutUrl`: the Shop Pay JavaScript SDK opens the `checkoutUrl`, and you finish the session by passing the `token` and the final payment request to `shopPayPaymentRequestSessionSubmit`.
Query
mutation ShopPayPaymentRequestSessionCreate($sourceIdentifier: String!) {
shopPayPaymentRequestSessionCreate(sourceIdentifier: $sourceIdentifier) {
shopPayPaymentRequestSession {
token
sourceIdentifier
checkoutUrl
}
userErrors {
field
message
code
}
}
}
Variables
{
"sourceIdentifier": "cart-5ee2c7a1"
}
cURL
curl -X POST \
https://your-development-store.myshopify.com/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation ShopPayPaymentRequestSessionCreate($sourceIdentifier: String!) { shopPayPaymentRequestSessionCreate(sourceIdentifier: $sourceIdentifier) { shopPayPaymentRequestSession { token sourceIdentifier checkoutUrl } userErrors { field message code } } }",
"variables": {
"sourceIdentifier": "cart-5ee2c7a1"
}
}'
React Router
import { unauthenticated } from "../shopify.server";
export const loader = async () => {
const { storefront } = await unauthenticated.storefront(
'your-development-store.myshopify.com'
);
const response = await storefront.graphql(
`#graphql
mutation ShopPayPaymentRequestSessionCreate($sourceIdentifier: String!) {
shopPayPaymentRequestSessionCreate(sourceIdentifier: $sourceIdentifier) {
shopPayPaymentRequestSession {
token
sourceIdentifier
checkoutUrl
}
userErrors {
field
message
code
}
}
}`,
{
variables: {
"sourceIdentifier": "cart-5ee2c7a1"
},
},
);
const json = await response.json();
return json.data;
}
Node.js
const client = new shopify.clients.Storefront({
domain: 'your-development-store.myshopify.com',
storefrontAccessToken,
});
const data = await client.query({
data: {
"query": `mutation ShopPayPaymentRequestSessionCreate($sourceIdentifier: String!) {
shopPayPaymentRequestSessionCreate(sourceIdentifier: $sourceIdentifier) {
shopPayPaymentRequestSession {
token
sourceIdentifier
checkoutUrl
}
userErrors {
field
message
code
}
}
}`,
"variables": {
"sourceIdentifier": "cart-5ee2c7a1"
},
},
});
Response
{
"shopPayPaymentRequestSessionCreate": {
"shopPayPaymentRequestSession": {
"token": "a1b2c3d4e5f6",
"sourceIdentifier": "cart-5ee2c7a1",
"checkoutUrl": "https://shop.app/checkout/1/spe/a1b2c3d4e5f6/shoppay"
},
"userErrors": []
}
}
Create a payment request session with an initial payment request
Description
Start a Shop Pay payment request session for a cart or order, with an initial payment request that describes the cart: its line items, subtotal, total, locale and presentment currency. The `sourceIdentifier` is your own identifier for that cart or order, and must be unique for each session. The response returns a `token` and a `checkoutUrl` that the Shop Pay JavaScript SDK opens, and you finish the session with `shopPayPaymentRequestSessionSubmit` using that `token`. The `paymentRequest` argument is deprecated from API version 2026-10: newer integrations create the session with only a `sourceIdentifier`, and pass the final payment request to `shopPayPaymentRequestSessionSubmit` instead.
Query
mutation ShopPayPaymentRequestSessionCreate($sourceIdentifier: String!, $paymentRequest: ShopPayPaymentRequestInput!) {
shopPayPaymentRequestSessionCreate(sourceIdentifier: $sourceIdentifier, paymentRequest: $paymentRequest) {
shopPayPaymentRequestSession {
token
sourceIdentifier
checkoutUrl
}
userErrors {
field
message
code
}
}
}
Variables
{
"sourceIdentifier": "cart-7f3b9d24",
"paymentRequest": {
"lineItems": [
{
"label": "Snowboard",
"quantity": 1,
"originalItemPrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"finalItemPrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"originalLinePrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"finalLinePrice": {
"amount": "120.00",
"currencyCode": "USD"
}
}
],
"subtotal": {
"amount": "120.00",
"currencyCode": "USD"
},
"total": {
"amount": "120.00",
"currencyCode": "USD"
},
"locale": "en",
"presentmentCurrency": "USD"
}
}
cURL
curl -X POST \
https://your-development-store.myshopify.com/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation ShopPayPaymentRequestSessionCreate($sourceIdentifier: String!, $paymentRequest: ShopPayPaymentRequestInput!) { shopPayPaymentRequestSessionCreate(sourceIdentifier: $sourceIdentifier, paymentRequest: $paymentRequest) { shopPayPaymentRequestSession { token sourceIdentifier checkoutUrl } userErrors { field message code } } }",
"variables": {
"sourceIdentifier": "cart-7f3b9d24",
"paymentRequest": {
"lineItems": [
{
"label": "Snowboard",
"quantity": 1,
"originalItemPrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"finalItemPrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"originalLinePrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"finalLinePrice": {
"amount": "120.00",
"currencyCode": "USD"
}
}
],
"subtotal": {
"amount": "120.00",
"currencyCode": "USD"
},
"total": {
"amount": "120.00",
"currencyCode": "USD"
},
"locale": "en",
"presentmentCurrency": "USD"
}
}
}'
React Router
import { unauthenticated } from "../shopify.server";
export const loader = async () => {
const { storefront } = await unauthenticated.storefront(
'your-development-store.myshopify.com'
);
const response = await storefront.graphql(
`#graphql
mutation ShopPayPaymentRequestSessionCreate($sourceIdentifier: String!, $paymentRequest: ShopPayPaymentRequestInput!) {
shopPayPaymentRequestSessionCreate(sourceIdentifier: $sourceIdentifier, paymentRequest: $paymentRequest) {
shopPayPaymentRequestSession {
token
sourceIdentifier
checkoutUrl
}
userErrors {
field
message
code
}
}
}`,
{
variables: {
"sourceIdentifier": "cart-7f3b9d24",
"paymentRequest": {
"lineItems": [
{
"label": "Snowboard",
"quantity": 1,
"originalItemPrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"finalItemPrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"originalLinePrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"finalLinePrice": {
"amount": "120.00",
"currencyCode": "USD"
}
}
],
"subtotal": {
"amount": "120.00",
"currencyCode": "USD"
},
"total": {
"amount": "120.00",
"currencyCode": "USD"
},
"locale": "en",
"presentmentCurrency": "USD"
}
},
},
);
const json = await response.json();
return json.data;
}
Node.js
const client = new shopify.clients.Storefront({
domain: 'your-development-store.myshopify.com',
storefrontAccessToken,
});
const data = await client.query({
data: {
"query": `mutation ShopPayPaymentRequestSessionCreate($sourceIdentifier: String!, $paymentRequest: ShopPayPaymentRequestInput!) {
shopPayPaymentRequestSessionCreate(sourceIdentifier: $sourceIdentifier, paymentRequest: $paymentRequest) {
shopPayPaymentRequestSession {
token
sourceIdentifier
checkoutUrl
}
userErrors {
field
message
code
}
}
}`,
"variables": {
"sourceIdentifier": "cart-7f3b9d24",
"paymentRequest": {
"lineItems": [
{
"label": "Snowboard",
"quantity": 1,
"originalItemPrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"finalItemPrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"originalLinePrice": {
"amount": "120.00",
"currencyCode": "USD"
},
"finalLinePrice": {
"amount": "120.00",
"currencyCode": "USD"
}
}
],
"subtotal": {
"amount": "120.00",
"currencyCode": "USD"
},
"total": {
"amount": "120.00",
"currencyCode": "USD"
},
"locale": "en",
"presentmentCurrency": "USD"
}
},
},
});
Response
{
"shopPayPaymentRequestSessionCreate": {
"shopPayPaymentRequestSession": {
"token": "a1b2c3d4e5f6",
"sourceIdentifier": "cart-7f3b9d24",
"checkoutUrl": "https://shop.app/checkout/1/spe/a1b2c3d4e5f6/shoppay"
},
"userErrors": []
}
}