Create a new Routine

post

https://api-sandbox.astra.finance/v1/routines

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

Use this Routine resource to request Card-to-Card and Account-to-Acccount (real-time, T+0, T+1, T+2, and T+4) payments.

Used for reconciliation purposes, the client_correlation_id is a custom, alphanumeric string which gets appended to the transactions description by way of the Debit or ACH addenda. The limits are as follows:

Debit Transactions: 8 Characters
ACH Transactions: 80 Characters
RTP / FedNow Transactions: 140 Characters

This endpoint creates a new Routine for a User.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 in USD

start_date

date-time

Optional. The date the Routine should start processing. If not supplied

preferred_settlement_speed

string

enum

The requested settlement speed for resulting transfers

Allowed:

frequency

string

enum

The frequency a repeating Routine should process

Allowed:

client_correlation_id

string

An optional correlation id that will be added to ACH or Debit Addenda. This will also be included in the Transfer response.

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%

ultimate_receiver_id

string

The User ID of the ultimate receiver of the Routine

ultimate_sender_id

string

The User ID of the ultimate sender of the Routine

Responses

201Successful response

400Bad Request

401Unauthorized

403Forbidden