latestOpenAPI 3.1.02026-07-26457177.8 KB

09f0430e5d33

Routines

Create a book transfer routine

📘

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

Create a new book transfer routine (a book transfer between two Payment Instruments).

The access_token must be issued to the Business User that was created with the Business Profile ID attached to the client. This Business User is visible in the Dashboard under the Account Identifiers section in the production Dashboard or the sandbox Dashboard.

📘

The resulting Book Routine ID (id) can be queried against GET /v1/routines/{id}. The resulting Book Transfer ID can be queried against GET /v1/transfers/{transfer_id}. Both Routine and Transfer status updates will trigger the associated Routine webhooks and Transfer webhooks.

🚧

In the event of any failure response, the routine is not created.

post/v1/routines/book

Parameters

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

Request body

namestring required

The name of the book transfer routine

amountnumber float required

The amount of the transfer, in USD

sourcestring required

The Payment Instrument ID to originate the transfer

destinationstring required

The Payment Instrument ID to receive the transfer

Response

The routine was created successfully.

idstring

The unique ID of the Routine

namestring

The name given for the Routine

amountnumber float

The amount of the transfer

sourcestring

The Payment Instrument ID that originated the transfer

destinationstring

The Payment Instrument ID that received the transfer

payment_route'book'

Payment route type

start_datestring date

The date the Routine should start processing.

createdstring date-time

The date the Routine was created

statusstring

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