Retrieve customer
Last updated: 24-Feb-2026
Rate this article:
Overview
Use the getCustomerInformation method to retrieve the details of a customer entity from the 2Checkout system.
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. | |
| CustomerReference | Required (int) |
| System-generated customer reference. Required unless you prefer to use ExternalCustomerReference. | |
| ExternalCustomerReference | Optional (string) |
| External customer reference that you control. Optional when you use CustomerReference. If you include it, it needs to belong to the same customer as the CustomerReference. | |
| IncludePaymentData | Boolean |
| Indicates if the customer payment data should be returned within the ExistingCards property. Default value is FALSE. |
Response
| Parameters | Type/Description |
|---|---|
| Customer | Object |
Request
<?php
declare(strict_types=1);
class Configuration
{
public const MERCHANT_CODE = 'MERCHANT_CODE';
public const MERCHANT_KEY = 'SECRET_KEY';
public const URL = 'http://api.2checkout.com/soap/6.0';
public const ACTION = 'getCustomerInformation';
public const CUSTOMER_REF = '1111';
public const INCLUDE_PAYMENT_DATA = true;
//array or JSON
public const PAYLOAD = null;
}
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);
}
if (!empty($payload)) {
// SoapClient works with objects(StdClass)
$payload = json_decode($payload);
}
$soapClient = $this->getClient($url);
$sessionId = $this->getSession($soapClient);
$args = array_filter([$sessionId, Configuration::CUSTOMER_REF, Configuration::CUSTOMER_REF, Configuration::INCLUDE_PAYMENT_DATA, $payload]);
return $soapClient->$action(...$args);
}
public function getClient(string $url): SoapClient
{
return new SoapClient(
$url . '?wsdl',
[
'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;
$algo = 'sha256';
$hash = hash_hmac($algo, $string, $key);
$client->__setCookie('XDEBUG_SESSION', 'PHPSTORM');
return $client->login($merchantCode, $date, $hash, $algo);
}
}
try {
$client = new Client();
var_dump($client->call());
} catch (Exception $ex) {
var_dump($ex);
}
Rate this article: