Skip to main content

Delete upsell campaign

Delete upsell campaign

Last updated: 19-Jan-2021
Rate this article:


Use the deleteUpSellCampaign method via SOAP API 6.0 to permanently delete an upsell campaign in any status (active, disabled, expired).

Request parameters

Parameters Type Required/Optional Description
upSellCampaignCode String Required The identifying code of the upsell campaign.

    Request sample

    class Configuration
        public const MERCHANT_CODE = '';
        public const MERCHANT_KEY = '';
        public const URL = '';
        public const ACTION = 'deleteUpsellCampaign';
        public const ADDITIONAL_OPTIONS = null;
        public const PAYLOAD = "f4b76ac3-6b2e-492f-a468-b34103876470";
    class Client
        public function call(
            string $url = Configuration::URL,
            $payload = Configuration::PAYLOAD,
            string $action = Configuration::ACTION
        ): ?object {
            if (is_array($payload)) {
                $payload = json_encode($payload);
            $soapClient = $this->getClient($url);
            $sessionId = $this->getSession($soapClient);
            $args = array_filter([$sessionId, $payload]);
            return $soapClient->$action(...$args);
        public function getClient(string $url): SoapClient
            return new SoapClient(
                    'location' => $url,
                    'cache_wsdl' => WSDL_CACHE_NONE,
        public function getSession(SoapClient $client)
            $date = gmdate('Y-m-d H:i:s');
            $merchantCode = Configuration::MERCHANT_CODE;
            $key = Configuration::MERCHANT_KEY;
            $string = strlen($merchantCode).$merchantCode.strlen($date).$date;
            $hash = hash_hmac('md5', $string, $key);
            $client->__setCookie('XDEBUG_SESSION', 'PHPSTORM');
            return $client->login($merchantCode, $date, $hash);
    try {
        $client = new Client();
    } catch (Exception $ex) {


    • 204 - 'No content' if SUCCESS
    • 4xx if FAILED with distinct error messages

    Error handling

    Error code Message
    UPSELL_CAMPAIGN_NOT_FOUND Upsell campaign with code test was not found.
    UPSELL_CAMPAIGN_CODE_TOO_LONG Code exceeds allowed max length (255)


    Rate this article:

    Need help?

    Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

    Not yet a Verifone customer?

    We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

    Verifone logo