Routine Preview

post

https://api-sandbox.astra.finance/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.

Body Params

type

string

enum

required

The type of Routine

Allowed:

name

string

required

The name given for the Routine

payment_type

string

enum

required

The type of payment

Allowed:

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

float

required

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

start_date

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

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%

Responses

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful response

400Bad Request

401Unauthorized

403Forbidden