POST
/
api
/
v2
/
storefront
/
checkout
/
create_payment
HttpResponse<String> response = Unirest.post("https://demo.spreecommerce.org/api/v2/storefront/checkout/create_payment")
.header("X-Spree-Order-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"payment_method_id\": \"1\",\n \"source_attributes\": {\n \"gateway_payment_profile_id\": \"card_1JqvNB2eZvKYlo2C5OlqLV7S\",\n \"cc_type\": \"visa\",\n \"last_digits\": \"1111\",\n \"month\": 10,\n \"year\": 2026,\n \"name\": \"John Snow\"\n }\n}")
.asString();
{
"data": {
"id": "17",
"type": "cart",
"attributes": {
"number": "R233871560",
"item_total": "0.0",
"total": "0.0",
"ship_total": "0.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",
"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",
"item_count": 0,
"special_instructions": null,
"display_total": "$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

The body is of type object.

Response

200
application/vnd.api+json

200 Success - Returns the cart object.

The response is of type object.