Delete Channel

Description

The deleteChannel endpoint is used to delete a channel in VELA. The Channel consists of the payment methods that are used for transaction processing.

Request

Endpoint

/ui/v1/deleteChannel

Method

POST

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=

Request Body

{
    "id": 224,
    "channelName": "123123@#",
    "channelStatus": {
        "name": "ACTIVE"
    },
    "channelType": {
        "name": "EXTERNAL"
    },
    "createdDateTime": 1657916806000,
    "merchantId": 1,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 340,
    "lastModifiedUserId": "340",
    "industryType": {
        "name": "GOLF"
    },
    "allowCashAsPaymentMethodInd": false,
    "allowMoneyOrderAsPaymentMethodInd": false,
    "allowPaperCheckAsPaymentMethodInd": false,
    "allowEStoreCreditAsPaymentMethodInd": false,
    "paymentMethods": [{
        "id": 2391,
        "paymentMethodType": {
            "value": "Credit Card",
            "name": "CREDIT_CARD"
        },
        "paymentGateway": {
            "value": "Chase Paymentech (NetConnect - Direct To Tandem)",
            "name": "CHASE_PAYMENTECH_NETCONNECT"
        },
        "cardBrand": {
            "value": "DISCOVER",
            "name": "DISCOVER"
        },
        "cardId": 1004,
        "createdUserId": 340,
        "lastModifiedUserId": 340,
        "createdDateTime": 1657916806000,
        "lastUpdatedDateTime": null,
        "position": 4
    }],
    "allowDynamicRoutingCapabilityInd": false,
    "secondaryPaymentGateway": null,
    "tertiaryPaymentGateway": null,
    "userCount": 1,
    "assignedPaymentMethods": null,
    "message": null,
    "paymentMethodsCount": 7,
    "merchantName": "ClubMed Sandpiper"
}

Response

{
    "id": 224,
    "channelName": "123123@#",
    "channelStatus": {
        "name": "DELETED"
    },
    "channelType": {
        "name": "EXTERNAL"
    },
    "createdDateTime": 1657916806000,
    "merchantId": 1,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 340,
    "lastModifiedUserId": 340,
    "industryType": {
        "name": "GOLF"
    },
    "allowCashAsPaymentMethodInd": false,
    "allowMoneyOrderAsPaymentMethodInd": false,
    "allowPaperCheckAsPaymentMethodInd": false,
    "allowEStoreCreditAsPaymentMethodInd": false,
    "paymentMethods": [{
        "id": 2391,
        "paymentMethodType": {
            "value": "Credit Card",
            "name": "CREDIT_CARD"
        },
        "paymentGateway": {
            "value": "Chase Paymentech (NetConnect - Direct To Tandem)",
            "name": "CHASE_PAYMENTECH_NETCONNECT"
        },
        "cardBrand": {
            "value": "DISCOVER",
            "name": "DISCOVER"
        },
        "cardId": 1004,
        "createdUserId": 340,
        "lastModifiedUserId": 340,
        "createdDateTime": 1657916806000,
        "lastUpdatedDateTime": null,
        "position": 4
    }],
    "allowDynamicRoutingCapabilityInd": false,
    "secondaryPaymentGateway": null,
    "tertiaryPaymentGateway": null,
    "userCount": null,
    "assignedPaymentMethods": null,
    "message": {
        "code": "27",
        "type": {
            "value": "Success",
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "The Channel <strong>123123@#</strong> has been deleted successfully."
    },
    "paymentMethodsCount": null,
    "merchantName": null
}

Updated As Of Version 5.8.0.3