Entries

An entry is one financial event: two or more postings, written atomically. Entries are never edited.

The rules

At least two postings.
Debits equal credits in each currency.
An account appears at most once on each side.
Every amount is above zero, and each posting’s currency matches its account.
kind is required. It is your label, such as TRANSFER, PAYOUT or TRANSFER_IN, and you can filter on it.

Post

curl -X POST "$PANOQORE_URL/v1/entries" \
  -H "Authorization: Bearer $PANOQORE_API_KEY" \
  -H "Idempotency-Key: transfer-77" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "TRANSFER",
    "externalRef": "transfer-77",
    "postings": [
      {"accountId": "'"$WALLET_A"'", "side": "DEBIT",  "amount": "500", "currency": "NGN"},
      {"accountId": "'"$WALLET_B"'", "side": "CREDIT", "amount": "500", "currency": "NGN"}
    ]
  }'

effectiveAt backdates an entry, as long as its business date is in an open period. metadata is any JSON object of your own, returned with the entry. Keep personal data out of it.

Pending

Set "pending": true and the entry reserves the money without settling it. Then finish it.

curl -X POST "$PANOQORE_URL/v1/entries/$ENTRY/post" \
  -H "Authorization: Bearer $PANOQORE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" -d '{}'

Call	Result
`POST /v1/entries/{id}/post`	Status becomes `POSTED`.
`POST /v1/entries/{id}/void`	Status becomes `VOIDED`, and the money is back.

Doing either to an entry that is not pending gets ENTRY_NOT_PENDING.

Reverse

A reversal is a new entry with every leg on the opposite side. The original stays as it was, and gains reversedById.

curl -X POST "$PANOQORE_URL/v1/entries/$ENTRY/reverse" \
  -H "Authorization: Bearer $PANOQORE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Returned by the bank"}'

The new entry has kind: REVERSAL, reversesId pointing back, and the original’s externalRef. reason becomes its description. An entry can be reversed once. A key reverses at once; a person’s reversal goes to approval.

Linked batches

POST /v1/entries:batch takes entries, and either all of them commit or none do. If the second entry is refused, the first is not posted.

Guarding against a race

Each posting takes an optional ifMatchVersion, the version you read from the balance. If the account has moved since, the entry gets VERSION_CONFLICT and nothing posts.

{ "accountId": "acc_...", "side": "DEBIT", "amount": "100", "currency": "NGN", "ifMatchVersion": "9" }

Get started

Using the API

Concepts

Guides

The rules

Post

Pending

Reverse

Linked batches

Guarding against a race

​The rules

​Post

​Pending

​Reverse

​Linked batches

​Guarding against a race

The rules

Post

Pending

Reverse

Linked batches

Guarding against a race