Update wallet

PATCH

https://api.staging.vrtx.sa/cl/v1/wallets/{wallet_id}

Last modified:2025-12-03 07:59:44

Update editable metadata of a wallet that is linked to a closed-loop business account.
This endpoint allows businesses to manage wallet-level attributes such as display name, label, description, or external reference — without affecting balances or operational states.

Only metadata fields can be modified; financial or system-managed properties (like balance, type, or currency) are read-only.

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

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Example

{
    //"name": "محفظة كبار العملاء",
    //"external_reference": "WALLET-001",
    "can_overdraft": true,
    //"status": "ACTIVE"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "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"
}

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-12-03 07:59:44

Lookup wallet

Get wallet

Update wallet

Editable Fields#

Request

Request Code Samples

Responses

Editable Fields