The WalletTransaction object
Represents a transaction in the merchant's wallet. Wallet transactions track all movements of funds including credits from payments, debits from payouts, and adjustments.
Fields
| Field | Type | Description |
|---|---|---|
id REQUIRED | string | Unique identifier for the wallet transaction |
merchantId REQUIRED | string | ID of the merchant whose wallet was affected |
type REQUIRED | 'credit'| 'debit'| 'adjustment'| 'settlement'| 'fee'| 'refund' | Type of wallet transaction |
amount REQUIRED | number | Transaction amount in the smallest currency unit |
currency REQUIRED | string | Three-letter ISO currency code |
balance REQUIRED | number | Wallet balance after this transaction |
description REQUIRED | string | Human-readable description of the transaction |
referenceId OPTIONAL | string | ID of the related resource (payment, refund, etc.) |
referenceType OPTIONAL | 'payment'| 'refund'| 'payout'| 'settlement'| 'adjustment' | Type of the related resource |
metadata OPTIONAL | Record<string, unknown> | Custom key-value data attached to the transaction |
createdAt REQUIRED | string | ISO 8601 timestamp when the transaction occurred |
Example
{
"id": "obj_1a2b3c",
"merchantId": "merchant_1a2b3c",
"type": "credit",
"amount": 5000,
"currency": "USD",
"balance": 1,
"description": "string",
"referenceId": "reference_1a2b3c",
"createdAt": "2026-01-15T09:30:00Z"
}