Skip to content

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

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

Request

Returns details about a wire transfer for the specified account by wire transfer ID.

Security
apiKeyAuth
Path
account_idstring(Account Id)required

The ID of the account.

wire_transfer_idstring(Wire Transfer Id)required

The transaction group ID for the wire transfer

Headers
x-entity-idstring(uuid)

Optional entity ID for scoped access to entity-specific data

curl -i -X GET \
  'https://docs.meow.com/_mock/meow_api/accounts/{account_id}/wires/{wire_transfer_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-entity-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Successful Response

Bodyapplication/json
idstring(Id)required

The unique identifier for the wire transfer

Example: "wire_123456"
amountstring(Amount)required

The amount of the transfer

Example: "1000.00"
statusstring(TransferStatus)required

The current status of the transfer

Enum"pending""canceled""processing""error""sent""returned""void"
Example: "sent"
instructionsInstructions (string) or Instructions (null)(Instructions)

Instructions or OBI (Originator to Beneficiary Information)

Example: "Wire transfer for invoice payment"
Any of:

Instructions or OBI (Originator to Beneficiary Information)

string(Instructions)
counterparty_idCounterparty Id (string) or Counterparty Id (null)(Counterparty Id)

The unique identifier for the counterparty

Example: "cp_789"
Any of:

The unique identifier for the counterparty

string(uuid)(Counterparty Id)
counterparty_namestring(Counterparty Name)required

The name of the counterparty

Example: "ABC Corp"
counterparty_account_numberstring(Counterparty Account Number)required

The account number of the counterparty

Example: "123456789"
counterparty_routing_numberstring(Counterparty Routing Number)required

The routing number of the counterparty

Example: "021000021"
counterparty_bank_namestring(Counterparty Bank Name)required

The name of the counterparty's bank

Example: "Chase Bank"
created_atstring(date-time)(Timestamp)required

ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to IETF RFC3339

Example: "2024-01-01T12:00:00Z"
updated_atstring(date-time)(Timestamp)required

ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to IETF RFC3339

Example: "2024-01-01T12:00:00Z"
errorError (string) or Error (null)(Error)

Error message if the transfer failed

Any of:

Error message if the transfer failed

string(Error)
imadImad (string) or Imad (null)(Imad)

IMAD (Input Message Accountability Data) for the wire

Example: "2024010100000001"
Any of:

IMAD (Input Message Accountability Data) for the wire

string(Imad)
purposePurpose (string) or Purpose (null)(Purpose)

The purpose of the wire transfer

Example: "invoice_payment"
Any of:

The purpose of the wire transfer

string(Purpose)
internal_noteInternal Note (string) or Internal Note (null)(Internal Note)

An internal note associated with the transfer

Example: "Payment for invoice 123"
Any of:

An internal note associated with the transfer

string(Internal Note)
Response
application/json
{ "amount": "1000.00", "counterparty_account_number": "123456789", "counterparty_bank_name": "Chase Bank", "counterparty_id": "cp_789", "counterparty_name": "ABC Corp", "counterparty_routing_number": "021000021", "created_at": "2024-01-01T12:00:00Z", "id": "wire_123456", "imad": "2024010100000001", "instructions": "Wire transfer for invoice payment", "internal_note": "Payment for invoice 123", "purpose": "invoice_payment", "status": "sent", "updated_at": "2024-01-01T12:00:00Z" }

Request

Returns details about an ACH transfer for the specified account by ACH transfer ID.

Security
apiKeyAuth
Path
account_idstring(Account Id)required

The ID of the account.

ach_transfer_idstring(Ach Transfer Id)required

The transaction group ID for the ACH transfer (e.g. withdrawal_ach_...), or a Treasury Prime ACH id returned from create_ach (e.g. ach_...)

Headers
x-entity-idstring(uuid)

Optional entity ID for scoped access to entity-specific data

curl -i -X GET \
  'https://docs.meow.com/_mock/meow_api/accounts/{account_id}/achs/{ach_transfer_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-entity-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Successful Response

Bodyapplication/json
idstring(Id)required

The unique identifier for the ACH transfer

amountstring(Amount)required

The amount of the transfer

statusstring(TransferStatus)required

The current status of the transfer

Enum"pending""canceled""processing""error""sent""returned""void"
descriptionDescription (string) or Description (null)(Description)

A description of the transfer

Any of:

A description of the transfer

string(Description)
counterparty_idCounterparty Id (string) or Counterparty Id (null)(Counterparty Id)

The unique identifier for the counterparty

Any of:

The unique identifier for the counterparty

string(uuid)(Counterparty Id)
counterparty_nameCounterparty Name (string) or Counterparty Name (null)(Counterparty Name)

The name of the counterparty

Any of:

The name of the counterparty

string(Counterparty Name)
counterparty_account_numberCounterparty Account Number (string) or Counterparty Account Number (null)(Counterparty Account Number)

The account number of the counterparty

Any of:

The account number of the counterparty

string(Counterparty Account Number)
counterparty_routing_numberCounterparty Routing Number (string) or Counterparty Routing Number (null)(Counterparty Routing Number)

The routing number of the counterparty

Any of:

The routing number of the counterparty

string(Counterparty Routing Number)
created_atstring(date-time)(Timestamp)required

ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to IETF RFC3339

updated_atstring(date-time)(Timestamp)required

ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to IETF RFC3339

internal_noteInternal Note (string) or Internal Note (null)(Internal Note)

An internal note associated with the transfer

Any of:

An internal note associated with the transfer

string(Internal Note)
additional_detailsAdditional Details (string) or Additional Details (null)(Additional Details)

Additional details about the transfer

Any of:

Additional details about the transfer

string(Additional Details)
trace_numberTrace Number (string) or Trace Number (null)(Trace Number)

The ACH trace number for the transfer

Any of:

The ACH trace number for the transfer

string(Trace Number)
payment_related_infoPayment Related Info (string) or Payment Related Info (null)(Payment Related Info)

Payment related information (e.g. for incoming ACH)

Any of:

Payment related information (e.g. for incoming ACH)

string(Payment Related Info)
Response
application/json
{ "id": "string", "amount": "string", "status": "pending", "description": "string", "counterparty_id": "fd38dae9-b300-4017-a630-101c4279eafd", "counterparty_name": "string", "counterparty_account_number": "string", "counterparty_routing_number": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "internal_note": "string", "additional_details": "string", "trace_number": "string", "payment_related_info": "string" }

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