PHP code example of currence / emandates

1. Go to this page and download the library: Download currence/emandates library. Choose the download type require.

2. Extract the ZIP file and open the index.php.

3. Add this code to the index.php.
    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

currence / emandates example snippets




global $emandates_config_params;

$emandates_config_params = [
    'passphrase'                   => 'your-private-key-passphrase',
    'keyFile'                      => '/path/to/merchant.key',
    'crtFile'                      => '/path/to/merchant.crt',
    'crtFileAquirer'               => '/path/to/acquirer.crt',
    'crtFileAquirerAlternative'    => '/path/to/acquirer-alt.crt',
    'contractID'                   => '0000000000',
    'contractSubID'                => '0',
    'merchantReturnURL'            => 'https://example.com/return',
    'AcquirerUrl_DirectoryReq'     => 'https://acquirer.example.com/directory',
    'AcquirerUrl_TransactionReq'   => 'https://acquirer.example.com/transaction',
    'AcquirerUrl_StatusReq'        => 'https://acquirer.example.com/status',
    'enableXMLLogs'                => true,
    'logPath'                      => '/path/to/logs',
    'folderNamePattern'            => 'Y-m-d',
    'fileNamePrefix'               => 'emandates',
    'enableInternalLogs'           => true,
    'fileName'                     => 'emandates.log',
];

use EMandates\Merchant\Configuration\Configuration;


use EMandates\Merchant\Configuration\Configuration;

$config = new Configuration(
    passphrase: 'your-private-key-passphrase',
    keyFile: '/path/to/merchant.key',
    crtFile: '/path/to/merchant.crt',
    crtFileAquirer: '/path/to/acquirer.crt',
    crtFileAquirerAlternative: '/path/to/acquirer-alt.crt',
    contractID: '0000000000',
    contractSubID: '0',
    merchantReturnURL: 'https://example.com/return',
    AcquirerUrl_DirectoryReq: 'https://acquirer.example.com/directory',
    AcquirerUrl_TransactionReq: 'https://acquirer.example.com/transaction',
    AcquirerUrl_StatusReq: 'https://acquirer.example.com/status',
    enableXMLLogs: true,
    logPath: '/path/to/logs',
    folderNamePattern: 'Y-m-d',
    fileNamePrefix: 'emandates',
    enableInternalLogs: true,
    fileName: 'emandates.log',
);

$config = Configuration::load('/path/to/config.xml');

use EMandates\Merchant\Communicator\CoreCommunicator;
use EMandates\Merchant\Communicator\B2BCommunicator;
use EMandates\Merchant\Configuration\Configuration;

// Using explicit configuration
$config = Configuration::getDefault();
$coreCommunicator = new CoreCommunicator($config);
$b2bCommunicator  = new B2BCommunicator($config);

// Or rely on the default (reads from global $emandates_config_params)
$coreCommunicator = new CoreCommunicator();
$b2bCommunicator  = new B2BCommunicator();

$directoryResponse = $coreCommunicator->Directory();

if ($directoryResponse->IsError) {
    echo 'Error: ' . $directoryResponse->Error->ErrorMessage;
} else {
    foreach ($directoryResponse->DebtorBanks as $bank) {
        echo $bank->DebtorBankId . ' - ' . $bank->DebtorBankName
             . ' (' . $bank->DebtorBankCountry . ')' . PHP_EOL;
    }
}

use EMandates\Merchant\Request\NewMandateRequest;

$request = new NewMandateRequest(
    entranceCode:     'unique-entrance-code-123',
    language:         'en',
    messageId:        '',                         // leave empty to auto-generate
    eMandateId:       'MANDATE-2025-001',
    eMandateReason:   'Monthly subscription',
    debtorReference:  'CUST-42',
    debtorBankId:     'INGBNL2A',
    purchaseId:       'ORDER-789',
    sequenceType:     'RCUR',                     // 'RCUR' (recurring) or 'OOFF' (one-off)
    maxAmount:        '',                         // optional, B2B only
    expirationPeriod: new \DateInterval('PT30M'), // optional, e.g. 30 minutes
);

$response = $coreCommunicator->NewMandate($request);

if ($response->IsError) {
    echo 'Error: ' . $response->Error->ErrorMessage;
} else {
    // Save the transaction ID for the status request later
    $transactionId = $response->TransactionId;

    // Redirect the debtor to their bank
    if ($response->IssuerAuthenticationUrl) {
        header('Location: ' . $response->IssuerAuthenticationUrl);
        exit;
    }
}

use EMandates\Merchant\Request\AmendmentRequest;

