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-Key
string

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.

Query Parameters

contextId
string
required

Context ID

Body

application/json

Adjustment payload

amount
string
required
Example:

"10.50"

currency
string
required
Example:

"BRL"

direction
enum<string>
required

Direction of the adjustment

Available options:
DEBIT,
CREDIT
Example:

"DEBIT"

description
string
required
Example:

"Bank wire fee adjustment"

reason
string
required
Example:

"Variance due to bank processing fee"

type
enum<string>
required
Available options:
BANK_FEE,
FX_DIFFERENCE,
ROUNDING,
WRITE_OFF,
MISCELLANEOUS
Example:

"BANK_FEE"

matchGroupId
string<uuid>
Example:

"019c96a0-0b74-768c-8d25-2bf065dca2f8"

transactionId
string<uuid>
Example:

"019c96a0-10ce-75fc-a273-dc799079a99c"

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.

adjustment
object