for Developers

myPOS Virtual Checkout API

These examples are created to experiment with the
myPOS Virtual Checkout API capabilities.


Purchase with payment card (API call: IPCPurchase)

  • Include SDK loader
    This will autoload necessary library files and classes
    require_once './IPC/Loader.php';
  • Create Config object and set API configuration params

    Note that IpcURL is different for sandbox and production environment

    You can set RSA keys for request signatures by setting key content using setPrivateKey and setAPIPublicKey or by setting file path using setPrivateKeyPath and setAPIPublicKeyPath

    For more information please refer to myPOS Virtual API Documentation
    $cnf = new \Satabank\IPC\Config();
    $cnf->setIpcURL('https://mypos.eu/vmp/checkout-test/');
    $cnf->setLang('en');
    $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->setVersion('1.0');
    $cnf->setWallet('61938166610');
  • Create Customer object and set customer data
    $customer = new \Satabank\IPC\Customer();
    $customer->setFirstName('John');
    $customer->setLastName('Smith');
    $customer->setEmail('demo@demo.demo');
    $customer->setPhone('+359111111111');
    $customer->setCountry('BGR');
    $customer->setAddress('Business Park Varna');
    $customer->setCity('Varna');
    $customer->setZip('9000');
  • Create Cart object and set cart items
    $cart = new \Satabank\IPC\Cart;
    $cart->add('Some Book"', 1, 9.99); //name, quantity, price
    $cart->add('Some other book', 1, 4.56);
    $cart->add('Discount', 1, -2.05);
  • Create Purchase object using Config object and set required params
    $purchase = new \Satabank\IPC\Purchase($cnf);
    $purchase->setUrlCancel('http://mysite.com/ipc_cancel'); //User comes here after purchase cancelation
    $purchase->setUrlOk('http://mysite.com/ipc_ok'); //User comes here after purchase success
    $purchase->setUrlNotify('http://mysite.com/ipc_notify'); //IPC sends POST reuquest to this address with purchase status
    $purchase->setOrderID(uniqid()); //Some unique ID
    $purchase->setCurrency('EUR');
    $purchase->setNote('Some note'); //Not required
    $purchase->setCustomer($customer);
    $purchase->setCart($cart);
  • Process payment
    try{
            $purchase->process();
    }catch(\    Satabank\IPC\IPC_Exception $ex){
            //Invalid params. To see details use "echo $ex->getMessage();"
    }

Make a refund for previously executed payment (API call: IPCRefund)

  • Include SDK loader
    This will autoload necessary library files and classes
    require_once './IPC/Loader.php';
  • Create Config object and set API configuration params

    Note that IpcURL is different for sandbox and production environment

    You can set RSA keys for request signatures by setting key content using setPrivateKey and setAPIPublicKey or by setting file path using setPrivateKeyPath and setAPIPublicKeyPath

    For more information please refer to myPOS Virtual API Documentation
    $cnf = new \Satabank\IPC\Config();
    $cnf->setIpcURL('https://mypos.eu/vmp/checkout-test/');
    $cnf->setLang('en');
    $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->setVersion('1.0');
    $cnf->setWallet('61938166610');
  • Create Refund object with created config
    $refund = new \Satabank\IPC\Refund($cnf);
  • Set Refund params
    $refund->setAmount(10);
    $refund->setCurrency('EUR');
    $refund->setOrderID(uniqid());
    $refund->setTrnref('123456');
    $refund->setOutputFormat(Satabank\IPC\Defines::COMMUNICATION_FORMAT_XML);
  • Send Refund request
    if($refund->process()){
            //Refund successful! Do something
    }else{
            //Do something else
    }

