An open API service indexing awesome lists of open source software.

https://github.com/syniol/xyo-sdk-php

XYO Financial SDK for PHP
https://github.com/syniol/xyo-sdk-php

Last synced: 5 months ago
JSON representation

XYO Financial SDK for PHP

Awesome Lists containing this project

README

          

# XYO Financial SDK for PHP
![workflow](https://github.com/syniol/xyo-sdk-php/actions/workflows/makefile.yml/badge.svg) ![workflow](https://github.com/syniol/xyo-sdk-php/actions/workflows/packagist_publish.yml/badge.svg)


PHP (Elephant) Mascot

Official PHP Mascot for XYO.Financial Generated by Adobe AI and Imagined by Syniol Limited

This SDK is official XYO.Financial and maintained by [Syniol Limited](https://syniol.com) for PHP Programming Language.
The minimum requirement is PHP version: `7.1.33`. It can be utilised for Trial and Premium accounts, given that a valid
API key is available to connect to and access the Enrichment services.

## Quickstart Guide
First you need to install the XYO SDK for PHP ecosystem via [Packagist](https://packagist.org/packages/xyo/sdk) package management.

```shell
composer require xyo/sdk
```

Client is an entry point to use the SDK. You need a valid API Key obtainable from https://xyo.financial/dashboard

__Create a Client__:
```php
use XYO\SDK\Client;
use XYO\SDK\ClientConfig;
use XYO\SDK\Enrichment\DTO\EnrichmentRequest;

$client = new Client(new ClientConfig("YourAPIKeyFromXYO.FinancialDashboard"))
```

__Enrich a Single Payment Transaction__:
```php
$enrichmentResult = $client->enrichTransaction(new EnrichmentRequest("Costa PICKUP", "GB"));

echo $enrichmentResult->merchant;
echo $enrichmentResult->description;
echo $enrichmentResult->categories;
echo $enrichmentResult->logo;
```

__Enrich Payment Transaction Collection _(Bulk Enrichment)___:
```php
$enrichmentCollectionResult = $client->enrichTransactionCollection([
new EnrichmentRequest("Costa PickUp", "GB"),
new EnrichmentRequest("STRBUKS GREENWICH", "GB")
]);

echo $enrichmentCollectionResult->id;
echo $enrichmentCollectionResult->link;
```

__Payment Transaction Collection Status__:
```php
$enrichmentCollectionStatusResult = $client->enrichTransactionCollectionStatus($enrichmentCollectionResult->id);

echo $enrichmentCollectionStatusResult->getStatus();
```

#### Credits
Copyright © 2025 Syniol Limited. All rights reserved.