Get Default Product

Description

The getDefaultProductByMerchantId API is used to fetch the default Product/Service in VELA while making a payment.

Request

Endpoint

ui/v1/getDefaultProductByMerchantId/merchantid

Note

Replace merchantid above with the internal merchant ID to which the product belongs to.

Method

GET

Content-Type: application/json
Authorization: $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: dXNlcm5hbWU6cGFzc3dvcmQ=

Response

{
    "id": 110,
    "createdDateTime": 1627401629000,
    "lastUpdatedDateTime": 1708110894000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 586,
    "lastModifiedUserId": 861,
    "productCode": "PUNC001",
    "productName": "Easy Check-in",
    "productDescription": null,
    "productStatus": {
        "name": "ACTIVE"
    },
    "productType": {
        "name": "DEFAULT"
    },
    "costPerUnit": {
        "amount": 17150,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "validFromDateTime": null,
    "validToDateTime": null,
    "productInfoUrl": null,
    "productImageUrl": null,
    "channelId": null,
    "merchantId": 11,
    "minQuantity": null,
    "maxQuantity": null,
    "paymentAction": {
        "name": "PRE_AUTHORIZATION"
    },
    "pointOfContactEmail": "",
    "productCategory": {
        "name": "INTERNAL_AND_EXTERNAL"
    },
    "useThisProductAsDefault": true,
    "createdUserName": null,
    "message": null,
    "merchantName": null,
    "sValidFromDateTime": null,
    "sValidToDateTime": null
}

Updated As Of Version 6.1.1