OpenAPI Specification
openapi: 3.1.0
info:
title: Meow Accounts Payment Methods API
description: '## Overview
The Meow API provides financial services and billing capabilities for your business.
### Core Features
- **Financial data access**: access account information, transactions, balances, and payment networks.
- **Crypto operations**: create and manage crypto contacts, and initiate USDC transfers across blockchain networks.
### Billing API
The Billing API lets you create and manage invoices and collect payments:
- **Product management**: create and manage products with custom pricing.
- **Customer management**: maintain invoicing customers with their addresses.
- **Invoice creation**: generate invoices with line items, discounts, and custom notes.
- **Payment options**: accept payments via ACH, wire, international wire, card, and USDC.
- **Collection accounts**: configure accounts for payment collection.
### Getting Started
Authenticate by sending your API key in the `x-api-key` request header.
To scope requests to a specific entity, include the `x-entity-id` header. 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; use `debug_message` 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
'
contact:
name: Meow
url: https://meow.com/
email: support@meow.com
version: 1.0.0
license:
name: Proprietary
url: https://www.meow.com/terms-of-service
servers:
- url: https://api.meow.com/v1
description: Meow API Production
- url: https://api.sandbox.meow.com/v1
description: Meow API Sandbox
security:
- apiKeyAuth: []
tags:
- name: Payment Methods
description: View available payment method types.
paths:
/billing/payment-method-types:
get:
tags:
- Payment Methods
summary: Get Payment Method Types
description: Returns the payment method types available to you.
operationId: get_payment_method_types_billing_payment_method_types_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodTypes'
security:
- apiKeyAuth:
- billing:invoices:read
parameters:
- $ref: '#/components/parameters/EntityIdHeader'
components:
parameters:
EntityIdHeader:
name: x-entity-id
in: header
required: false
schema:
type: string
format: uuid
description: Optional `entity_id` to scope requests to a specific entity.
schemas:
PaymentMethodTypes:
properties:
allowed_types:
items:
$ref: '#/components/schemas/PaymentMethodType'
type: array
title: Allowed Types
description: List of allowed payment method types.
type: object
required:
- allowed_types
title: PaymentMethodTypes
PaymentMethodType:
type: string
enum:
- BANK_TRANSFER
- CARD
- ACH_DIRECT_DEBIT
- INTERNATIONAL_WIRE
- USDC_ETHEREUM
- USDC_SOLANA
- USDC_BASE
- USDT_ETHEREUM
- USDT_SOLANA
- CASH_SOLANA
title: PaymentMethodType
x-enum-varnames:
- BANK_TRANSFER
- CARD
- ACH_DIRECT_DEBIT
- INTERNATIONAL_WIRE
- USDC_ETHEREUM
- USDC_SOLANA
- USDC_BASE
- USDT_ETHEREUM
- USDT_SOLANA
- CASH_SOLANA
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: Your Meow API key, sent in the `x-api-key` header for authentication.
x-scopes:
- accounts:read
- accounts:write
- accounts:payment-networks
- accounts:transactions
- accounts:balances
- accounts:statements
- accounts:tax-documents
- entity:create
- transfers:crypto:write
- transfers:usdc:write
- transfers:ach:write
- transfers:wire:write
- transfers:book:write
- contacts:read
- contacts:write
- billing:products:read
- billing:products:write
- billing:customers:read
- billing:customers:write
- billing:invoices:read
- billing:invoices:write
- billing:accounts:read
- billpay:read
- billpay:write
- onboarding:read
- onboarding:write
- cards:read
- cards:write
- webhooks:read
- webhooks:write
- partner:onboarding:read
- partner:onboarding:write
- partner:webhooks:read
- partner:webhooks:write
- simulations:write
- banking:limits:read
- banking:limits:write
x-tagGroups:
- name: Core API
tags:
- API Keys
- Contacts
- Accounts
- Transactions
- Balances
- Payment Networks
- Transfers
- Routing Numbers
- Cards
- Tax Forms
- Webhooks
- name: Bill Pay
tags:
- Bills
- name: Billing
tags:
- Products
- Customers
- Invoices
- Line Items
- Payment Methods
- Collection Accounts
- name: Partner Onboarding
tags:
- Partner Onboarding
- name: Sandbox
tags:
- Simulations