---
title: "Routine Preview"
method: POST
path: "/v1/routines/preview"
tags: ["Routines"]
---

# Routine Preview

`POST /v1/routines/preview`

> 📘
>
> You can place the bearer `access_token` for a specific user into the Authentication section of this documentation 👉.

This endpoint returns a fee structure payload as a response, which provides a preview of what the fee structure will be upon submitting a routine with the same parameters.

> 🚧
>
> This endpoint can only be used for previewing routines of a `debit` `payment_type`.

## Request body

- object
  - `type` 'one-time' | 'recurring', required — The type of Routine
  - `name` string, required — The name given for the Routine
  - `payment_type` 'debit', required — The type of payment
  - `source_id` string, required — The ID of the Source Account
  - `destination_id` string, required — The ID of the Destination Account
  - `destination_user_id` string — The User ID associated with the Destination Account (if peer-to-peer)
  - `amount` number, float, required — The amount of the transfer (when explicitly defined like one-time)
  - `start_date` string, date-time — Optional. The date the Routine should start processing. If not supplied, the start_date will default to the current day (in the Pacific Timezone). Debit start dates cannot be in the future.
  - `customer_debit_fee_percent_override` number, float — Optional parameter for applying a fee to a debit transfer through either an addition on the pull or a subtraction on the push. Contact your Astra admin to configure your clients to have this percentage fee be either additive or subtractive. For debit transfers only. Example amount: 1.25 = 1.25%

## Response `201`

Successful response

- object
  - `id` string — The unique ID of the Routine
  - `astra_fee` number, float — Astra's fee for the transfer
  - `created` string, date-time — Date and time of routine preview creation
  - `customer_fee` number, float — Customer fee for the transfer
  - `destination` string — The ID of the Destination Account
  - `destination_user_id` string — The User ID associated with the Destination Account (if peer-to-peer)
  - `estimated_settlement` string — Estimated settlement speed
  - `payment_type` 'debit' — Type of payment
  - `pull_amount` number, float — Pull amount for the transfer
  - `push_amount` number, float — Push amount for the transfer
  - `routine_type` 'one-time' | 'recurring' — The type of Routine
  - `source` string — The ID of the Source Account

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/astra/apis/astra-developer-api.md) · [All operations](https://skmtc.net/astra/apis/astra-developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/astra/astra-developer-api/revisions/09f0430e5d33/schema)
