ALalpacahq
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: 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.

post/v1/journals

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/journals
  • Auth
    HTTP basic

Headers

Idempotency-Keystring

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.

Request body

amountstring

Required if entry_type = JNLC

currencystring

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

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.

Example request

{
  "amount": "51",
  "description": "Move cash to a customer account",
  "entry_type": "JNLC",
  "from_account": "7c891489-574f-4f9a-82f0-4082a07f4736",
  "to_account": "2d47a229-0c25-40a2-8cc7-b2c8821ff93a"
}

Response

The New Journal object

OR

Example response

{
  "currency": "USD",
  "description": "",
  "entry_type": "JNLC",
  "from_account": "8f8c8cee-2591-4f83-be12-82c659b5e748",
  "id": "56f106e5-25a4-4eee-96fa-25bb05dc86bc",
  "net_amount": "1000",
  "price": null,
  "qty": null,
  "settle_date": null,
  "status": "pending",
  "symbol": null,
  "system_date": null,
  "to_account": "399f85f1-cbbd-4eaa-a934-70027fb5c1de"
}

Changes

No recorded changes to this operation across all 1 revision of this API.