Sign in
latestOpenAPI 3.1.02026-07-26457177.8 KB

09f0430e5d33

Routines

Create an account to card routine

📘

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

Create an account to card routine (aka instant disbursement)

🚧

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

post/v1/routines/account-to-card

Parameters

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

Request body

OR

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'account_to_card'

Payment route type

type'one-time'

The type of Routine

blockedboolean

Whether the routine has been blocked for any reason.

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