Skip to content

Meow API (1.0.0)

Overview

The Meow API provides comprehensive financial services and billing capabilities for businesses.

Core Features

  • Financial Data Access: Securely access account information, transactions, balances, and payment networks
  • USDC Operations: Create and manage cryptocurrency contacts, initiate USDC transfers across multiple blockchain networks

Billing API

The Billing API enables businesses to streamline their invoicing and payment collection:

  • Product Management: Create and manage products with customizable pricing
  • Customer Management: Maintain invoicing customers with billing addresses
  • Invoice Creation: Generate invoices with line items, discounts, and custom notes
  • Flexible Payment Options: Accept payments via bank transfer, ACH, cards, international wires, and USDC
  • Collection Accounts: Configure accounts for automated payment collection

Getting Started

Authenticate using your API key in the request header: x-api-key: your-api-key

For multi-entity access, you can optionally include the x-entity-id header to scope API requests to a specific entity. Use the /api-keys/accessible-entities endpoint to list all entities accessible by your API key.

Error Responses

Errors return JSON with code, message, and debug_message. The code aligns with FDX where possible; debug_message is for troubleshooting only.

Common error codes:

  • 500: Internal server error
  • 501: Subsystem unavailable
  • 503: Scheduled maintenance
  • 601: Data not found
  • 602: Customer not authorized
  • 701: Account not found
  • 703: Invalid input (including invalid date ranges)
  • 704: Account type not supported
  • 705: Account is closed
  • 801: Transaction not found
Download OpenAPI description
index.json
index.yaml
Overview
URL
https://meow.com/
Meow
support@meow.com
License
Proprietary
Languages
Servers
Mock server
https://docs.meow.com/_mock/meow_api
Meow API Production
https://api.meow.com/v1
Meow API Sandbox
https://api.sandbox.meow.com/v1

API Keys

Retrieve metadata about API keys and their accessible entities

Operations

List Accessible Entities

Request

List all entities accessible by the current API key.

This endpoint returns the entities the API key holder can administer (write access), including entity IDs and names. This helps customers know which entity IDs they can use in the x-entity-id header when making API calls.

Returns: ListAccessibleEntitiesResponse: List of accessible entities with their IDs and names

Security
apiKeyAuth
curl -i -X GET \
  https://docs.meow.com/_mock/meow_api/api-keys/accessible-entities \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
entitiesArray of objects(Entities)required

List of entities accessible by this API key

Example: [{"access_type":"global_api_key","entity_id":"94a60dc7-93ab-4fed-8b2f-4008cdf7289b","entity_name":"AMITY","role":"Admin"},{"access_type":"global_api_key","entity_id":"123e4567-e89b-12d3-a456-426614174000","entity_name":"Acme Corp","role":"Viewer"},{"access_type":"entity_api_key","entity_id":"123e4567-e89b-12d3-a456-426614174111","entity_name":"Entity API Key Example"}]
entities[].​entity_idstring(Entity Id)required

The UUID of the entity

entities[].​entity_namestring(Entity Name)required

The name of the entity

entities[].​access_typestring(AccessibleEntityAccessType)required

How the API key gains access to the entity

Enum"global_api_key""entity_api_key"
entities[].​roleUserRoleEnum (string) or null

User role/permissions for this entity when applicable (only for global API keys)

Any of:

User role/permissions for this entity when applicable (only for global API keys)

string(UserRoleEnum)
Enum"Admin""Viewer""Bookkeeper""Controller""Card user""Card manager""Invoice user""AP Clerk""AP/AR Bookkeeper""None"
Response
application/json
{
  "entities": [
    { … },
    { … },
    { … }
  ]
}

Get Current Api Key

Request

Return metadata about the API key used for this request.

Security
apiKeyAuth
curl -i -X GET \
  https://docs.meow.com/_mock/meow_api/api-keys/current \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
idstring(Id)required

Opaque identifier for the API key

Example: "a_AEVN-4eFgihjZr8-BH3g"
key_typestring(ApiKeyType)required

Type of API key

Enum"entity""user"
Example: "entity"
scopesArray of strings(Scopes)required

Ordered list of scopes granted to this key

Items Enum"accounts:read""accounts:payment-networks""accounts:transactions""accounts:balances""accounts:statements""transfers:usdc:write""transfers:ach:write""transfers:wire:write""transfers:book:write""contacts:read"
Example: ["accounts:read","accounts:transactions","transfers:book:write"]
owner_entityApiKeyEntityInfo (object) or null

Entity associated with the key when applicable

Example: {"entity_id":"94a60dc7-93ab-4fed-8b2f-4008cdf7289b","entity_name":"AMITY"}
Any of:

Identifying information for the entity that owns an API key.

owner_emailOwner Email (string) or Owner Email (null)(Owner Email)

Email address of the user who owns the key when applicable

Any of:

Email address of the user who owns the key when applicable

string(Owner Email)
Response
application/json
{
  "id": "a_AEVN-4eFgihjZr8-BH3g",
  "key_type": "entity",
  "owner_entity": {
    "entity_id": "94a60dc7-93ab-4fed-8b2f-4008cdf7289b",
    "entity_name": "AMITY"
  },
  "scopes": [
    "accounts:read",
    "accounts:transactions",
    "transfers:book:write"
  ]
}

Contacts

Manage USDC contacts for cryptocurrency transfers

Operations

Accounts

Access and manage financial accounts

Operations

Transactions

View account transaction history and details

Operations

Balances

Check account balances and available funds

Operations

Payment Networks

Manage payment networks and routing information

Operations

Transfers

Initiate and manage USDC transfers

Operations

Routing Numbers

Validate routing numbers and get bank information

Operations

Bill

View and manage bills for vendor payments

Operations

Products

Manage products and pricing for invoicing

Operations

Customers

Manage billing customers and their information

Operations

Invoices

Create and manage invoices

Operations

Line Items

Manage invoice line items

Operations

Payment Methods

Configure available payment methods

Operations

Collection Accounts

Manage accounts for payment collection

Operations