Abandon a payment session
Marks a session as ABANDONED — the customer closed the checkout, or you decided the session is no longer wanted. Abandoning is the clean way to end a session you will not use, rather than leaving it to expire on its own at expireAt.
Like the read above, this call takes no credential — the hosted checkout page calls it directly when the customer walks away. It needs no request body.
Abandoning does not move money and cannot undo a payment: a session that has already reached a final state stays where it is. To reverse money that has already moved, use the refund, void or capture-release operations instead.
Request
- Base URL: https://test-api.kashier.io
- URL: https://test-api.kashier.io/v3/payment/sessions/{sessionId}
- Auth: none required
Path parameters
The session's _id.
Request body
No fields are required. Send an empty object.
Response
The session was abandoned. The body is the updated session document, with status now ABANDONED.
The updated session document. Kashier has not published the exact projection returned here, so read status and treat the rest as informational.
Changes
No recorded changes to this operation across all 1 revision of this API.