Skip to content

Latest commit

 

History

History
executable file
·
295 lines (206 loc) · 12.3 KB

readme.md

File metadata and controls

executable file
·
295 lines (206 loc) · 12.3 KB
Raw

Barion Web PHP Library

version Total Downloads License

A compact PHP library to manage online e-money and card payments via the Barion Smart Gateway.
It allows you to accept credit card, e-money, and wire transfer payments in just a few lines of code.

This library will help you

  • Start an online payment easily in various scenarios (immediate payment, reservation/escrow, delayed capture, third-party payments, recurring/token payment etc.)
  • Get details about a given payment
  • Finish an ongoing reservation payment completely or partially, with automatic refund support
  • Refund a completed payment transaction completely or partially

All with just a few simple pieces of code!

System requirements

  • PHP 8.2 or higher
  • cURL module enabled (at least v7.18.1)
  • SSL enabled (systems using OpenSSL with the version of 0.9.8f at least)

Legacy version support

If you are using PHP versions 8.1 or lower, download our library version 1.4.11.
Please note that the use of End-Of-Support and End-Of-Life software during integration is highly discouraged.

Supported API versions

BarionClient method Endpoint description Current API version
PreparePayment Prepares a new payment in the Barion system v2
PaymentState Requests the full current state of a payment v4
FinishReservation Finishes a previously reserved Reservation payment v2
Capture Captures the final amount of a Delayed Capture payment v2
CancelAuthorization Cancels the authorization on a Delayed Capture payment v2
Complete3DSPayment Completes a previously 3D-Secure authenticated payment v2
RefundPayment Refunds a previously completed payment v2
GetPaymentState Requests the full current state of a payment (deprecated) v2
GetPaymentQRImage Requests a QR code image for a payment (deprecated) v1

Installation

Composer

You can install the library via Composer. Run the following command:

composer require barion/barion-web-php

Then generate the necessary autoload files using Composer.
The library automatically detects Composer-generated autoload files and uses them for autoloading.

Manual installation

If you do not wish to use Composer, just copy the contents of the barion library into the desired folder.
The library will use its own autoloading mechanism if no Composer-generated files are detected.

Note
Be sure to set the necessary access to the path when running your PHP script.

Basic usage

Include the BarionClient class in your PHP script:

require_once 'library/BarionClient.php';

Note
BarionClient will autoload everything for you, regardless of whether you used Composer ot not.

Then instantiate a Barion client. To achieve this, you must supply three key parameters:

1. The secret key of the online store registered in Barion (called POSKey)

$myPosKey = "9c165cfccbd1452f830721a3a9cee664";

2. The target Barion API version number (2 by default)

$apiVersion = 2;

3. The environment to connect to. This can be the test/sandbox system, or the production environment.

// Test environment
$environment = \Barion\Enumerations\BarionEnvironment::Test;

// Production environment
$environment = \Barion\Enumerations\BarionEnvironment::Prod;

With these parameters you can create an instance of the BarionClient class:

$BC = new \Barion\BarionClient(
    poskey: $myPosKey,
    version: $apiVersion,
    env: $environment,
    useBundledRootCerts: false
);

Note
Only set useBundledRootCerts to true as a last resort if you are having SSL connection problems. It is your own responsibility to use up-to-date software that includes the latest international trusted CA certificate chains. The authors take no responsibility for loss of service resulting from the use of the certificate chain bundled with the library.

Base flow

Using the library, managing a payment process consists of two steps:

1. Starting the payment

1.1. Creating the request object

To start an online payment, you have to create one or more Payment Transaction objects, add transaction Items to them, then group these transactions together in a Payment object.

First, create an ItemModel:

$item = new \Barion\Models\Common\ItemModel();
$item->Name = "TestItem";
$item->Description = "A test product";
$item->Quantity = 1;
$item->Unit = "piece";
$item->UnitPrice = 1000;
$item->ItemTotal = 1000;
$item->SKU = "ITEM-01";

Then create a PaymentTransactionModel and add the Item mentioned above to it:

$trans = new \Barion\Models\Payment\PaymentTransactionModel();
$trans->POSTransactionId = "TRANS-01";
$trans->Payee = "[email protected]";
$trans->Total = 1000;
$trans->Comment = "Test transaction containing the product";
$trans->AddItem($item);

Finally, create a PreparePaymentRequestModel and add the PaymentTransactionModel mentioned above to it:

$ppr = new \Barion\Models\Payment\PreparePaymentRequestModel();
$ppr->GuestCheckout = true;
$ppr->PaymentType = \Barion\Enumerations\PaymentType::Immediate;
$ppr->FundingSources = array(FundingSourceType::All);
$ppr->PaymentRequestId = "PAYMENT-01";
$ppr->PayerHint = "[email protected]";
$ppr->Locale = \Barion\Enumerations\UILocale::EN;
$ppr->OrderNumber = "ORDER-0001";
$ppr->Currency = \Barion\Enumerations\Currency::HUF;
$ppr->RedirectUrl = "https://webshop.example.com/afterpayment";
$ppr->CallbackUrl = "https://webshop.example.com/processpayment";
$ppr->AddTransaction($trans);

