Perform action

Use the performAction method via SOAP APIv6 to execute an action on the proposal.

Request parameters

Action	Parameter	Type / Description
	sessionId	Required (string) Unique 2Checkout session ID code.
SEND	proposalId	Required (string) The unique merchant proposal ID generated by the 2Checkout system.
	exirationDate	Required (date) The date at which the proposal expires; date-time ISO 8601 format.
	userId	Optional (string) The unique user ID generated by the 2Checkout system.
	action	Required (string) The action to be executed on the proposal.
	statusComment	Optional (string) Free text comments that can accompany a status.
	sentBy	Required (string) Represents the account manager of the merchant.
	FirstName	Required (string) The first name of the email sender.
	LastName	Required (string) The last name of the email sender.
	Email	Required (string) The email address of the email sender.
ACCEPT	action	Required (string) The action to be executed on the proposal.
	statusComment	Optional (string) Free text comments that can accompany a status.
CLOSE	action	Required(string) The action to be executed on the proposal.
	statusComment	Optional (string) Free text comments that can accompany a status.
	userId	Optional (string) The unique user ID generated by the 2Checkout system.
DISCARD	action	Required (string) The action to be executed on the proposal.
	statusComment	Optional (string) Free text comments that can accompany a status.
	userId	Optional (string) The unique user ID generated by the 2Checkout system.
REOPEN	action	Required (string) The action to be executed on the proposal.
	statusComment	Optional (string) Free text comments that can accompany a status.
	userId	Optional (string) The unique user ID generated by the 2Checkout system.
DECLINE	action	Required (string) The action to be executed on the proposal.
	statusComment	Optional (string) Free text comments that can accompany a status.

Request sample

<?php

require ('PATH_TO_AUTH');

$proposalId = "0573e71d-38bb-4d61-88ca-b3c557517c68";

$actionPayload = new stdClass();
$actionPayload->ExpirationDate = "2021-01-05T17:21:42+00:00";
$actionPayload->UserId = "[e-mail]";
$actionPayload->action = "decline";
$actionPayload->StatusComment = "The price is too high for the first product";
$actionPayload->SentBy = new stdClass();
$actionPayload->SentBy->FirstName = "John";
$actionPayload->SentBy->LastName = "Doe";
$actionPayload->SentBy->Email = "[e-mail]";

try {
    $results = $soapClient->performAction($sessionID, $proposalId , $actionPayload);
    echo "Performing action: </br>",
    var_dump($results);
}
catch (SoapFault $e) {
    echo "Could not perform action: " . $e->getMessage();
    exit;
}

Response

The performAction call via SOAP APIv6 returns the Proposal object.