README.en.md

The YooKassa API PHP Client Library

Russian | English

This product is used for managing payments under The YooKassa API For usage by those who implemented YooKassa using the API method.

Requirements

PHP 5.3.2 (or later version) with the libcurl library

Installation

Under console using Composer

1. Install Composer, a package manager.
2. In the console, run the following command:

composer require yoomoney/yookassa-sdk-php

Do the following for the composer.json file of your project:

1. Add a string "yoomoney/yookassa-sdk-php": "^2.1" to the list of dependencies of your project in the composer.json file

...
   "require": {
        "php": ">=5.3.2",
        "yoomoney/yookassa-sdk-php": "^2.1"
...

2. Refresh the project's dependencies. In the console, navigate to the catalog with composer.json and run the following command:

composer update

3. Adjust your project's code to activate automated uploading of files for our product:

require __DIR__ . '/vendor/autoload.php';

Manually

1. Download the YooKassa API PHP Client Library archive, extract it and copy the lib catalog to the required place of your project.
2. Adjust your project's code to activate automated uploading of files for our product:

require __DIR__ . '/lib/autoload.php'; 

Commencing work

1. Import required classes

use YooKassa\Client;

2. Create a sample of a client object, then set the store's identifier and secret key (you can get them under your YooKassa's Merchant Profile). Issuing a secret key

$client = new Client();
$client->setAuth('shopId', 'secretKey');

3. Call the required API method.

   More details in our documentation for the YooKassa API.

   More details in our documentation for the YooKassa SDK.

Examples of using the API SDK

YooKassa SDK Settings

• Authentication
• Statistics about the environment used
• Getting information about the store
• Working with Webhook
• Notifications

Working with payments

• Request to create a payment
• Request to create a payment via the builder
• Request for partial payment confirmation
• Request to cancel an incomplete payment
• Get payment information
• Get a list of payments with filtering

Working with refunds

• Request to create a refund
• Request to create a refund via the builder
• Get refund information
• Get a list of returns with filtering

Working with receipts

• Request to create a receipt
• Request to create a receipt via the builder
• Get information about the receipt
• Get a list of receipts with filtering

Working with safe deals

• Request to create a deal
• Request to create a deal via the builder
• Request to create a payment with info about deal
• Request to create a payout
• Get deal information
• Get a list of deals with filtering
• Get payout information