Spend Options

Retrieve spend options available to the customer.

Overview

This API returns unique spend options, bespoke to the basket amount, promotional and product offers available, and the customer risk profile. These options may include the Buy Now Pay Later (BNPL) or pay monthly, with different interest options offered.

Retrieving Spend Options

get

/merchant/{merchantCustomerId}/spend-options

1
When a customer reaches checkout, a request to this endpoint retrieves all available spend options. The merchantCustomerId is the reference associated with the account.
2
NewDay checks the provided information against the internal criteria.
3
This API presents spend options personalised to the customer. Each option has an individual treatmentId assigned.
4
Once the preferred spend option is selected, authorisation is required for the order amount.

The following snippet demonstrates a successful response, where treatmentId is the unique reference issued based on the customer’s chosen Spend Option:

{
  "options": [
    {
      "name": "Promotional Offer A",
      "description": "The description of the spend option",
      "offerStatus": "Active",
      "spendType": "Purchase",
      "offerSource": "Promotional",
      "interestRate": 0.00,
      "treatmentId": "cb097cd5-1ad7-4b90-a656-bdc3a5757fd4",
      "duration": 12,
      "illustration": {
        "monthlyPayment": {
          "value": 50,
          "currencyCode": "GBP"
        },
        "interestToPay": {
          "value": 0,
          "currencyCode": "GBP"
        },
        "totalRepayable": {
          "value": 600,
          "currencyCode": "GBP"
        }
      },
      "endDate": "2024-01-01T00:00:00+00:00"
    }
  ]
}

Continue on to Authorisation to obtain approval for the order amount.

Was this page helpful?