Download the PHP package paynl/sdk-alliance without Composer

On this page you can find all versions of the php package paynl/sdk-alliance. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package sdk-alliance

SDK-Alliance (PHP)



About

A PAY. alliance account is required for this SDK.

As an alliance, you're able to manage sub-merchants and most of their tasks using this SDK.

This SDK also extends the standard PAY. SDK, so all functions from the original SDK are also available.

Installation

This SDK uses composer. To install the PAY. PHP SDK-alliance into your project, simply

$ composer require paynl/sdk-alliance

Setting up

To communicate with PAY. using this SDK, you'll need to authenticate. PAY. uses a token to authenticate you. You can find your token in the PAY. admin. On the bottom of the API Tokens page.

Step 1 The autoloader

Composer generates an autoloader for your application. To be able to access the classes of the SDK, all you have to do is include the composer autoloader. The autoloader is located here: vendor/autoload.php

Step 2 Your APItoken

To let the SDK know what your API-Token is, you'll have to register the TokenCode (AT-code belonging to the token) and APItoken as follows:

Now you're ready to use the SDK.

Examples

The full list of functions can be found in the samples folder.

1. Adding a merchant

Before we can do anything, we need to add a merchant to work with. For a full example of the merchantData, please refer to the sample

2. Getting a list of your merchants

You can get a list of all your sub-merchants. See the example here

Just call:

3. Getting a single merchant

You can of course also get the details of a single merchant. See also this example.

4. Uploading a document

Before we can accept your sub-merchants, you need to supply the required documents To check the missing documents, see the code from example 3. You can also check the example

It is also possible to send multiple files. The files will be merged into one file on our server. Both files must be of the same type (pdf or image)

5. Getting the list of available categories

You must select the correct category for the services you add for the merchant. The available paymentmethods differ for each category (for example, a wine giftcard is only valid for category wines) To get the list of categories, just call example

6. Adding a service (website)

In order for a merchant to use our services, The merchant needs to have a service (website) registered. A merchant can have multiple services, normally one for each website. Before we can add the website, we have to find out in which category the website should be placed. Some paymentmethods are only available for certain categories, so it is important to select the right one. To get a list of the available categories, see step 5. You can also check this extended example

7. Getting available payment methods

To get a list of the available payment methods, see the following example

To get a list of the enabled payment methods, use the Paymentmethods::getList() from the Merchant SDK

8. Enable a payment method

To enable a payment method, see the following example Some payment method have settings. The Paynl\Alliance\Service::getAvailablePaymentMethods result has a settings array inside the result for payment methods that have settings.

9. Disable a payment method

To disble a payment method, see the following example

10. Get statistics of your submerchants

You can get the statistics of your submerchants. For example to calculate the amount for the invoice in the next step. See the following example

You can use the predefined periods:

For example:

Or if you want to use your own start and end date:

11. Creating an invoice for a merchant

You can add an invoice for a merchant. In order to be able to add an invoice to a merchant, you'll have to set the settleBalance option to true, when adding a merchant in step 1 See the following example

12. Creating a clearing for a merchant

You can add a clearing for a merchant. The addClearing function should be called after 5:00 am CET, as the daily totals of the clearings are calculated at 4:00 am CET each day. See the following example


All versions of sdk-alliance with dependencies

PHP Build Version
Package Version
Requires paynl/sdk Version >1.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package paynl/sdk-alliance contains the following files

Loading the files please wait ....