Preview Auto-Payment

Returns a preview of a recurring payment — fee breakdown and the net amount that will be sent each period. Preview before creating.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns a fee preview for a scheduled auto-payment before committing.

This endpoint is shared across Business Owner and Operator user types at the same URL:
POST /accounts/private/v1/auto-payment/preview

Role-Based Access

RoleAccess
Business OwnerOwn accounts only
OperatorOwn accounts only
AdvisorAccounts for clients in their assigned portfolio
Root AdvisorAny client account organization-wide
Branch ManagerAny client account within their branch
Head Branch ManagerAny client account across branches under their management
Super AdvisorAny client account organization-wide

Admin roles require the initiate_execute_user_transfers permission.

Body Params
string
required
string

TAPP Cash account ID (use this or accountToACH, not both)

string
required
accountToACH
object

External bank account (use this or accountIdTo, not both)

Headers
uuid
Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json