Auto-Payments

Business Owners can schedule recurring payments between business accounts or to external banks. Operators with the autoPay permission can also create and manage auto-payments on the Business Owner's behalf — those appear in the same list.

Preview Auto-Payment

POST /accounts/private/v1/auto-payment/preview

Auth: Business Owner access token

Always preview before creating — the response confirms the fee deducted each period.

{
  "accountIdFrom": "42",
  "accountIdTo": "15",
  "amount": "500.00"
}

To schedule a recurring payment to an external bank account:

{
  "accountIdFrom": "42",
  "amount": "500.00",
  "accountToACH": {
    "accountNumber": "123456789012",
    "routingNumber": "026009593",
    "accountOwnerName": "Acme Corp",
    "bankCountry": "US",
    "bankName": "JPMorgan Chase"
  }
}

Response:

{
  "data": {
    "amount": "500.00",
    "fee": "2.50"
  }
}

Create Auto-Payment

POST /accounts/private/v1/auto-payment

Auth: Business Owner access token

{
  "accountIdFrom": "42",
  "accountIdTo": "15",
  "amount": "500.00",
  "period": "monthly",
  "type": "until_cancel",
  "startDate": "02/01/2025",
  "description": "Monthly vendor retainer"
}

Field	Type	Required	Notes
`accountIdFrom`	string	✓	Source business account ID
`accountIdTo`	string		Destination TAPP Cash account
`accountToACH`	object		External bank (instead of `accountIdTo`)
`amount`	string (decimal)	✓	Per-period amount, must be > 0
`period`	string	✓	`weekly`, `biweekly`, `monthly`, or `one_time`
`type`	string	✓	Stop condition — see Auto-Payments overview
`startDate`	string	✓	`MM/DD/YYYY` — must be at least the next calendar day
`endDate`	string	Required when `type=end_date`	`MM/DD/YYYY`, must be ≥ `startDate`
`limitAmount`	string (decimal)	Required when `type=limit_amount`	Total cap
`description`	string		Up to 255 characters

List Auto-Payments

GET /accounts/private/v1/auto-payment

Auth: Business Owner access token

GET /accounts/private/v1/auto-payment?page[number]=1&page[size]=20
Authorization: Bearer <business_owner_token>

Returns all auto-payments on the business accounts — including those created directly and any created by Operators.

Field	Description
`id`	Auto-payment identifier
`amount`	Per-period payment amount
`period`	Payment frequency
`type`	Stop condition
`startDate`	First payment date
`status`	`active`, `cancelled`, or `completed`

Cancel Auto-Payment

PUT /accounts/private/v1/auto-payment/:autoPaymentId/cancel

Auth: Business Owner access token

Cancellation is immediate — no further payments will be processed. Business Owners can cancel any auto-payment on their accounts, including those created by Operators.

PUT /accounts/private/v1/auto-payment/88/cancel
Authorization: Bearer <business_owner_token>
V-Client-Device-Id: <device-uuid>