Orders

Release an order checkout

Ends the order checkout session when the checkout page is left and returns its held credits. A session whose payment has started keeps its hold. With session_id, a session that is no longer the order open current session is left alone; with page_id, a session another page opened or took over is left alone, and an unowned one ends only when it is the given session_id.

post/teams/{slug}/orders/{order_id}/checkout/release

Request

  • Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.presscart.com/teams/{slug}/orders/{order_id}/checkout/release
  • Auth: HTTP bearer

Path parameters

slugstring required
Example:team-a
order_idstring uuid required
Example:0b0f4d0e-5a51-4a0a-9a39-3a5a4c1f2b6d

Request body

session_idstring

The session the left page mounted. Alone, only that session is released and only while it is the order's open current session; with page_id, it is released only when no page owns it and it is the order's open current session

page_idstring uuid

The left checkout page load; when given, the order's open session is released only while that page owns it, or when no page owns it and it is the given session_id

Example request

{
  "session_id": "cs_test_a1b2c3d4e5f6g7h8i9j0",
  "page_id": "8f2c1e4a-6b7d-4c3e-9a1f-2d5b8e0c7a64"
}

Response

Released, or nothing to release

releasedboolean required

False when nothing was released or a payment has started

Changes

No recorded changes to this operation across all 2 revisions of this API.