Create new Payment

curl --request POST \
  --url https://demo.spreecommerce.org/api/v2/storefront/checkout/create_payment \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Spree-Order-Token: <api-key>' \
  --data '
{
  "payment_method_id": "1",
  "source_attributes": {
    "gateway_payment_profile_id": "card_1JqvNB2eZvKYlo2C5OlqLV7S",
    "cc_type": "visa",
    "last_digits": "1111",
    "month": 10,
    "year": 2026,
    "name": "John Snow"
  }
}
'

{
  "data": {
    "id": "17",
    "type": "cart",
    "attributes": {
      "number": "R233871560",
      "item_total": "0.0",
      "total": "0.0",
      "subtotal_cents": 0,
      "store_credit_total_cents": 0,
      "total_cents": 0,
      "total_minus_store_credits": "0.0",
      "total_minus_store_credits_cents": 0,
      "ship_total": "0.0",
      "ship_total_cents": 0,
      "adjustment_total": "0.0",
      "created_at": "2021-09-28T22:15:07.471Z",
      "updated_at": "2021-09-28T22:15:07.471Z",
      "completed_at": null,
      "included_tax_total": "0.0",
      "additional_tax_total": "0.0",
      "display_additional_tax_total": "$0.00",
      "display_included_tax_total": "$0.00",
      "tax_total": "0.0",
      "tax_total_cents": 0,
      "currency": "USD",
      "state": "cart",
      "token": "zTEpsukRq_yEUcXVCSv0uw1632867307450",
      "email": null,
      "display_item_total": "$0.00",
      "display_ship_total": "$0.00",
      "display_adjustment_total": "$0.00",
      "display_tax_total": "$0.00",
      "promo_total": "0.0",
      "display_promo_total": "$0.00",
      "promo_total_cents": 0,
      "item_count": 0,
      "special_instructions": null,
      "display_total": "$0.00",
      "display_total_minus_store_credits": "$0.00",
      "pre_tax_item_amount": "0.0",
      "display_pre_tax_item_amount": "$0.00",
      "pre_tax_total": "0.0",
      "display_pre_tax_total": "$0.00",
      "shipment_state": null,
      "payment_state": null
    },
    "relationships": {
      "line_items": {
        "data": []
      },
      "variants": {
        "data": []
      },
      "promotions": {
        "data": []
      },
      "payments": {
        "data": []
      },
      "shipments": {
        "data": []
      },
      "user": {
        "data": null
      },
      "billing_address": {
        "data": null
      },
      "shipping_address": {
        "data": null
      }
    }
  }
}

POST

api

storefront

checkout

create_payment

curl --request POST \
  --url https://demo.spreecommerce.org/api/v2/storefront/checkout/create_payment \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Spree-Order-Token: <api-key>' \
  --data '
{
  "payment_method_id": "1",
  "source_attributes": {
    "gateway_payment_profile_id": "card_1JqvNB2eZvKYlo2C5OlqLV7S",
    "cc_type": "visa",
    "last_digits": "1111",
    "month": 10,
    "year": 2026,
    "name": "John Snow"
  }
}
'

{
  "data": {
    "id": "17",
    "type": "cart",
    "attributes": {
      "number": "R233871560",
      "item_total": "0.0",
      "total": "0.0",
      "subtotal_cents": 0,
      "store_credit_total_cents": 0,
      "total_cents": 0,
      "total_minus_store_credits": "0.0",
      "total_minus_store_credits_cents": 0,
      "ship_total": "0.0",
      "ship_total_cents": 0,
      "adjustment_total": "0.0",
      "created_at": "2021-09-28T22:15:07.471Z",
      "updated_at": "2021-09-28T22:15:07.471Z",
      "completed_at": null,
      "included_tax_total": "0.0",
      "additional_tax_total": "0.0",
      "display_additional_tax_total": "$0.00",
      "display_included_tax_total": "$0.00",
      "tax_total": "0.0",
      "tax_total_cents": 0,
      "currency": "USD",
      "state": "cart",
      "token": "zTEpsukRq_yEUcXVCSv0uw1632867307450",
      "email": null,
      "display_item_total": "$0.00",
      "display_ship_total": "$0.00",
      "display_adjustment_total": "$0.00",
      "display_tax_total": "$0.00",
      "promo_total": "0.0",
      "display_promo_total": "$0.00",
      "promo_total_cents": 0,
      "item_count": 0,
      "special_instructions": null,
      "display_total": "$0.00",
      "display_total_minus_store_credits": "$0.00",
      "pre_tax_item_amount": "0.0",
      "display_pre_tax_item_amount": "$0.00",
      "pre_tax_total": "0.0",
      "display_pre_tax_total": "$0.00",
      "shipment_state": null,
      "payment_state": null
    },
    "relationships": {
      "line_items": {
        "data": []
      },
      "variants": {
        "data": []
      },
      "promotions": {
        "data": []
      },
      "payments": {
        "data": []
      },
      "shipments": {
        "data": []
      },
      "user": {
        "data": null
      },
      "billing_address": {
        "data": null
      },
      "shipping_address": {
        "data": null
      }
    }
  }
}

Authorizations

X-Spree-Order-Token

string

header

required

Order token to authorize Cart and Checkout requests.

How to obtain X-Spree-Order-Token

Query Parameters

include

string

Specify the related resources you would like to receive in the response body. More Information.

fields[cart]

string

Specify the fields you would like returned in the response body. More information.

Body

application/vnd.api+json

payment_method_id

string

required

ID of the selected Payment Method

source_id

string

ID of the selected Payment Source (eg. Credit Card, only for signed in users)

amount

number

Amount for the newly created payment, when left blank will use the entire Order Total (reduced by used Store Credits / Gift Cards)

source_attributes

object

Show child attributes

Response

200 Success - Returns the cart object.

data

Cart · object

required

The Cart provides a central place to collect information about an order, including line items, adjustments, payments, addresses, and shipments. Read more in Spree docs

Show child attributes

included

Show child attributes

List Shipping Rates

List Payment Methods

⌘I

API basics

Tutorials

Storefront API

Platform API

Authorizations

Query Parameters

Body

Response