Skip to content

Latest commit

 

History

History
311 lines (281 loc) · 14.9 KB

README.md

File metadata and controls

311 lines (281 loc) · 14.9 KB
Raw

#Moldova Agroindbank Payment PHP SDK

maib-api

N|Solid

CONTENTS OF THIS FILE

  • Introduction
  • Requirements
  • Recommended modules
  • Installation
  • Before usage
  • Usage
  • Troubleshoting
  • Maintainers

INTRODUCTION

The Moldova Agroindbank Payment PHP SDK is used to easily integrate the MAIB Payment into your project. Based on the Guzzle Libraries to connect and process the requests with the Bank server and the Monolog library to log the requests responses.

The Moldova Agroindbank Payment PHP SDK has 2 ways of payment.

  • One way is SMS Transaction (registerSmsTransaction). When the client's money transfers on the merchant account instantly when the user do the payment. This way is recommended use.
  • Another way is DMS Transaction (registerDmsAuthorization). When the client's money has been blocked on their account before you confirm that transaction. This way is mostly used in the case of the long shipping time.

That Payment PHP SDK includes 6 methods to process the payments:

  • Registering transactions.
  • Registering DMS authorization.
  • Executing a DMS transaction.
  • Get transaction result.
  • Transaction reversal.
  • Close the work day.

REQUIREMENTS

  • PHP: >=8.1.0
  • guzzlehttp/guzzle: ~7.0
  • guzzlehttp/guzzle-services: ~1.0
  • monolog/monolog: ^2.7

INSTALLATION

  • Run composer require maib/maibapi ^3.0

BEFORE USAGE

To initiate an payment transaction you need to obtain the SSL certificate, to get the access by IP and to set the callback URL.

  • Need to write an email to maib commerce support: ecom@maib.md with the request including The Merchant IP and callback URL, to receive access and certificate for testing.
  • When you get the certificate, you need to generate the private and the public keys, using the terminal package OpenSSL
    • openssl pkcs12 -in 0149583.pfx -nocerts -out key.pem
    • openssl pkcs12 -in 0149583.pfx -clcerts -nokeys -out pcert.pem
    • openssl pkcs12 -in 0149583.pfx -cacerts -nokeys -out cacert.pem
  • Need to save the generated keys into map on server to usage in the requests.

