Checkout URLs
Once a user is satisfied with the state of a basket, a Checkout URL can be requested. This URL will allow the user to start the web-based part of the Checkout. When requesting the Checkout URL, the basket state will be validated to make sure that checkout can continue.
Requirements:
- Internal or External User Token
- Existing Basket containing at least one Basket Line
- All Projects in the Basket must be Complete
Validity
Checkout URLs can be only used to open the web based checkout once. After one usage they become invalid. They are also invalidated if the basket contents change - in case the changes would put the basket into an invalid state which could prevent checkout.
Actions
| URL | Verb | Information |
|---|---|---|
| /basket/{Guid}/checkout | POST | Retrieves a new checkout URL for the specified Basket |
Fields
The following fields are returned when requesting a Checkout URL:
| Field | Data Type | Required | Information |
|---|---|---|---|
| BasketGuid | Guid | Y | The Guid of the Basket |
| CheckoutUrl | String | U | The URL which can be used to start the Checkout process |