Create a credit transaction for a customer on a specific lender or product.

post

https://example.com/transaction

Used by the merchant to start a credit application for a customer on a
specific lender / product. The merchant supplies the basket, the chosen product,
a unique reference (the Merchant Unique Reference) and, optionally, the customer's
details.

Behaviour:

If no order exists for the supplied reference and the authenticated merchant,
a new order is created via the appropriate product application service.
If an order already exists for that reference and the authenticated merchant,
it is validated as amendable / resumable against the new basket and returned.
Repeated requests are made safe by sending the same Idempotency-Key header.
If the resulting order is eligible for an AppLink (assisted or broker journeys), an
AppLink is generated automatically and included in the response under
appLinks.

Authentication is required via a merchant M2M bearer token obtained from
POST /auth.

Body Params

Basket, product, merchant unique reference and the customer's details.

A request sent by a merchant to make customer transaction.

basket

object

required

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

product

string

enum

required

One of the existing products (e.g. "split"). When none of the products specified, basket will be validated against all eligible products.

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:

customer

object

Customer data

Headers

Idempotency-Key

uuid

required

Key used to recognise a repeated request. Send the same key to retry a request
safely, and a new key for a new transaction.

Responses

401

Access token is missing or invalid.

default

Access token is missing or invalid.

200Transaction successfully created or resumed. Returns the resulting checkout details.

400Invalid input or basket validation failure.

422The order could not be created or retrieved for the merchant, or an AppLink could not be generated for an AppLink-eligible order.