Create new cart

Initialise the cart with shippingAddress, basket items, descriptions and amounts for example and these will be used in the checkout workflow.

SecurityapiKeyAuth
Request
Request Body schema: application/json
checkoutId
required
string <uuid>

The checkout that this cart should be created from.

expiryTimeMinutes
integer or null

If provided, how many minutes the cart and associated downstream payment sessions will be active for.

transferId
required
string <uuid>

Used to establish a connection between bridge and checkout.

merchantCartId
required
string

The id of the cart in the merchant's records. Displayed as order reference in merchant portal.

required
object (Transaction)
object
object (shippingDetails)
object (ShippingAddress)

The address the items will be shipped to.

testMode
boolean
Default: false

If set to true, this will be a test cart.

returnUrl
string

Custom return URL - overrides the checkout's return URL.

Responses
200

successful operation

post/carts
Request samples
application/json
{
  • "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
  • "expiryTimeMinutes": 0,
  • "transferId": "e240f72a-b0bc-4f57-ab86-5b78f1d8ea9b",
  • "merchantCartId": "string",
  • "transaction": {
    },
  • "basket": {
    },
  • "shippingDetails": {
    },
  • "shippingAddress": {
    },
  • "testMode": false,
  • "returnUrl": "string"
}
Response samples
application/json
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}