Settle

Learn how to complete a customer's order through to settlement.

retrieveSpendOptions

Retrieve and display the spend options available based on the customer or product.

get

/merchant/{customerRef}/spend-options

authorise

The customer will select a spend option and press checkout, this will trigger the authorisation request.

post

/merchant/{customerRef}/authorisation

settle

Once the customer has received their order, their order can be settled.

post

/merchant/{customerRef}/authorisation/{authorisationId}/settle

Request Example

Request

1curl --request GET \
2  --url 'https://mtapi.stg-newdaytechnology.net/cl/merchant-gateway-service//merchant/123456789/spend-options?basketAmount=100&promoOnly=true&zeroPercentOnly=true&spendType=Instalment&orderBy=InstalmentPaymentAmount' \
3  --header 'context-merchantId: bf62723f-f664-4527-b95b-4dfee33e427d' \
4  --header 'context-tenantId: SOME_STRING_VALUE'

Response Example

Response

JSON

1{
2  "options": [
3    {
4      "name": "Promotional Offer A",
5      "description": "The description of the spend option",
6      "offerId": "cb097cd5-1ad7-4b90-a656-bdc3a5757fd4",
7      "offerCode": "offer-code",
8      "offerStatus": "Active",
9      "offerSource": "Promotional",
10      "spendType": "Purchase",
11      "interestRate": 0.02,
12      "spendOptionId": "cb097cd5-1ad7-4b90-a656-bdc3a5757fd4",
13      "duration": 12,
14      "illustration": {
15        "monthlyPayment": {
16          "value": 50,
17          "currencyCode": "GBP"
18        },
19        "interestToPay": {
20          "value": 50,
21          "currencyCode": "GBP"
22        },
23        "totalRepayable": {
24          "value": 50,
25          "currencyCode": "GBP"
26        }
27      },
28      "endDate": "2024-01-01T00:00:00+00:00",
29      "settlementPercentage": 0.02,
30      "refundPercentage": 0.02,
31      "chargebackPercentage": 0.02
32    }
33  ]
34}