Note
The secret POSKey used for authentication is not part of the request object.
The Barion client class automatically injects this value into every request sent to the Barion API.

1.2. Calling the Barion API

Now you can call the PreparePayment method of the Barion client with the request model you just created:

$myPayment = $BC->PreparePayment($ppr);

The Barion API now prepares a payment entity that can be paid by anyone.

The $myPayment variable holds the response received from the Barion API, which is an instance of a PreparePaymentResponseModel object.

1.3. Redirecting the user to the Barion Smart Gateway

You can use the PaymentId value in the response to redirect the user to the Barion Smart Gateway. You have to supply this identifier in the ID query string parameter.
The complete redirect URL looks like this:

https://secure.barion.com/Pay?id=<your_payment_id>

The user can now complete the payment at the Barion Smart Gateway.

2. Getting information about a payment

In this example we are going to get detailed information about the payment we just created above.

2.1. Creating the request object

To request details about a payment, you only need one parameter: the payment identifier. This is the PaymentId we have used earlier to redirect the user.

64157032d3dc4296aedafd4b0994c64e

2.2. Calling the Barion API

To request payment details, we call the PaymentState method of the Barion client class with the identifier above.

$BC->SetVersion(4);
$paymentDetails = $BC->PaymentState("64157032d3dc4296aedafd4b0994c64e");

Note
The PaymentState API is available in API version 4. The v2 GetPaymentState API is now deprecated.

Based on the payment status and parameters received in the response, the shop can now decide whether the payment was successful or not.

API documentation

It is essential to get a basic understanding of the various statuses and errors returned by the Barion API during HTTP calls.
Please refer to the official Barion API Documentation to learn more about the various API endpoints and their responses.

Basic troubleshooting

Here are a few common mistakes you might want to double-check for before reaching out to our support:

1. I get a "User authentication failed" error when sending my request

  • Check if you are sending the correct POSkey to the correct environment, e.g. if you want to call the API in the TEST environment, use the POSkey of the shop that you registered on the TEST website.
  • Check if the sent data is actually a valid JSON string, without any special characters, delimiters, line-breaks or invalid encoding.

2. I get a "Shop is closed" error message in the TEST environment

  • Check if your shop is open after logging in to the Barion Test website. Please note that you must fill out every data of your shop and then send it to approval. After this, approval will automatically be completed and your shop will be in Open status. This only applies to the TEST environment.

3. I get SSL errors about invalid certificates when trying to call the API

  • Be sure to double-check your server certificates and the issuer's trusted status. Always renew your server certificates in time to avoid loss of service.
  • Check every single component of your architecture for outdated software. Be sure to use the latest PHP, other runtimes, and even operating systems whenever possible. Trusted certificate chains may expire or get revoked, and Barion has no control over them. Using End-Of-Support and End-Of-Life software is highly discouraged.
  • As a last resort, you may try creating the BarionClient instance with useBundledRootCerts set to true. But be advised, there is no guarantee that the bundled certificate chain remains valid at all times.

Getting help

If you have any questions or need help with usage of this plugin, join our Discord server and ask the developer community!

License

This repository is available under the Apache 2.0 License.

Contributing

How to contribute to the Barion API library

  1. Fork the barion/barion-php-web repository.
  2. Create a new branch in your fork, make the desired changes, then push the changes to your fork.
  3. Create a pull request to the barion/barion-php-web repository.
    In the pull request, please describe the functionality you developed or the problem you solved in detail.

We will try to review your pull request as soon as possible.

Version history

  • 2.0.0 July 16. 2024
  • 1.4.11 April 2. 2024
  • 1.4.10 June 13. 2022
  • 1.4.9 June 9. 2022
  • 1.4.8 June 9. 2022
  • 1.4.7 May 25. 2022
  • 1.4.6 April 28. 2021
  • 1.4.5 April 15. 2021
  • 1.4.4 February 17. 2021
  • 1.4.3 December 11. 2020
  • 1.4.2 August 15. 2019.
  • 1.4.1 August 14. 2019.
  • 1.4.0 August 08. 2019.
  • 1.3.2 August 05. 2019.
  • 1.3.1 March 20. 2019.
  • 1.3.0 March 12. 2019.
  • 1.2.9 May 16. 2017.
  • 1.2.8 April 13. 2017.
  • 1.2.7 February 14. 2017.
  • 1.2.5 November 07. 2016.
  • 1.2.4 May 25. 2016.
  • 1.2.3 January 14. 2016.
  • 1.2.2 January 11. 2016.
  • 1.1.0 November 27. 2015.
  • 1.0.1 November 26. 2015.
  • 1.0.0 November 17. 2015.

For details about version changes, please refer to the changelog.md file.

Further examples

To view more examples about the usage of the Barion library, refer to the docs and examples folders of the repository.

© 2024 Barion Payment Inc.