Introduction

Download

Composer

// This assumes that you have composer installed globallycomposer require andrewnovikof/omnipay-sberbank

Solving problems with minimal stability

{"minimum-stability":"dev","prefer-stable":true}

Simple Example

useOmnipay\Omnipay;// Setup payment gateway$gateway = Omnipay::create('Sberbank');// Set params for authorize request$gateway->authorize(    ['orderNumber' =>$localOrderNumber,// local order number'amount' =>$order_amount,// The amount of payment (you can use decimal with 2 precisions for copecs or string equal to decimal)'returnUrl' =>$callback_url// succesfull callback url    ]);// Enable test mode$gateway->setTestMode(true);// You can set parameters via setters, for example:$gateway->setUserName('merchant_login')        ->setPassword('merchant_password')        ->setOrderNumber($localOrderNumber)        ->setLanguage('en');// Send request$response =$gateway->send();// Process responseif ($response->isSuccessful()) {// Payment was successfulprint_r($response);// Get gateway orderId$gatewayOrderId =$response->getOrderId();// Get manualy get redirect url to offsite payment gateway$offsiteGateway =$response->getRedirectUrl();}else {// Payment failedecho$response->getMessage();}// Work with redirectif ($response->isRedirect()) {// Redirect to offsite payment gateway$response->redirect();}

Payment Methods

Order registration without pre-authorization

Order registration with pre-authorization

Order completion after pre-authorization

Orders status

Extended order status

Void order

Refund for an order payment

Verify the involvement of the map in 3DS

Statistics on payments for the period

Add a card to the list of SSL-cards

