Skip to main content
PATCH
/
wallets
/
wallet
/
restrict
Restrict Wallet
curl --request PATCH \
  --url https://waas-staging.embedly.ng/api/v1/wallets/wallet/restrict \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "id": "<string>",
  "walletGroupId": "<string>",
  "customerId": "<string>",
  "availableBalance": 123,
  "ledgerBalance": 123,
  "walletRestrictionId": "<string>",
  "walletClassificationId": "<string>",
  "currencyId": "<string>",
  "isInternal": true,
  "isDefault": true,
  "name": "<string>",
  "overdraft": 123,
  "virtualAccount": {},
  "mobNum": "<string>",
  "customerTypeId": "<string>"
}
'

​
Request Body

​
id
string
Unique identifier for the wallet. Example: “3fa85f64-5717-4562-b3fc-2c963f66afa6”
​
walletGroupId
string
required
The ID of the wallet group this wallet belongs to. Example: “3fa85f64-5717-4562-b3fc-2c963f66afa6”
​
customerId
string
required
The ID of the customer who owns this wallet. Example: “3fa85f64-5717-4562-b3fc-2c963f66afa6”
​
availableBalance
number
The balance available for transactions. Example: 0
​
ledgerBalance
number
The total balance including pending transactions. Example: 0
​
walletRestrictionId
string
ID referencing wallet restrictions. Example: “3fa85f64-5717-4562-b3fc-2c963f66afa6”
​
walletClassificationId
string
ID referencing wallet classification. Example: “3fa85f64-5717-4562-b3fc-2c963f66afa6”
​
currencyId
string
required
ID of the currency for this wallet. Example: “3fa85f64-5717-4562-b3fc-2c963f66afa6”
​
isInternal
boolean
Whether this is an internal wallet. Example: true
​
isDefault
boolean
Whether this is the default wallet for the customer. Example: true
​
name
string
required
Name of the wallet or wallet owner. Example: “Victor Imah”
​
overdraft
number
Available overdraft amount, if any. Example: 0
​
virtualAccount
object
Virtual account details associated with the wallet.
​
mobNum
string
Mobile number associated with the wallet. Example: “09030355074”
​
customerTypeId
string
ID referencing the customer type. Example: “3fa85f64-5717-4562-b3fc-2c963f66afa6”

​
Response

✅ Success Response Status Code: 200 OK 
{
  "code": "200",
  "success": true,
  "message": "Wallet restricted successfully.",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  }
}