$amendRequest = new AmendmentRequest(
    entranceCode:         'unique-entrance-code-456',
    language:             'en',
    eMandateId:           'MANDATE-2025-001',
    eMandateReason:       'Updated subscription terms',
    debtorReference:      'CUST-42',
    debtorBankId:         'INGBNL2A',
    purchaseId:           'ORDER-789',
    sequenceType:         'RCUR',
    originalIBAN:         'NL91ABNA0417164300',
    originalDebtorBankId: 'ABNANL2A',
    messageId:            '',                         // optional, auto-generated if empty
    expirationPeriod:     new \DateInterval('PT20M'),  // optional
);

$amendResponse = $coreCommunicator->Amend($amendRequest);

if ($amendResponse->IsError) {
    echo 'Error: ' . $amendResponse->Error->ErrorMessage;
} else {
    $transactionId = $amendResponse->TransactionId;
    if ($amendResponse->IssuerAuthenticationUrl) {
        header('Location: ' . $amendResponse->IssuerAuthenticationUrl);
        exit;
    }
}

use EMandates\Merchant\Request\CancellationRequest;

$cancelRequest = new CancellationRequest(
    entranceCode:     'unique-entrance-code-789',
    language:         'en',
    eMandateId:       'MANDATE-2025-001',
    eMandateReason:   'Contract terminated',
    debtorReference:  'CUST-42',
    debtorBankId:     'INGBNL2A',
    purchaseId:       'ORDER-789',
    sequenceType:     'RCUR',
    originalIBAN:     'NL91ABNA0417164300',
    messageId:        '',                         // optional
    maxAmount:        '1000.00',                  // optional, B2B only
    expirationPeriod: new \DateInterval('PT20M'),  // optional
);

$cancelResponse = $b2bCommunicator->Cancel($cancelRequest);

if ($cancelResponse->IsError) {
    echo 'Error: ' . $cancelResponse->Error->ErrorMessage;
} else {
    $transactionId = $cancelResponse->TransactionId;
    if ($cancelResponse->IssuerAuthenticationUrl) {
        header('Location: ' . $cancelResponse->IssuerAuthenticationUrl);
        exit;
    }
}

use EMandates\Merchant\Request\StatusRequest;
use EMandates\Merchant\Enum\TransactionStatus;

$statusRequest = new StatusRequest(TransactionId: $transactionId);
$statusResponse = $coreCommunicator->GetStatus($statusRequest);

if ($statusResponse->IsError) {
    echo 'Error: ' . $statusResponse->Error->ErrorMessage;
} else {
    // $statusResponse->Status is a TransactionStatus enum instance
    switch ($statusResponse->Status) {
        case TransactionStatus::Success:
            $report = $statusResponse->AcceptanceReport;
            echo 'Mandate accepted!' . PHP_EOL;
            echo 'Debtor IBAN: ' . $report->DebtorIBAN . PHP_EOL;
            echo 'Debtor name: ' . $report->DebtorAccountName . PHP_EOL;
            echo 'Debtor bank: ' . $report->DebtorBankId . PHP_EOL;
            break;

        case TransactionStatus::Open:
        case TransactionStatus::Pending:
            echo 'Transaction is still in progress.' . PHP_EOL;
            break;

        case TransactionStatus::Cancelled:
            echo 'Transaction was cancelled by the debtor.' . PHP_EOL;
            break;

        case TransactionStatus::Expired:
            echo 'Transaction has expired.' . PHP_EOL;
            break;

        case TransactionStatus::Failure:
            echo 'Transaction failed.' . PHP_EOL;
            break;
    }

    // If you need the raw string value:
    echo 'Status string: ' . $statusResponse->Status->value . PHP_EOL;
}

use EMandates\Merchant\Contract\LoggerInterface;

class DBLogger implements LoggerInterface
{
    public function Log(string $message): void
    {
        // Store $message in your database or logging system
    }

    public function LogXmlMessage(\DOMDocument|string $dom, bool $isXML = false, string $fileName = ''): void
    {
        // Store XML request/response messages
        $xml = $dom instanceof \DOMDocument ? $dom->saveXML() : $dom;
        // ... persist $xml
    }
}

$logger = new DBLogger();
$communicator = new CoreCommunicator(Configuration::getDefault(), $logger);

$response = $coreCommunicator->NewMandate($request);

if ($response->IsError) {
    $error = $response->Error;

    echo 'Error code: '      . $error->ErrorCode      . PHP_EOL;
    echo 'Error message: '   . $error->ErrorMessage    . PHP_EOL;
    echo 'Error details: '   . $error->ErrorDetails    . PHP_EOL;
    echo 'Suggested action: '. $error->SuggestedAction  . PHP_EOL;
    echo 'Consumer message: '. $error->ConsumerMessage   . PHP_EOL;
}

if ($response->IssuerAuthenticationUrl) {
    header('Location: ' . $response->IssuerAuthenticationUrl);
    exit;
}

use EMandates\Merchant\Exception\CommunicatorException;

try {
    $response = $coreCommunicator->NewMandate($request);
} catch (CommunicatorException $e) {
    echo $e->errorCode;
    echo $e->errorMessage;
}