Skip to main content
POST
Create an adjustment

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency
string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409, and an idempotency storage failure returns 500. These refusals are problem documents.

Query Parameters

contextId
string<uuid>
required

Context ID Context ID the adjustment belongs to

Body

application/json

Adjustment payload

amount
string
required

Adjustment amount (decimal string)

Minimum string length: 1
Example:

"10.50"

currency
string
required

ISO 4217 currency code

Required string length: 3
Example:

"USD"

description
string
required

Human-readable description

Minimum string length: 1
Example:

"Bank wire fee adjustment"

direction
enum<string>
required

Adjustment direction

Available options:
DEBIT,
CREDIT
Example:

"DEBIT"

reason
string
required

Reason for the adjustment

Minimum string length: 1
Example:

"Variance due to bank processing fee"

type
enum<string>
required

Adjustment type

Available options:
BANK_FEE,
FX_DIFFERENCE,
ROUNDING,
WRITE_OFF,
MISCELLANEOUS
Example:

"BANK_FEE"

matchGroupId
string

Match group the adjustment balances (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

transactionId
string

Single transaction the adjustment balances (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Indicates that the resource was successfully created.

adjustment
object
required

The balancing adjustment that was created