Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Journals

Create a Journal

A journal can be JNLC (move cash) or JNLS (move shares), dictated by entry_type. Generally, journal requests are subject to approval and starts from the pending status. The status changes are propagated through the Event API. Under certain conditions agreed for the partner, such journal transactions that meet the criteria are executed right away.

Idempotency: When the Idempotency-Key header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one journal. A subsequent request returns the previously created journal with the same response (no duplicate is created). If the same key is used with a different request body, the API returns 422 Unprocessable Entity.

Recommended for production: Always supply Idempotency-Key when creating journals. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate journals. Use a client-generated unique value (e.g. UUID).

post/v1/journals

Headers

Idempotency-Keystring

Unique key for idempotent create. When supplied, duplicate requests (same key and body) return the original journal instead of creating a new one. Use a client-generated value (e.g. UUID) per logical journal. Strongly recommended for production to prevent duplicate journals on retries.

Request body

amountstring

Required if entry_type = JNLC

currencystring
descriptionstring

Max 1024 characters. Can include fixtures for amounts that are above the transaction limit

entry_type'JNLC' | 'JNLS' required

This enum represents the various kinds of Journal alpaca supports.

Current values are:

  • JNLC

    Journal Cash between accounts

  • JNLS

    Journal Securities between accounts

from_accountstring uuid required

The account_id you wish to journal from

qtystring

Required if entry_type = JNLS

symbolstring

Required if entry_type = JNLS

to_accountstring uuid required

The account_id you wish to journal to

transmitter_account_numberstring

Max 255 characters. See more details about Travel Rule in our main documentation.

transmitter_addressstring

Max 255 characters. See more details about Travel Rule in our main documentation.

transmitter_financial_institutionstring

Max 255 characters. See more details about Travel Rule in our main documentation.

transmitter_namestring

Max 255 characters. See more details about Travel Rule in our main documentation.

transmitter_timestampstring date-time

RFC 3339 format. See more details about Travel Rule in our main documentation.

Response

The New Journal object

OR

Example response

{
  "entry_type": "JNLS",
  "from_account": "8fjkjn-4483-4199-840f-6c5fe0b7ca24",
  "id": "h7h5g33f-ef01-4458-9a4b-9598727a406f",
  "price": "128.23",
  "qty": "2",
  "settle_date": "2020-12-24",
  "status": "executed",
  "symbol": "AAPL",
  "to_account": "3gtt65jd-6f2a-433c-8c33-17b66b8941fa"
}