Create a Journal

post

https://broker-api.sandbox.eu.alpaca.markets/v1/journals

A journal moves cash (JNLC) between accounts. 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: Reusing the same key with an identical request returns the
previously created journal without creating a duplicate. Reusing the same key with
a different request returns 422 Unprocessable Entity.

Body Params

Journals API allows you to move cash (JNLC) from one account to another.

This model represents the fields you can specify when creating a Journal

Fixture Rules

No Fixtures
- anything below limit is executed immediately
- anything above limit is pending until executed at EOD,
With Fixtures
- any status = rejected will be rejected EOD
- any status = pending will be pending forever

amount

string

required

Required if entry_type = JNLC

currency

string

The currency of the journal. Defaults to the system currency (for example, USD in the US or EUR in the EU) when omitted. Correspondents with local currency trading enabled must send this field, and the value must be the system currency or one of the correspondent's enabled currencies

description

string

length ≤ 1024

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

entry_type

string

enum

required

The type of journal. JNLC is the only supported value for now, used to move cash between accounts.

Allowed:

from_account

uuid

required

length ≥ 1

The account_id you wish to journal from

to_account

uuid

required

length ≥ 1

The account_id you wish to journal to

transmitter_account_number

string

length ≤ 255

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

transmitter_address

string

length ≤ 255

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

transmitter_financial_institution

string

length ≤ 255

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

transmitter_name

string

length ≤ 255

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

transmitter_timestamp

date-time

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

Headers

Idempotency-Key

string

length ≤ 128

Optional client-generated key for safe retries and duplicate request detection.
This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward
a 36-character maximum; new implementations should generate a unique UUIDv7 or
UUIDv4 value (36 characters including hyphens) for each logical operation. Do not
reuse a key across operations.

Responses

200The New Journal object

400One of the parameters is invalid.

403The amount requested to move is not available.

404One of the account is not found.

422The idempotency key was already used with a different request payload.