array
CSalePaySystem::GetByID(
int ID,
int PERSON_TYPE_ID = 0);
The method GetByID returns parameters of the specified pay system. If
the parameter PERSON_TYPE_ID is specified, the method returns parameters
of the corresponding pay system handler.
Parameters
Parameter
Description
ID
The ID of the pay system whose information is to be returned.
PERSON_TYPE_ID
The payer type ID. If set to other than null, the method returns
parameters of the corresponding pay system handler. Otherwise, only the pay
system parameters are returned.
Return Values
Returns an associated array with the following keys.
Key
Description
ID
The pay system ID.
LID
The ID of the site owning this pay system.
CURRENCY
Currency handled by the pay system.
NAME
The name of the pay system
ACTIVE
Specifies the pay system is active (Y/N).
SORT
Sort weight.
DESCRIPTION
Pay system description.
PSA_ID
The ID of the pay system handler (returned if PERSON_TYPE_ID is
not null).
PSA_NAME
Handler name (returned if PERSON_TYPE_ID is not null).
PSA_ACTION_FILE
Name of the script file containing handler (returned if PERSON_TYPE_ID
is not null).
PSA_RESULT_FILE
Name of the script file containing the pay system result handler (returned
if PERSON_TYPE_ID is not null).
PSA_NEW_WINDOW
Specifies the script is to be executed in the new window (Y/N) (returned
if PERSON_TYPE_ID is not null).
Example
<?
// Display the pay system $PAY_SYSTEM_ID handler name
// for payer $PERSON_TYPE
if ($arPaySys = CSalePaySystem::GetByID($PAY_SYSTEM_ID, $PERSON_TYPE))
{
echo $arPaySys["PSA_NAME"];
}
?>