USAGE

  • Need to include all libraries
  <?php

  namespace MyProject;

  require_once(__DIR__ . '/vendor/autoload.php');

  use Monolog\Handler\StreamHandler;
  use Monolog\Logger;
  use GuzzleHttp\Client;
  use GuzzleHttp\HandlerStack;
  use GuzzleHttp\Middleware;
  use GuzzleHttp\MessageFormatter;
  use Maib\MaibApi\MaibClient;
  • Setup the log stack
  if ((isset($log_is_required) && $log_is_required)) {
      $log = new Logger('maib_guzzle_request');
      $log->pushHandler(new StreamHandler(__DIR__.'/logs/maib_guzzle_request.log', Logger::DEBUG));
      $stack = HandlerStack::create();
      $stack->push(
          Middleware::log($log, new MessageFormatter(MessageFormatter::DEBUG))
      );
  }
  • Init the MaibCLient
  $options = [
    'base_uri' => MaibClient::MAIB_TEST_BASE_URI,
    'debug'  => false,
    'verify' => true,
    'cert'    => [MaibClient::MAIB_TEST_CERT_URL, MaibClient::MAIB_TEST_CERT_PASS],
    'ssl_key' => MaibClient::MAIB_TEST_CERT_KEY_URL,
    'config'  => [
      'curl'  =>  [
        CURLOPT_SSL_VERIFYHOST => 2,
        CURLOPT_SSL_VERIFYPEER => true,
      ]
    ]
  ];
  if (isset($stack)) {
      $options['handler'] = $stack;
  }
  $guzzleClient = new Client($options);
  $client = new MaibClient($guzzleClient);
  • Prepare the payment parameters
  // The Parameters required to use MaibClient methods
  $amount = 1; // The amount of the transaction
  $currency = 978; // The currency of the transaction - is the 3 digits code of currency from ISO 4217
  $clientIpAddr = '127.0.0.1'; // The client IP address
  $description = 'testing'; // The description of the transaction
  $lang = 'en'; // The language for the payment gateway

  // Other parameters
  $sms_transaction_id = null;
  $dms_transaction_id = null;
  $redirect_url = MaibClient::MAIB_TEST_REDIRECT_URL . '?trans_id=';
  $sms_redirect_url = '';
  $dms_redirect_url = '';

  • Registering SMS transactions The SMS transaction has 2 steps.

    • The first step is to register the transaction on the Maib Server and obtain the TRANSACTION_ID using the registerSmsTransaction Method.
    • The second step is the redirected user to the Maib Payment Gateway URL using the TRANSACTION_ID.
    • When the transaction has been finalised, the Maib Payment Gateway redirects the user to your callback URL where you get the transaction status. ! The TRANSACTION_ID has a timeout of 10 minutes.
    • Required parameters:
      • $amount = 1; // The amount of the transaction
      • $currency = 978; // The currency of the transaction - is the 3 digits code of currency from ISO 4217
      • $clientIpAddr = '127.0.0.1'; // The client IP address
      • $description = 'testing'; // The description of the transaction
      • $lang = 'en'; // The language for the payment gateway
    • Response: return array TRANSACTION_ID
      • TRANSACTION_ID - transaction identifier (28 characters in base64 encoding)
      • error - in case of an error
  // The register sms transaction method
  $registerSmsTransaction = $client->registerSmsTransaction($amount, $currency, $clientIpAddr, $description, $lang);
  $sms_transaction_id = $registerSmsTransaction["TRANSACTION_ID"];
  $sms_redirect_url = $redirect_url . $sms_transaction_id;
  • Registering DMS authorization The DMS transaction has 3 steps.
    • The first step is to register the transaction on the Maib Server and obtain the TRANSACTION_ID using the registerDmsAuthorization Method.
    • The second step is the redirected user to the Maib Payment Gateway URL using the TRANSACTION_ID.
    • When the transaction has been applied, the Maib Payment Gateway redirects the user to your callback URL where you get the transaction status.

    • The third step is to confirm transactions using the makeDMSTrans method.

    • Required parameters:

      • $amount = 1; // The amount of the transaction.
      • $currency = 978; // The currency of the transaction - is the 3 digits code of currency from ISO 4217.
      • $clientIpAddr = '127.0.0.1'; // The client IP address.
      • $description = 'testing'; // The description of the transaction.
      • $lang = 'en'; // The language for the payment gateway.

    • Response: return array TRANSACTION_ID

      • TRANSACTION_ID - transaction identifier (28 characters in base64 encoding)
      • error - in case of an error
  // The register dms authorization method
  $registerDmsAuthorization = $client->registerDmsAuthorization($amount, $currency, $clientIpAddr, $description, $lang);
  $dms_transaction_id = $registerDmsAuthorization["TRANSACTION_ID"];
  $dms_redirect_url = $redirect_url . $dms_transaction_id;
  • Executing a DMS transaction
    • Required parameters:
      • $dms_transaction_id;// The transaction ID from registerDmsAuthorization.
      • $amount = 1; // The amount of the transaction.
      • $currency = 978; // The currency of the transaction - is the 3 digits code of currency from ISO 4217.
      • $clientIpAddr = '127.0.0.1'; // The client IP address.
      • $description = 'testing'; // The description of the transaction.
      • $lang = 'en'; // The language for the payment gateway.
    • Response: return array RESULT, RESULT_CODE, BRN, APPROVAL_CODE, CARD_NUMBER, error
      • RESULT - transaction results: OK - successful transaction, FAILED - failed transaction
      • RESULT_CODE - transaction result code returned from Card Suite Processing RTPS (3 digits)
      • BRN - retrieval reference number returned from Card Suite Processing RTPS (12 characters)
      • APPROVAL_CODE - approval code returned from Card Suite Processing RTPS (max 6 characters)
      • CARD_NUMBER - masked card number
      • error - in case of an error
  // The execute dms transaction method
  $makeDMSTrans = $client->makeDMSTrans($dms_transaction_id, $amount, $currency, $clientIpAddr, $description, $language);
  • Get transaction result You can get the transaction status yourself using the getTransactionResult method. But do not forget, the transaction ID has a timeout of 10 minutes.
    • Required parameters:
      • $transaction_id;// The transaction ID from registerSmsTransaction or registerDmsAuthorization.
      • $clientIpAddr = '127.0.0.1'; // The client IP address.
    • Response: return array RESULT, RESULT_PS, RESULT_CODE, 3DSECURE, RRN, APPROVAL_CODE, CARD_NUMBER, AAV, RECC_PMNT_ID, RECC_PMNT_EXPIRY, MRCH_TRANSACTION_ID
      • RESULT
        • OK - successfully completed transaction,
        • FAILED - transaction has failed,
        • CREATED - transaction just registered in the system,
        • PENDING - transaction is not accomplished yet,
        • DECLINED - transaction declined by ECOMM,
        • REVERSED - transaction is reversed,
        • AUTOREVERSED - transaction is reversed by autoreversal,
        • TIMEOUT - transaction was timed out
      • RESULT_PS - transaction result, Payment Server interpretation (shown only if configured to return ECOMM2 specific details
        • FINISHED - successfully completed payment,
        • CANCELLED - cancelled payment,
        • RETURNED - returned payment,
        • ACTIVE - registered and not yet completed payment.
      • RESULT_CODE - transaction result code returned from Card Suite Processing RTPS (3 digits)
      • 3DSECURE
        • AUTHENTICATED - successful 3D Secure authorization
        • DECLINED - failed 3D Secure authorization
        • NOTPARTICIPATED - cardholder is not a member of 3D Secure scheme
        • NO_RANGE - card is not in 3D secure card range defined by issuer
        • ATTEMPTED - cardholder 3D secure authorization using attempts ACS server
        • UNAVAILABLE - cardholder 3D secure authorization is unavailable
        • ERROR - error message received from ACS server
        • SYSERROR - 3D secure authorization ended with system error
        • UNKNOWNSCHEME - 3D secure authorization was attempted by wrong card scheme (Dinners club, American Express)
      • RRN - retrieval reference number returned from Card Suite Processing RTPS
      • APPROVAL_CODE - approval code returned from Card Suite Processing RTPS (max 6 characters)
      • CARD_NUMBER - Masked card number
      • AAV - FAILED the results of the verification of hash value in AAV merchant name (only if failed)
      • RECC_PMNT_ID - Reoccurring payment (if available) identification in Payment Server.
      • RECC_PMNT_EXPIRY - Reoccurring payment (if available) expiry date in Payment Server in form of YYMM
      • MRCH_TRANSACTION_ID - Merchant Transaction Identifier (if available) for Payment - shown if it was sent as additional parameter on Payment registration.
      • The RESULT_CODE and 3DSECURE fields are informative only and can be not shown.
      • The fields RRN and APPROVAL_CODE appear for successful transactions only, for informative purposes,
      • and they facilitate tracking the transactions in Card Suite Processing RTPS system.
      • error - In case of an error
      • warning - In case of warning (reserved for future use).
  // The get transaction result method
  $getTransactionResult = $client->getTransactionResult($transaction_id, $clientIpAddr);
  • Transaction reversal The ability to perform a return operation, partially or completely.
    • Required parameters:
      • $transaction_id;// The transaction ID from registerSmsTransaction or registerDmsAuthorization.
      • $amount = 1; // The amount of the transaction.
    • Response: return array RESULT, RESULT_CODE
      • RESULT
        • OK - successful reversal transaction
        • REVERSED - transaction has already been reversed
        • FAILED - failed to reverse transaction (transaction status remains as it was)
      • RESULT_CODE - reversal result code returned from Card Suite Processing RTPS (3 digits)
      • error - In case of an error
      • warning - In case of warning (reserved for future use).
  // The revert transaction method
  $revertTransaction = $client->revertTransaction($transaction_id, $amount);
  • Close the work day Execute automatic closing of the day, recommended use time: 23:59:00.
    • Required parameters:
      • No parameters Required.
    • Response: return array RESULT, RESULT_CODE, FLD_075, FLD_076, FLD_087, FLD_088
      • RESULT - OK - successful end of business day FAILED - failed end of business day
      • RESULT_CODE - end-of-business-day code returned from Card Suite Processing RTPS (3 digits)
      • FLD_075 - the number of credit reversals (up to 10 digits), shown only if result_code begins with 5
      • FLD_076 - the number of debit transactions (up to 10 digits), shown only if result_code begins with 5
      • FLD_087 - total amount of credit reversals (up to 16 digits), shown only if result_code begins with 5
      • FLD_088 - total amount of debit transactions (up to 16 digits), shown only if result_code begins with 5
  //close business day
  $closeDay = $client->closeDay();

TROUBLESHOTING

All transactions are considered successful it's only if you receive a predictable response from the maib server in the format you know. If you receive any other result (NO RESPONSE, Connection Refused, something else) there is a problem. In this case it is necessary to collect all logs and sending them to maib by email: ecom@maib.md, in order to provide operational support. The following information should be indicated in the letter:

  • Merchant name,
  • Web site name,
  • Date and time of the transaction made with errors
  • Responses received from the server

MAINTAINERS

Current maintainers: