Verifies the products available for a basket.

post

https://example.com/verify-basket

Verify the basket is valid for products.

Body Params

The current customer basket and billing/shipping details

A request sent by a merchant to authorize it.

customer

object

Customer data

basket

object

required

A representation of all the items that the cutomer is attempting to purchase.

products

array of objects, unique

An array of products the merchant would like to request checkout for.

reference

string

required

.+

A unique merchant reference for a customer checkout.

callbackUri

uri

The callback URI to send (POST) notification on application success.

initialisedBy

string

A unique identifier for the user who created the order (Required if channelName = ASSISTED)

channelName

string

enum

The type of channel name. Default value is UNASSISTED.
Canonical values:

ASSISTED (alias: INSTORE)
UNASSISTED (alias: ONLINE)
The API accepts either the canonical value or its alias.
Example: "channelName": "INSTORE" is the same as "channelName": "ASSISTED".
Values are case-sensitive.

Allowed:

Responses

default

Access token is missing or invalid.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/hal+json

200Verifies that the basket has been accepted and returns a certificate authorizing checkout.