Update wallet
PATCH
https://api.staging.vrtx.sa/cl/v1/wallets/{wallet_id}
Last modified:2025-12-03 07:59:44
This endpoint allows businesses to manage wallet-level attributes such as display name, label, description, or external reference — without affecting balances or operational states.
Editable Fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Optional | Custom name for wallet (e.g., “Marketing Wallet”) |
can_overdraft | string | Optional | Indicates whether wallet balance can overdraft (balance in minus) |
external_reference | string | Optional | Client-defined ID for linking with external systems |
status | string | Optional | Wallet operational state — supports: ACTIVE, INACTIVE, SUSPENDED |
Request
Path Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.staging.vrtx.sa/cl/v1/wallets/622ea233-3f21-450f-8758-e42cdd4e5e74' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
//"name": "محفظة كبار العملاء",
//"external_reference": "WALLET-001",
"can_overdraft": true,
//"status": "ACTIVE"
}'Response Response Example
200 - WalletUpdated
{
"id": "622ea233-3f21-450f-8758-e42cdd4e5e74",
"business_id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
"name": "Wallet for marketplace revenue",
"external_reference": "WALLET-Revenue-123",
"can_overdraft": false,
"status": "ACTIVE",
"account_number": "054200003017",
"currency": "SAR",
"balance": "0.00",
"created_at": "2025-10-25T07:13:51.196Z",
"updated_at": "2025-10-25T07:13:51.196Z"
}Modified at 2025-12-03 07:59:44