Create a Journal

post

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

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.

Body Params

Journals API allows you to move cash or securities 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

to_account

uuid

required

length ≥ 1

The account_id you wish to journal to

from_account

uuid

required

length ≥ 1

The account_id you wish to journal from

entry_type

string

enum

required

This enum represents the various kinds of Journal alpaca supports.

Current values are:

JNLC

Journal Cash between accounts
JNLS

Journal Securities between accounts

Allowed:

amount

string

Required if entry_type = JNLC

symbol

string

Required if entry_type = JNLS

qty

string

Required if entry_type = JNLS

description

string

length ≤ 1024

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

transmitter_name

string

length ≤ 255

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

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_timestamp

date-time

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

currency

string

Headers

Idempotency-Key

string

An optional idempotency key can be used to ensure that a request is processed only once.

Responses

422

Unprocessable entity. The request is being rejected because of idempotency key violation: at least one field in the request has changed from the first request.

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.