v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Matching

Create an adjustment

Use this endpoint to create a balancing journal entry (e.g., bank fee, FX difference) to resolve variance between matched transactions or on a single transaction.

post/v1/matching/adjustments

Query parameters

contextIdstring required

Context ID

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

amountstring required

currencystring required

direction'DEBIT' | 'CREDIT' required

Direction of the adjustment

descriptionstring required

matchGroupIdstring uuid

reasonstring required

transactionIdstring uuid

type'BANK_FEE' | 'FX_DIFFERENCE' | 'ROUNDING' | 'WRITE_OFF' | 'MISCELLANEOUS' required

Example request

{
  "amount": "10.50",
  "currency": "BRL",
  "direction": "DEBIT",
  "description": "Bank wire fee adjustment",
  "matchGroupId": "019c96a0-0b74-768c-8d25-2bf065dca2f8",
  "reason": "Variance due to bank processing fee",
  "transactionId": "019c96a0-10ce-75fc-a273-dc799079a99c",
  "type": "BANK_FEE"
}

Response

Indicates that the resource was successfully created.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.