Skip to main content
POST
Post a reversal of an existing journal entry

Authorizations

Authorization
string
header
required

OAuth2 JWT bearer tokens. Tokens are validated at API Gateway via a Lambda Authorizer that verifies signature against the issuer's JWKS, checks iss, aud, exp, nbf, and the tenant_id custom claim. Granular scopes are required per operation.

Headers

Idempotency-Key
string
required

Required on every POST. Must be a deterministic, client-chosen identifier unique per tenant. Recommended format: <event_type>:<resource_id>:<natural_key>. Retained for 24h minimum.

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:\-]{7,254}$
Example:

"payment:loan_42:proc_txn_abc123"

X-Trace-Id
string

Deprecated — use traceparent instead (ADR-0011). Client-supplied correlation ID. Accepted until 2026-10-01 for backward compatibility; will be removed after that date.

Pattern: ^[A-Za-z0-9\-]{8,128}$
traceparent
string

W3C Trace Context traceparent header for distributed tracing (RFC 7230). When present, the service extracts the parent span context and creates child spans under it, enabling end-to-end trace correlation across API Gateway, the service, and the database. Format: 00-<trace-id>-<parent-id>-<flags>

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$
Example:

"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"

tracestate
string

W3C Trace Context tracestate header. Carries vendor-specific trace metadata (e.g. AWS X-Ray sampling decision). Passed through unchanged.

Body

application/json
reverses_entry_id
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"11111111-1111-1111-1111-111111111111"

reason_code
enum<string>
required
Available options:
error_correction,
nsf_return,
fraud,
operational,
regulatory
reason_description
string
required
Required string length: 10 - 500
effective_at
string<date>

Defaults to the original entry's effective_at.

metadata
object

Free-form key-value metadata. Never used for financial logic. Size limit 2 KB serialized. Keys must match ^[a-zA-Z][a-zA-Z0-9_]*$.

Response

Idempotency replay.

journal_entry_id
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"11111111-1111-1111-1111-111111111111"

reverses_entry_id
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"11111111-1111-1111-1111-111111111111"

posted_at
string<date-time>
required

RFC 3339 timestamp, UTC.

correlation_id
string<uuid>
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"11111111-1111-1111-1111-111111111111"