feature

Reverse

Learn how to cancel a customer's order.

1

authorise

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

get
/merchant/{customerRef}/spend-options
See API reference
2

reverse

Reverse an order once the order can be authorised.

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 'Ocp-Apim-Subscription-Key: REPLACE_KEY_VALUE' \
4  --header 'context-merchantId: bf62723f-f664-4527-b95b-4dfee33e427d' \
5  --header 'context-tenantId: SOME_STRING_VALUE'

Response Example

Response

JSON

1{
2  "options": [
3    {
4      "name": "6 Month spend option",
5      "description": "A 6 month instalment spend option",
6      "offerId": "71b17112-4762-407b-aefb-374dd4fcdb64",
7      "offerCode": "some-offer-code",
8      "offerStatus": "Active",
9      "offerSource": "Product",
10      "spendType": "Instalment",
11      "interestRate": 0.25,
12      "spendOptionId": "71b17112-4762-407b-aefb-374dd4fcdb64",
13      "duration": 6,
14      "illustration": {
15        "monthlyPayment": {
16          "value": 20,
17          "currencyCode": "GBP"
18        },
19        "interestToPay": {
20          "value": 10,
21          "currencyCode": "GBP"
22        },
23        "totalRepayable": {
24          "value": 100,
25          "currencyCode": "GBP"
26        }
27      },
28      "endDate": "2024-12-24T09:30:00+00:00",
29      "settlementPercentage": 0.05,
30      "refundPercentage": 0.1,
31      "chargebackPercentage": 0.1
32    }
33  ]
34}