Authorisation

Obtains approval for the order amount.

Overview

A request to this endpoint obtains an authorisation for the order amount. Once approved, a temporary hold is placed on the authorised amount until the transaction is Settled or Reversed.

Obtaining an authorisation

post

/merchant/{merchantCustomerId}/authorisation

1
An Authorisation request is made for the order amount. treatmentId and spendType are populated from the customer's chosen spend option.
2
NewDay checks the provided information against the internal criteria.
3
If successful, an authorisationId is returned, confirming approval for the order amount.
4
The authorisation amount is placed on a temporary hold until a Settlement or Reversal request is made successfully.

The following snippet demonstrates an Authorisation request, where the description is an optional field that can be customised to associate the product being sold, the treatmentId and spendType is the spend option chosen by the customer.

{
  "amount": {
    "value": 50,
    "currencyCode": "GBP"
  },
  "orderReference": "0000123456",
  "description": "A fridge",
  "spendType": "Purchase",
  "treatmentId": "efb4929f-e781-4503-9035-18926cae56fd"
}

The following snippet shows a successful response, where authorisationId is an identifier to continue through the order processing journey.

{
  "authorisationId": "6fe486cf-3193-40ef-a850-f7659e717c6e"
}

The authorisationId is a compulsory requirement to carry out Settlement or Reverse request submissions.

Was this page helpful?