Skip to main content
POST
Create Scheduled ACH Transfer

Authorizations

x-api-key
string
header
required

Your Meow API key, sent in the x-api-key header for authentication.

Headers

Idempotency-Key
string | null

A unique key you generate (1-50 printable ASCII characters, no spaces) so retrying this request never creates a duplicate. Reusing a key is rejected.

Required string length: 1 - 50
Pattern: ^[!-~]+$
x-entity-id
string<uuid>

Optional entity_id to scope requests to a specific entity.

Path Parameters

account_id
string
required

The ID of the account.

Body

application/json
amount
required

Amount to send on each occurrence, in USD.

Required range: 0.01 <= x <= 1000000
counterparty_id
string<uuid>
required

Contact to pay. Use list_contacts to find one.

rrule
string
required

Recurrence rule (RFC 5545 RRULE) defining the schedule.

Required string length: 1 - 120
description
string | null

Text shown on the recipient's bank statement.

Required string length: 1 - 10
internal_note
string | null

Private note, visible only inside Meow.

Required string length: 5 - 255
email
string<email> | null

Address to notify on each occurrence.

idempotency_key
string | null
deprecated

Deprecated: send the key in the Idempotency-Key header instead. When both are sent they must match.

Required string length: 1 - 50

Response

Successful Response

status
enum<string>
required
Available options:
pending,
pending_approval,
canceled,
processing,
error,
sent,
returned,
void
amount
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
description
string | null
required
counterparty_id
string<uuid>
required
rrule
string
required

RFC 5545 RRULE string. Required: DTSTART, RRULE. Allowed frequencies: WEEKLY, MONTHLY.

Required string length: 1 - 120
transfer_type
enum<string>
required

The rail a transfer moves on, as the customer API reports it.

Available options:
book,
usdc,
usdt,
pyusd,
cash,
usdg,
ach,
wire
approval_id
string<uuid>
required
id
string<uuid> | null
first_occurrence
string<date-time> | null

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

message
string | null