latestOpenAPI 3.1.02026-07-26457177.8 KB

09f0430e5d33

Routines

Routine 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.

post/v1/routines/preview

Request body

type'one-time' | 'recurring' required

The type of Routine

namestring required

The name given for the Routine

payment_type'debit' required

The type of payment

source_idstring required

The ID of the Source Account

destination_idstring required

The ID of the Destination Account

destination_user_idstring

The User ID associated with the Destination Account (if peer-to-peer)

amountnumber float required

The amount of the transfer (when explicitly defined like one-time)

start_datestring 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_overridenumber 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

Successful response

idstring

The unique ID of the Routine

astra_feenumber float

Astra's fee for the transfer

createdstring date-time

Date and time of routine preview creation

customer_feenumber float

Customer fee for the transfer

destinationstring

The ID of the Destination Account

destination_user_idstring

The User ID associated with the Destination Account (if peer-to-peer)

estimated_settlementstring

Estimated settlement speed

payment_type'debit'

Type of payment

pull_amountnumber float

Pull amount for the transfer

push_amountnumber float

Push amount for the transfer

routine_type'one-time' | 'recurring'

The type of Routine

sourcestring

The ID of the Source Account