Skip to main content
POST
Post an entry

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Headers

Idempotency-Key
string
required

Your unique key for this write, at most 255 characters. A retry with the same key and body gets the first answer back.

Maximum string length: 255

Body

application/json
kind
string
required
Example:

"TRANSFER"

postings
object[]
required

2 or more, balanced per currency

description
string
effectiveAt
string<date-time>
externalRef
string
Example:

"order-1042"

pending
boolean
metadata
object
holdId
string

A pending entry protected by a hold: the hold already reserves the debit, so it is not reserved twice.

feeSchedule
string

A fee schedule to charge: the fee is added to the first debit leg and credited to the schedule's income.

uniqueExternalRef
boolean

Allow one live entry with this external_ref: a second is refused with EXTERNAL_REF_EXISTS, whatever its Idempotency-Key. It holds against every other entry that set this flag; voiding an entry frees the reference.

Response

OK

id
string

je_…

status
enum<string>
Available options:
PENDING,
POSTED,
VOIDED
kind
string

TRANSFER, PAYOUT, INBOUND_CREDIT, FEE, FX, ADJUSTMENT, REVERSAL, SETTLEMENT …

description
string
effectiveAt
string<date-time>
businessDate
string

YYYY-MM-DD in the tenant's zone

externalRef
string
reversesId
string
reversedById
string
fxRateId
string
holdId
string
postings
object[]
metadata
object
createdBy
object

Who did something: a person signed in to the console, or an API key.

approvedBy
object

set on entries that came through maker-checker

latePosting
boolean
postedAt
string<date-time>
createdAt
string<date-time>
statusNote
string

why it ended up here: "Voided, hold expired", "To suspense"