Settlement

Fulfilment of customer’s order.

Overview

This API posts the transaction to the customer's account, thereby completing the transaction. Depending on the retailer's chosen configuration, it is possible to request partial settlements against the same authorisationId.

Processing a Settlement

post

/merchant/{merchantCustomerId}/authorisation/{authorisationId}/settle

1
For a customer's order to be complete, a request MUST be made to this endpoint using the authorisationId generated from the Authoisation response. The authorised amount to be settled is entered into the request.
2
NewDay checks the provided information against the internal criteria.
3
A successful request returns a transactionId.

The following snippet demonstrates a Settlement request, where the description is an optional field that can be customised to associate the clearing request.

{
  "amount": {
    "value": 50,
    "currencyCode": "GBP"
  },
  "description": "string"
}

The following snippet shows a successful response, where transactionId is returned.

  "transactionId": "6fe486cf-3193-40ef-a850-f7659e717c6e"
}

The order is now complete. A refund can now be made against this order, if necessary.

Was this page helpful?