Client Portal

  • error finding email
  • Remaining Credit: 0

Starbucks Corporation

Starbucks Corporation is an American multinational chain of coffeehouses and roastery reserves headquartered in Seattle, Washington. It was founded in 1971 by Jerry Baldwin, Zev Siegl, and Gordon Bowker at Seattle's Pike Place Market initially as a coffee bean wholesaler.

  • Coffeehouse
  • Food
  • Drinks

🌍 Greenwich, London

📍 O2 Arena, Greenwich Peninsula, London

 

 

 
 

RESTful API Documentation

Below you can find the documentation to interact with our enrichment API. There are two types of enrichment:

  • Single Enrichment: It will be available immediately upon request
  • Bulk Enrichment: It would be available after certain time but download link is given to download the result

Host URL: https://api.xyo.financial

Your API Key:

 

Endpoint:

POST /v1/ai/finance/enrichment/transaction

Enrichment Resource:

{
    "content": "UBREAT LONDON",
    "countryCode": "GB"
}

Enrichment Resource Properties:

  • content: Content of transaction e.g.: "UBEREAT LONDON" or "COSTA COLLECT"
  • countryCode: ISO Standard Country Code ISO 3166-1 Alpha-2

cURL Command

curl --location 'https://api.xyo.financial/v1/ai/finance/enrichment/transaction' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{"content":"UBEREAT LONDON","countryCode":"GB"}'

Enrichment Response:

HTTP/1.1 200 OK
{
    "merchant": "Uber Eats",
    "description": "Uber Eats is an online food ord....",
    "categories": [
        "Food Delivery",
        "Online Groceries"
    ],
    "logo": "data:image/png;base64,iVBORw0KGgoA....",
    "location": "London, United Kingdom",
    "address": null
}

Enrichment Response Properties:

  • merchant: Content of transaction e.g. "Starbucks" or "Transport for London"
  • description: Description of transaction.
  • categories: Maximum of three categories or industries by merchant
  • logo: base64 encoded image
  • location (Optional/Nullable): City, Country, or both
  • address: (Optional/Nullable) Complete Address with a postcode

Endpoint:

POST /v1/ai/finance/enrichment/transactions

Enrichment Resource:

[
    {
        "content": "Uber LONDON",
        "countryCode": "GB"
    },
    {
        "content": "COSTA COLLECT APP",
        "countryCode": "GB"
    }
]

Enrichment Resource Properties:

  • content: Content of transaction e.g.: "COSTA COLLECT" or "tfl GREENWICH STN"
  • countryCode: ISO Standard Country Code ISO 3166-1 Alpha-2

cURL Command

curl --location 'https://api.xyo.financial/v1/ai/banking/transaction/enrichment' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '[{"content":"Uber LONDON","countryCode":"GB"},{"content":"COSTA COLLECT APP","countryCode":"GB"}]'

Enrichment Response:

HTTP/1.1 200 OK
{
    "id": "3123-32132-13321312",
    "link": "https://api.xyo.financial/webhook/download/3123-32132-13321312.tar.gz"
}

Enrichment Response Properties:

  • id: UUID identifier for transaction enrichment job queue.
  • link: Download link to compressed file containing enriched transactions.

This API is only available to FinTech and Bank clients

Endpoint:

GET /v1/ai/finance/enrichment/transactions/status/{:id}'

Enrichment Resource:

id: UUID in string as a URL parameter

Enrichment Resource Properties:

  • id: URL Parameter UUID identifier from Bulk Transaction Enrichment API

cURL Command

curl --location 'https://api.xyo.financial/v1/ai/banking/transactions/enrichment/status/3123-32132-13321312' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \

Enrichment Response:

HTTP/1.1 200 OK
{
    "status": "READY",
    "message": ""
}

Enrichment Response Properties:

  • status: There are two available statuses:
    • READY: Can start downloading the given link from enrichment service
    • PENDING: A bit of patience required for the file to get ready for download
    • FAILED: message should have a useful information about diagnoses.

This API is only available to FinTech and Bank clients

Software Development Kits (SDKs)

Golang (Go) LogoNode.js (TypeScript/JavaScript) LogoPHP LogoRust Language Logo