Skip to main content
POST
/
accounts
/
{account_id}
/
ach
/
scheduled
Create Scheduled ACH Transfer
curl --request POST \
  --url https://api.meow.com/v1/accounts/{account_id}/ach/scheduled \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 500000.005,
  "counterparty_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idempotency_key": "<string>",
  "rrule": "<string>",
  "description": "<string>",
  "internal_note": "<string>",
  "email": "jsmith@example.com"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "amount": "<string>",
  "description": "<string>",
  "counterparty_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rrule": "<string>",
  "first_occurrence": "2023-11-07T05:31:56Z",
  "transfer_type": "book"
}

Authorizations

x-api-key
string
header
required

Your Meow API key for authentication

Headers

x-entity-id
string<uuid>

Optional entity ID for scoped access to entity-specific data

Path Parameters

account_id
string
required

The ID of the account.

Body

application/json
amount
required
Required range: 0.01 <= x <= 1000000
counterparty_id
string<uuid>
required
idempotency_key
string
required
Required string length: 1 - 50
rrule
string
required

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

Required string length: 1 - 120
description
string | null
Required string length: 1 - 10
internal_note
string | null
Required string length: 5 - 255
email
string<email> | null

Response

Successful Response

id
string<uuid>
required
status
enum<string>
required
Available options:
pending,
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
first_occurrence
string<date-time>
required

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

transfer_type
enum<string>
required
Available options:
book,
usdc,
usdt,
pyusd,
cash,
usdg,
ach,
wire