Developers

Authorization Capture – Capture a Pending Authorization

Use this method to finalize and capture a previously authorized transaction.

Get All Pending Authorizations

You can retrieve all pending authorizations using the IPC SDK.

Step 1: Load the MyPOS SDK

Code Example

PHP
require_once './IPC/Loader.php';

This line autoloads the necessary classes from the SDK.

Step 2: Create Config Object and Set API Configuration Params

IpcURL is different for sandbox and production environments.

You can use the automatic Configuration package or set manually keyIndex, sid, wallet and RSA keys (for request signatures by setting key content using setPrivateKey and setAPIPublicKey or by setting file path using setPrivateKeyPath and setAPIPublicKeyPath).

Configuration package:

Code Example

PHP
$cnf = new \Mypos\IPC\Config();
$cnf->setIpcURL('https://mypos.com/vmp/checkout-test/');
$cnf->setLang('en');
$cnf->setVersion('1.4');
$configurationPackage = 'your-generated-package-token';
$cnf->loadConfigurationPackage($configurationPackage);

RSA Key pair:

Code Example

PHP
$cnf = new \Mypos\IPC\Config();
$cnf->setIpcURL('https://mypos.com/vmp/checkout-test/');
$cnf->setLang('en');
$cnf->setVersion('1.4');
$cnf->setPrivateKeyPath(dirname(__FILE__) . '/keys/store_private_key.pem');
$cnf->setAPIPublicKeyPath(dirname(__FILE__) . '/keys/api_public_key.pem');
$cnf->setKeyIndex(1);
$cnf->setSid('000000000000010');
$cnf->setWallet('61938166610');

For more information, please refer to the AuthorizationCapture method documentation.

Step 3: Create AuthorizationCapture Object and Set Required Params

Code Example

PHP
$authorization = new \Mypos\IPC\AuthorizationCapture($cnf);
$authorization->setOrderID('1498');
$authorization->setAmount(24.50); // Total or partial amount of your authorization
$authorization->setCurrency('EUR');
$authorization->setOutputFormat(Mypos\IPC\Defines::COMMUNICATION_FORMAT_JSON);

Step 4: Process Request

Code Example

PHP
$result = $authorization->process();

if ($result->getStatus() == \Mypos\IPC\Defines::STATUS_SUCCESS) {
    echo 'success';
    // Success
} else {
    // Show error.
}

Need Help?

For more details, see the Authorization Capture documentation.