Get transaction status for previously executed payment (API call: IPCGetTxnStatus)

  • Include SDK loader
    This will autoload necessary library files and classes
    require_once './IPC/Loader.php';
  • Create Config object and set API configuration params

    Note that IpcURL is different for sandbox and production environment

    You can set RSA keys for request signatures by setting key content using setPrivateKey and setAPIPublicKey or by setting file path using setPrivateKeyPath and setAPIPublicKeyPath

    For more information please refer to myPOS Virtual API Documentation
    $cnf = new \Satabank\IPC\Config();
    $cnf->setIpcURL('https://mypos.eu/vmp/checkout-test/');
    $cnf->setLang('en');
    $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->setVersion('1.0');
    $cnf->setWallet('61938166610');
  • Create IPCGetTxnLog object and set required params
    $ipcStatus = new Satabank\IPC\GetTxnStatus($cnf);
    $ipcStatus->setOrderID('1440');
    $ipcStatus->setOutputFormat(\Satabank\IPC\Defines::COMMUNICATION_FORMAT_JSON);
  • Process request
    $result = $ipcStatus->process();
  • Check response status and use received data
    You may get response data as an array using getData() method or
    in original communication format using getDataRaw()
    switch($result->getStatus()){
        case \    Satabank\IPC\Defines::STATUS_SUCCESS:
                //Display returned data in the site interfase.
            //Loop and display in table or just print_r response
                print_r(\Satabank\IPC\Helper::getArrayVal($result->getData(CASE_LOWER), 'orderstatus'));
            break;
        case \    Satabank\IPC\Defines::STATUS_INVALID_PARAMS:
                //Order not found or set params are invalid.
            //Show error.
                break;
    }
  • Note:
    It is good practice to use try-catch statement to catch "IPC_Exception" exceptions
    try{
            $ipcStatus = new \Satabank\IPC\GetTxnStatus($cnf);
            $ipcStatus->setOrderID('1440');
            $ipcStatus->setOutputFormat(\Satabank\IPC\Defines::COMMUNICATION_FORMAT_JSON);
            $result = $ipcStatus->process();

        switch(    $result->getStatus()){
            case \    Satabank\IPC\Defines::STATUS_SUCCESS:
                    print_r(\Satabank\IPC\Helper::getArrayVal($result->getData(CASE_LOWER), 'orderstatus'));
                break;
            case \    Satabank\IPC\Defines::STATUS_INVALID_PARAMS:
                echo     'Not found!';
                break;
        }
    }catch(\    Satabank\IPC_Exception $ex){
            //Display exception message
            echo $ex->getMessage();
    }

Get transaction log for previously executed payment (API call: IPCGetTxnLog)

  • Include SDK loader
    This will autoload necessary library files and classes
    require_once './IPC/Loader.php';
  • Create Config object and set API configuration params

    Note that IpcURL is different for sandbox and production environment

    You can set RSA keys for request signatures by setting key content using setPrivateKey and setAPIPublicKey or by setting file path using setPrivateKeyPath and setAPIPublicKeyPath

    For more information please refer to myPOS Virtual API Documentation
    $cnf = new \Satabank\IPC\Config();
    $cnf->setIpcURL('https://mypos.eu/vmp/checkout-test/');
    $cnf->setLang('en');
    $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->setVersion('1.0');
    $cnf->setWallet('61938166610');
  • Create IPCGetTxnLog object and set required params
    $ipcLog = new \Satabank\IPC\IPCGetTxnLog($cnf);
    $ipcLog->setOrderID('1440');
    $ipcLog->setOutputFormat(\Satabank\IPC\Defines::COMMUNICATION_FORMAT_JSON);
  • Process request
    $result = $ipcLog->process();
  • Check response status and use received data
    You may get response data as an array using getData() method or
    in original communication format using getDataRaw()
    switch($result->getStatus()){
        case \    Satabank\IPC\Defines::STATUS_SUCCESS:
                //Display returned data in the site interfase.
            //Loop and display in table or just print_r response
                print_r(\Satabank\IPC\Helper::getArrayVal($result->getData(CASE_LOWER), 'log'));
            break;
        case \    Satabank\IPC\Defines::STATUS_INVALID_PARAMS:
                //Order not found or set params are invalid.
            //Show error.
                break;
    }
  • Note:
    It is good practice to use try-catch statement to catch "IPC_Exception" exceptions
    try{
            $ipcLog = new \Satabank\IPC\IPCGetTxnLog($cnf);
            $ipcLog->setOrderID('1440');
            $ipcLog->setOutputFormat(\Satabank\IPC\Defines::COMMUNICATION_FORMAT_JSON);
            $result = $ipcLog->process();
        switch(    $result->getStatus()){
            case \    Satabank\IPC\Defines::STATUS_SUCCESS:
                    print_r(\Satabank\IPC\Helper::getArrayVal($result->getData(CASE_LOWER), 'log'));
                break;
            case \    Satabank\IPC\Defines::STATUS_INVALID_PARAMS:
                echo     'Not found!';
                break;
        }
    }catch(\    Satabank\IPC\IPC_Exception $ex){
            //Display exception message
            echo $ex->getMessage();
    }

Successful payment notification (API call: IPCPurchaseNotify)

  • Include SDK loader
    This will autoload necessary library files and classes
    require_once './IPC/Loader.php';
  • Create Config object and set API configuration params

    Note that IpcURL is different for sandbox and production environment

    You can set RSA keys for request signatures by setting key content using setPrivateKey and setAPIPublicKey or by setting file path using setPrivateKeyPath and setAPIPublicKeyPath

    For more information please refer to myPOS Virtual API Documentation
    $cnf = new \Satabank\IPC\Config();
    $cnf->setIpcURL('https://mypos.eu/vmp/checkout-test/');
    $cnf->setLang('en');
    $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->setVersion('1.0');
    $cnf->setWallet('61938166610');
  • Create Response object with income POST data
    This will validate income data and request signature.
    try{
            $responce = Satabank\IPC\Response::getInstance($cnf, $_POST, \Satabank\IPC\Defines::COMMUNICATION_FORMAT_POST);
    }catch(\    Satabank\IPC\IPC_Exception $e){
        echo     'Error';
    }
  • Get posted data as an array
    $data is one-dimensional array containing elements with keys: IPCmethod, SID, Amount, Currency, OrderID, IPC_Trnref, RequestSTAN,RequestDateTime

    getData() has optional argument $case to change array keys case. It must be CASE_LOWER or CASE_UPPER.

    Merchant site must have next logics:

    1. Search in DB for order with this OrderID

    2. Verify that Amount and Currency match to amount from the original transaction

    3. Change order status to "paid"

    4. echo "OK"
    $data = $responce->getData(CASE_LOWER);
    if(    '...check and update order'){
        echo     'OK';
    }else{
        echo     'Error';
    }

Successful payment notification (API call: IPCPurchaseOK)

  • Include SDK loader
    This will autoload necessary library files and classes
    require_once './IPC/Loader.php';
  • Create Config object and set API configuration params

    Note that IpcURL is different for sandbox and production environment

    You can set RSA keys for request signatures by setting key content using setPrivateKey and setAPIPublicKey or by setting file path using setPrivateKeyPath and setAPIPublicKeyPath

    For more information please refer to myPOS Virtual API Documentation
    $cnf = new \Satabank\IPC\Config();
    $cnf->setIpcURL('https://mypos.eu/vmp/checkout-test/');
    $cnf->setLang('en');
    $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->setVersion('1.0');
    $cnf->setWallet('61938166610');
  • Create Response object with income POST data
    This will validate income data and request signature.
    try{
            $responce = Satabank\IPC\Response::getInstance($cnf, $_POST, \Satabank\IPC\Defines::COMMUNICATION_FORMAT_POST);
    }catch(\    Satabank\IPC\IPC_Exception $e){
            //Display Some general error or redirect to merchant store home page
    }
  • Get posted data as an array
    $data is one-dimensional array containing elements with keys: IPCmethod, SID, Amount, Currency, OrderID, IPC_Trnref, RequestSTAN,RequestDateTime

    getData() has optional argument $case to change array keys case. It must be CASE_LOWER or CASE_UPPER.

    Merchant site must have next logics:

    1. Search in DB for order with this OrderID

    2. Verify that Amount and Currency match to amount from the original transaction

    3. Show "Thank you" page to merchant customer
    $data = $responce->getData(CASE_LOWER);
    if(    '...order is found in merchant store DB'){
            //Display "Your order has been successfully paid" for example.
    }else{
            //Display Some general error or redirect to merchant store home page
    }

Cancelation of payment notification (API call: IPCPurchaseCancel)

  • Include SDK loader
    This will autoload necessary library files and classes
    require_once './IPC/Loader.php';
  • Create Config object and set API configuration params

    Note that IpcURL is different for sandbox and production environment

    You can set RSA keys for request signatures by setting key content using setPrivateKey and setAPIPublicKey or by setting file path using setPrivateKeyPath and setAPIPublicKeyPath

    For more information please refer to myPOS Virtual API Documentation
    $cnf = new \Satabank\IPC\Config();
    $cnf->setIpcURL('https://mypos.eu/vmp/checkout-test/');
    $cnf->setLang('en');
    $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->setVersion('1.0');
    $cnf->setWallet('61938166610');
  • Create Response object with income POST data
    This will validate income data and request signature.
    try{
            $responce = Satabank\IPC\Response::getInstance($cnf, $_POST, \Satabank\IPC\Defines::COMMUNICATION_FORMAT_POST);
    }catch(\    Satabank\IPC\IPC_Exception $e){
            //Display Some general error or redirect to merchant store home page
    }
  • Get posted data as an array
    $data is one-dimensional array containing elements with keys: IPCmethod, SID, Amount, Currency, OrderID, IPC_Trnref, RequestSTAN,RequestDateTime

    getData() has optional argument $case to change array keys case. It must be CASE_LOWER or CASE_UPPER.

    Merchant site must have next logics:

    1. Search in DB for order with this OrderID

    2. Verify that Amount and Currency match to amount from the original transaction

    3. Show "Thank you" page to merchant customer
    $data = $responce->getData(CASE_LOWER);
    if(    '...order is found in merchant store DB'){
            //Display "Your order has been canceled" for example.
    }else{
            //Display Some general error or redirect to merchant store home page
    }

Rollback of previous notification (API call: IPCPurchaseRollback)

  • Include SDK loader
    This will autoload necessary library files and classes
    require_once './IPC/Loader.php';
  • Create Config object and set API configuration params

    Note that IpcURL is different for sandbox and production environment

    You can set RSA keys for request signatures by setting key content using setPrivateKey and setAPIPublicKey or by setting file path using setPrivateKeyPath and setAPIPublicKeyPath

    For more information please refer to myPOS Virtual API Documentation
    $cnf = new \Satabank\IPC\Config();
    $cnf->setIpcURL('https://mypos.eu/vmp/checkout-test/');
    $cnf->setLang('en');
    $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->setVersion('1.0');
    $cnf->setWallet('61938166610');
  • Create Response object with income POST data
    This will validate income data and request signature.
    try{
            $responce = Satabank\IPC\Response::getInstance($cnf, $_POST, \Satabank\IPC\Defines::COMMUNICATION_FORMAT_POST);
    }catch(\    Satabank\IPC\IPC_Exception $e){
        echo     'Error';
    }
  • Get posted data as an array
    $data is one-dimensional array containing elements with keys: IPCmethod, SID, Amount, Currency, OrderID

    getData() has optional argument $case to change array keys case. It must be CASE_LOWER or CASE_UPPER.

    Merchant site must have next logics:

    1. Search in DB for order with this OrderID

    2. Verify that Amount and Currency match to amount from the original transaction

    3. Change order status to "Cancelled"

    4. echo "OK"
    $data = $responce->getData(CASE_LOWER);
    if(    '...check and update order'){
        echo     'OK';
    }else{
        echo     'Error';
    }