latestOpenAPI 3.1.02026-07-26457177.8 KB

09f0430e5d33

Routines

Create a card to account routine

📘

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

Create a card to account routine (funding from card)

🚧

This endpoint requires an enhanced client configuration for funding from card. Please contact customer support if you are interested in this feature.

post/v1/routines/card-to-account

Parameters

#/components/headers/Idempotency-Key — unresolved $ref

Request body

namestring required

The name of the routine

amountnumber float required

The amount of the transfer in USD

client_correlation_idstring required

A unique descriptor used to correlate a routine with the ACH Credit transfer (must be 8 characters in length)

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_fee_percentnumber float

Fee percentage applied to the debit OCT transfer

ultimate_receiver_idstring

The User ID of the ultimate receiver of the Routine

ultimate_sender_idstring

The User ID of the ultimate sender of the Routine

Response

Successful response

idstring

The unique ID of the Routine

statusstring

The Routine's status on the platform (see Routine Statuses)

namestring

The name given for the Routine

amountnumber float

The amount of the transfer

start_datestring date-time

The date the Routine should start processing.

createdstring date-time

The date the Routine was created

activeboolean

Whether the routine is active (True) or paused (False). Defaults to True.

payment_route'card_to_account'

Payment route type

type'one-time'

The type of Routine

blockedboolean

Whether the routine has been blocked for any reason.