Skip to main content
WEBHOOK
walletUpdated
{
  "userId": "507f1f77bcf86cd799439011",
  "currency": "GBP",
  "balance": 950.5,
  "availableBalance": 900.5,
  "source": "api_order_async",
  "timestamp": "2025-04-11T08:00:12.000Z",
  "transaction": {
    "type": "debit",
    "amount": 49.5,
    "orderId": "65f5a6b7c8d9e01234567890",
    "details": "Purchase of TESCO-GBP-50 from Tesco"
  }
}

Authorizations

​
X-API-Key
string
header
required

Your UGiftMe API key for authentication.

Format: Secure API key (e.g., <your-api-key>)

Required: All endpoints require this header

Example: X-API-Key: <your-api-key>

Headers

​
X-Webhook-Event
string
required

Event name (matches the subscribed event or webhook.test for test deliveries).

​
X-Webhook-Signature
string
required

HMAC-SHA256 hex digest of the JSON body, using your webhook secret.

Body

application/json
​
userId
string
required
​
currency
string
required
​
balance
number
required
​
availableBalance
number
required
​
source
string
required
Example:

"api_order_async"

​
timestamp
string<date-time>
required
​
transaction
object

Response

200

Your endpoint acknowledged the delivery (any 2xx)