Order registration without pre-authorization

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->authorize(    ['orderNumber' =>$localOrderNumber,// local order number'amount' =>$order_amount,// The amount of payment (you can use decimal with 2 precisions for copecs or string equal to decimal)'returnUrl' =>$callback_url,// succesfull callback url'description' =>'Order Description'    ])->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Payment was successfulprint_r($response);// Get gateway orderId$gatewayOrderId =$response->getOrderId();// Get manualy get redirect url to offsite payment gateway$offsiteGateway =$response->getRedirectUrl();}else {// Payment failedecho$response->getMessage();}// Work with redirectif ($response->isRedirect()) {// Redirect to offsite payment gateway$response->redirect();}

Order registration with pre-authorization

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->authorize(    ['orderNumber' =>$localOrderNumber,// local order number'amount' =>$order_amount,// The amount of payment (you can use decimal with 2 precisions for copecs or string equal to decimal)'returnUrl' =>$callback_url,// succesfull callback url'description' =>'Order Description'    ])->setTwoStage(true) ->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Payment was successfulprint_r($response);// Get gateway orderId$gatewayOrderId =$response->getOrderId();// Get manualy get redirect url to offsite payment gateway$offsiteGateway =$response->getRedirectUrl();}else {// Payment failedecho$response->getMessage();}// Work with redirectif ($response->isRedirect()) {// Redirect to offsite payment gateway$response->redirect();}

Order completion after pre-authorization

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->capture(    ['orderId' =>$localOrderNumber,// gateway order number'amount' =>$order_amount,// The amount of payment (you can use decimal with 2 precisions for copecs or string equal to decimal)    ])->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Get response code$code =$response->getCode();}else {// Payment failedecho$response->getMessage();}

Orders status

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->orderStatus(// It will be similar to calling methods `completeAuthorize()` and `completePurchase()`    ['orderId' =>$localOrderNumber,// gateway order number'language' =>'en'    ])->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Get response code$code =$response->getCode();// Get paid amount$paid_amount =$response->getAmount();// Get other data$order_status =$response->getOrderStatus();$order_number =$response->getOrderNumber();$order_pan =$response->getPan();$order_expiration =$response->getExpiration();$order_cardholder_name =$response->getCardHolderName();$order_currency =$response->getCurrency();$order_approval_code =$response->getApprovalCode();$order_ip =$response->getIp();$order_client_id =$response->getClientId();$order_binding_id =$response->getBindingId();}else {// Payment failedecho$response->getMessage();}

Extended order status

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->extendedOrderStatus(    ['orderId' =>$localOrderNumber,// gateway order number'language' =>'en'    ])->setOrderNumber($localORderNumber)// You can set local orderNumber Instead of an orderId of gateway system ->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Get response code$code =$response->getCode();// Get paid amount$paid_amount =$response->getAmount();// Get other data$order_status =$response->getOrderStatus();$order_number =$response->getOrderNumber();$order_pan =$response->getPan();$order_expiration =$response->getExpiration();$order_cardholder_name =$response->getCardHolderName();$order_currency =$response->getCurrency();$order_approval_code =$response->getApprovalCode();$order_ip =$response->getIp();$order_client_id =$response->getClientId();$order_binding_id =$response->getBindingId();$order_merchant_order_params =$response->getMerchantOrderParams();$order_eci =$response->getEci();$order_cavv =$response->getCavv();$order_xid =$response->getXid();$order_auth_date_time =$response->getAuthDateTime();$order_auth_ref_num =$response->getAuthRefNum();$order_terminal_id =$response->getTerminalId();$order_approved_amount =$response->getApprovedAmount();$order_deposited_amount =$response->getDepositedAmount();$order_refunded_amount =$response->getRefundedAmount();$order_payment_state =$response->getPaymentState();$order_bank_name =$response->getBankName();$order_bank_country_code =$response->getBankCountryCode();$order_band_country_name =$response->getBankCountryName();}else {// Payment failedecho$response->getMessage();}

Void order

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->void(    ['orderId' =>$localOrderNumber,// gateway order number'language' =>'en'    ])->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Get response code$code =$response->getCode();}else {// Payment failedecho$response->getMessage();}

Refund for an order payment

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->refund(    ['orderId' =>$localOrderNumber,// gateway order number'language' =>'en','amount' =>$oder_amount// // The amount of payment (you can use decimal with 2 precisions for copecs or string equal to decimal)    ])->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Get response code$code =$response->getCode();}else {// Payment failedecho$response->getMessage();}

Verify the involvement of the map in 3DS

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->verifyEnrollment(    ['pan' =>$cardPan    ])->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Get response code$code =$response->getCode();$emitter_country_name =$response->getEmitterName();$emitter_country_code =$response->getEmitterCountryCode();$enrolled =$response->getEnrolled();}else {// Payment failedecho$response->getMessage();}

Statistics on payments for the period

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->getLastOrdersForMerchants(    ['size' =>$size,'from' =>$from,'to' =>$to,'transactionStates' =>$transactionStates,'merchants' =>$merchants    ])->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Get response code$code =$response->getCode();$total_count =$response->getTotalCount();$page =$response->getPage();$page_size =$response->getPageSize();// Available getters$response->getOrderErrorCode($orderIndex);$response->getOrderNumber($orderIndex);$response->getOrderStatus($orderIndex);$response->getActionCode($orderIndex);$response->getActionCodeDescription($orderIndex);$response->getAmount($orderIndex);$response->getCurrency($orderIndex);$response->getDate($orderIndex);$response->getOrderDescription($orderIndex);$response->getIp($orderIndex);$response->getMerchantOrderParamName($orderIndex,$paramIndex);$response->getMerchantOrderParamValue($orderIndex,$paramIndex);$response->getAttributesName($orderIndex,$attributeIndex);$response->getAttributesValue($orderIndex,$attributeIndex);$response->getExpiration($orderIndex);$response->getCardholderName($orderIndex);$response->getApprovalCode($orderIndex);$response->getPan($orderIndex);$response->getClientId($orderIndex);$response->getBindingId($orderIndex);$response->getAuthDateTime($orderIndex);$response->getTerminalId($orderIndex);$response->getAuthRefNum($orderIndex);$response->getPaymentState($orderIndex);$response->getApprovedAmount($orderIndex);$response->getDepositedAmount($orderIndex);$response->getRefundedAmount($orderIndex);$response->getBankName($orderIndex);$response->getBankCountryName($orderIndex);$response->getBankCountryCode($orderIndex);}else {// Payment failedecho$response->getMessage();}

Add a card to the list of SSL-cards

useOmnipay\Omnipay;$gateway = Omnipay::create('Sberbank');$response =$gateway->verifyEnrollment(    ['mdorder' =>$mdorder    ])->setUserName('merchant_login') ->setPassword('merchant_password') ->send();// Process responseif ($response->isSuccessful()) {// Get response code$code =$response->getCode();}else {// Payment failedecho$response->getMessage();}