Journals API allows you to move cash or securities from one account to another.
For more on creating and retrieving journals please check out our API reference section on journals.
The most common use case is cash pooling, a funding model where you can send bulk wires into your firm account and then move the money into each individual user account.
There are two types of journals:
Journal cash between accounts. You can simulate instant funding in both sandbox and production by journaling funds between your pre-funded sweep accounts and a user’s account.
You can only journal cash from a firm account to a user account and vice-versa but not from customer to customer.
Journal securities between accounts. Reward your users upon signing up or referring others by journaling small quantities of shares into their portfolios.
You can only journal securities from a firm account to a user account and not vice-versa or customer-to-customer.
The most common status flow for journals is quite simple:
- Upon creation, the journal will be created in a
- Then, the journal will be
sent_to_clearingmeaning that the request has been submitted to our books and records system.
- Lastly, if there are no issues the journal will be
executed, meaning that the cash or securities have been successfully moved into the receiving account.
Still, there are other cases in which the journal is
refused or requires manual intervention from Alpaca's cashiering team.
|This is the initial status when the journal is still in the queue to be processed.
|The journal has been sent to be processed by Alpaca’s booking system.
|The journal has been completed and the balances have been updated for the accounts involved in the transaction. In some rare cases, journals can be reversed from this status by Alpaca's cashiering team if the transaction is not permitted.
|The journal is pending to be processed as it requires manual approval from Alpaca operations, for example, this can be caused by hitting the journal limits.
|The journal has been manually rejected.
|The journal has been canceled, either via an API request or by Alpaca's operations team.
|The journal was never posted in Alpaca's ledger, probably because some of the preliminary checks failed. A common example would be a replayed request in close succession, where the first request is executed and the second request fails the balance check.
|The journal has been manually corrected. The previously executed journal is cancelled and a new journal with the correct amount is created.
|The journal has been deleted from our ledger system.
Updated 3 months ago