Skip to main content

The WalletAdjustment object

Represents a manual adjustment to a wallet balance. Adjustments are typically made by administrators to correct errors or apply promotional credits.

Fields

FieldTypeDescription
id
REQUIRED
stringUnique identifier for the adjustment
merchantId
REQUIRED
stringID of the merchant whose wallet was adjusted
type
REQUIRED
'credit'| 'debit'Type of adjustment
amount
REQUIRED
numberAdjustment amount in the smallest currency unit
currency
REQUIRED
stringThree-letter ISO currency code
reason
REQUIRED
stringReason for the adjustment
approvedBy
OPTIONAL
stringID of the administrator who approved the adjustment
createdAt
REQUIRED
stringISO 8601 timestamp when the adjustment was made

Example

{
"id": "obj_1a2b3c",
"merchantId": "merchant_1a2b3c",
"type": "credit",
"amount": 5000,
"currency": "USD",
"reason": "string",
"approvedBy": "string",
"createdAt": "2026-01-15T09:30:00Z"
}