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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the book transfer routine

float
required

The amount of the transfer, in USD

string
required

The Payment Instrument ID to originate the transfer

string
required

The Payment Instrument ID to receive the transfer

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json