SDK Reference
Add Credits
Use this when a user tops up their wallet, completes a task, or receives a reward.
typescript
await settle.wallet.credit('user_123', {
amount: 100, // Credits to add — must be >= 1
description: 'Top-up via Paystack', // Shown in transaction history
metadata: { // Optional
paymentReference: 'ss_1234567890_abc',
},
})Request fields#
| Field | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | Credits to add. Must be a positive integer >= 1. |
description | string | No | Human-readable label for the transaction |
metadata | object | No | Any additional context |