XYO Financial SDK (Node.js)

This SDK is official XYO.Financial and maintained by Syniol Limited. 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 or yarn package management.

npm:

npm i xyo-sdk

yarn:

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

const xyo = require('xyo-sdk');

(async () => {
  const client = new xyo.Client(new xyo.ClientConfig({ apiKey: 'YourAPIKeyFromXYO.FinancialDashboard' }))
})()

ES6+ and TypeScript Example

import { Client, ClientConfig } from 'xyo-sdk'

(async () => {
  const client = new Client(new ClientConfig({ apiKey: 'YourAPIKeyFromXYO.FinancialDashboard' }))
})()

Enrich a Single Payment Transaction:

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):

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:

const enrichedTransactionCollectionStatus = client.enrichTransactionCollectionStatus(enrichedTransactionCollection.id)

console.log(enrichedTransactionCollectionStatus)

Credits

Copyright © 2025 Syniol Limited. All rights reserved.