API Reference
Trading DashboardBroker Dashboard

Create a Batch Journal Transaction (One-to-Many)

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

You can create a batch of journal requests by using this endpoint. This is enabled on JNLC type Journals for now only.

Every single request must be valid for the entire batch operation to succeed.

In the case of a successful request, the response will contain an array of journal objects with an extra attribute error_message in the case when a specific account fails to receive a journal.

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 batch. A subsequent request returns the previously created batch 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 journal batches. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate batches. Use a client-generated unique value (e.g. UUID).

Body Params
string
enum
required

Only supports JNLC for now

Allowed:
uuid
required

The account id that is the originator of the funds being moved. Most likely is your Sweep Firm Account

string

Journal description, gets returned in the response

entries
array of objects
required
length ≥ 1

An array of objects describing which accounts you want to move funds into and how much to move into each account

entries*
uuid
required

The ID of the account that you want to journal funds into

string
required

Journal amount in USD

string

Currency

string

Only valid for JNLC journals. Null for JNLS. Max 255 characters.

string

Only valid for JNLC journals. Null for JNLS.max 255 characters

string

Only valid for JNLC journals. Null for JNLS.max 255 characters

string

Only valid for JNLC journals. Null for JNLS.max 255 characters

date-time
string

Journal entry description, gets returned in the response

Headers
string

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

Responses

Updated about 1 month ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago