https://github.com/syniol/xyo-sdk-node
an Official XYO Financial SDK for Node (TypeScript and JavaScript)
https://github.com/syniol/xyo-sdk-node
ai enrichment financial payment-transactions
Last synced: 5 months ago
JSON representation
an Official XYO Financial SDK for Node (TypeScript and JavaScript)
- Host: GitHub
- URL: https://github.com/syniol/xyo-sdk-node
- Owner: syniol
- License: apache-2.0
- Created: 2025-08-10T05:26:16.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-10-19T14:29:23.000Z (8 months ago)
- Last Synced: 2025-10-19T20:56:23.958Z (8 months ago)
- Topics: ai, enrichment, financial, payment-transactions
- Language: TypeScript
- Homepage: https://xyo.financial
- Size: 37.2 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# XYO Financial SDK (Node.js)
 
Unofficial Node.js 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). 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 node.js ecosystem via [npm](https://www.npmjs.com/package/xyo-sdk) or [yarn](https://yarnpkg.com/package/xyo-sdk) package management.
__npm__:
```shell
npm i xyo-sdk
```
__yarn__:
```shell
yarn add xyo-sdk
```
Client is an entry point to use the SDK. You need a valid API Key obtainable from https://xyo.financial/dashboard
__ES5 Example__
```js
const xyo = require('xyo-sdk');
(async () => {
const client = new xyo.Client(new xyo.ClientConfig({ apiKey: 'YourAPIKeyFromXYO.FinancialDashboard' }))
})()
```
__ES6+ and TypeScript Example__
```js
import { Client, ClientConfig } from 'xyo-sdk'
(async () => {
const client = new Client(new ClientConfig({ apiKey: 'YourAPIKeyFromXYO.FinancialDashboard' }))
})()
```
__Enrich a Single Payment Transaction__:
```js
const enrichedTransaction = client.enrichTransaction({
content: 'Costa PickUp',
countryCode: 'GB',
})
console.log(enrichedTransaction.merchant)
console.log(enrichedTransaction.description)
console.log(enrichedTransaction.categories)
console.log(enrichedTransaction.logo)
```
__Enrich Payment Transaction Collection _(Bulk Enrichment)___:
```js
const enrichedTransactionCollection = client.enrichTransactionCollection([
{
content: 'Costa PickUp',
countryCode: 'GB',
},
{
content: 'STRBUKS GREENWICH',
countryCode: 'GB',
},
])
console.log(enrichedTransactionCollection.id)
console.log(enrichedTransactionCollection.link)
```
__Payment Transaction Collection Status__:
```js
const enrichedTransactionCollectionStatus = client.enrichTransactionCollectionStatus(enrichedTransactionCollection.id)
console.log(enrichedTransactionCollectionStatus)
```
#### Credits
Copyright © 2025 Syniol Limited. All rights reserved.