Set an external reference

Use the setExternalRef method in conjunction with setSubscriptionUpgrade.

Request parameters

Parameters
Type/Description

sessionID

Required (string) Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.

externalRef

Required (string) External reference you control.

Response parameters

Parameters
Type/Description

Boolean

true or false depending on whether or not the operation succeeded.

Request sample

<?php

require ('PATH_TO_AUTH');

$externalReference = 'YOUR_EXTERNAL_REFERENCE';

try {
    $extRef = $client->setExternalRef($sessionID, $externalReference);
}
catch (SoapFault $e) {
    echo "extRef: " . $e->getMessage();
    exit;
}
var_dump("extRef", $extRef);

Last updated

Was this helpful?