Wallets

Wallets

Get a list of wallet for the organization

get

Query parameters

per_pageintegerOptional

Number of transactions per page

Example: 15

Responses

200

Successful response

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Operation successful

401

Unauthorized

get

/api/organizations/{organization}/wallets

HTTPcURLJavaScriptPython

GET /api/organizations/{organization}/wallets HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Operation successful",
  "data": [
    {
      "id": 35,
      "transaction_type": "Usage transaction",
      "status": "Pending",
      "amount": "-100.00 SAR",
      "serivce_name": "other",
      "description": "Wallet recharge with -100 SAR",
      "created_at": "2024-08-28T08:00:10.000000Z"
    }
  ]
}

Create a new wallet for the organization

post

Path parameters

organizationintegerRequired

Organization ID

Example: 1

Body

application/json

namestringRequired

Wallet Name

Example: 1

Responses

201

Wallet created successfully

application/json

401

Unauthorized

422

Validation error

application/json

post

/api/organizations/{organization}/wallets

HTTPcURLJavaScriptPython

POST /api/organizations/{organization}/wallets HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "name": 1
}

{
  "success": true,
  "message": "Wallet created successfully",
  "data": {
    "id": 1,
    "service_id": 1,
    "balance": 100,
    "created_at": "2024-08-28T08:00:10.000000Z",
    "updated_at": "2024-08-28T08:00:10.000000Z"
  }
}

Get wallet details with assignments

get

Returns detailed information about a wallet including its assignments to workspaces and organization users

Authorizations

bearerAuth

Path parameters

organizationstring · uuidRequired

Organization UUID

walletstring · uuidRequired

Wallet UUID

Responses

200

Wallet details retrieved successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Wallet details retrieved successfully

403

Unauthorized access

application/json

404

Wallet or Organization not found

application/json

get

/api/organizations/{organization}/wallets/{wallet}

HTTPcURLJavaScriptPython

GET /api/organizations/{organization}/wallets/{wallet} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Wallet details retrieved successfully",
  "data": {
    "wallet": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "amount": "text",
      "currency_code": "text",
      "status": "text",
      "system": "text",
      "created_at": "2026-03-22T11:35:38.559Z",
      "updated_at": "2026-03-22T11:35:38.559Z"
    },
    "assignments": {
      "workspaces": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "assignment_id": "123e4567-e89b-12d3-a456-426614174000",
          "is_active": true
        }
      ],
      "organization_users": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "email": "text",
          "assignment_id": "123e4567-e89b-12d3-a456-426614174000",
          "is_active": true,
          "has_special_wallet": true
        }
      ]
    },
    "transactions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "amount": "text",
        "type": "text",
        "status": "text",
        "created_at": "2026-03-22T11:35:38.559Z"
      }
    ]
  }
}

Update wallet details

put

Path parameters

organizationintegerRequired

Organization ID

Example: 1

walletintegerRequired

Wallet ID

Example: 1

Body

application/json

namestringRequired

Wallet Name

Example: Updated Wallet Name

statusstringOptional

Wallet Status

Example: Active

Responses

200

Wallet updated successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Wallet updated successfully

401

Unauthorized

422

Validation error

application/json

put

/api/organizations/{organization}/wallets/{wallet}

HTTPcURLJavaScriptPython

PUT /api/organizations/{organization}/wallets/{wallet} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "name": "Updated Wallet Name",
  "status": "Active"
}

{
  "success": true,
  "message": "Wallet updated successfully",
  "data": {
    "id": 1,
    "name": "Updated Wallet Name",
    "status": "Active",
    "updated_at": "2024-08-28T08:00:10.000000Z"
  }
}

Transfer amount between wallets within the same organization

post

Path parameters

organizationintegerRequired

Organization ID

Example: 1

Body

application/json

from_wallet_idintegerRequired

Source wallet ID

Example: 1

to_wallet_idintegerRequired

Destination wallet ID

Example: 2

servicestring · enumRequired

Type of service

Example: smsPossible values:

amountintegerRequired

Amount to transfer

Example: 100

Responses

200

Successful transfer

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Transfer successful

datanullOptional

401

Unauthorized

404

Wallet not found

422

Validation error or wallets from different organizations

application/json

post

/api/organizations/{organization}/wallets/transfer

HTTPcURLJavaScriptPython

POST /api/organizations/{organization}/wallets/transfer HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "from_wallet_id": 1,
  "to_wallet_id": 2,
  "service": "sms",
  "amount": 100
}

{
  "success": true,
  "message": "Transfer successful",
  "data": null
}

Get wallet transactions

get

Retrieves paginated list of wallet transactions ordered by ID descending

Authorizations

bearerAuth

Path parameters

organizationinteger · int64Required

Organization ID

walletinteger · int64Required

Wallet ID

Query parameters

pageintegerOptional

Page number

Default: 1

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: OK

403

Unauthorized access

application/json

404

Wallet or Organization not found

application/json

get

/api/organizations/{organization}/wallets/{wallet}/transactions

HTTPcURLJavaScriptPython

GET /api/organizations/{organization}/wallets/{wallet}/transactions HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "OK",
  "data": {
    "current_page": 1,
    "first_page_url": "text",
    "from": 1,
    "last_page": 1,
    "last_page_url": "text",
    "next_page_url": "text",
    "path": "text",
    "per_page": 15,
    "prev_page_url": "text",
    "to": 1,
    "total": 1
  }
}

Get wallet transactions

get

Retrieves paginated list of wallet transactions ordered by ID descending

Authorizations

bearerAuth

Path parameters

organizationinteger · int64Required

Organization ID

walletinteger · int64Required

Wallet ID

Query parameters

pageintegerOptional

Page number

Default: 1

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: OK

403

Unauthorized access

application/json

404

Wallet or Organization not found

application/json

get

/api/organizations/{organization}/wallets/transactions

HTTPcURLJavaScriptPython

GET /api/organizations/{organization}/wallets/transactions HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "OK",
  "data": {
    "current_page": 1,
    "first_page_url": "text",
    "from": 1,
    "last_page": 1,
    "last_page_url": "text",
    "next_page_url": "text",
    "path": "text",
    "per_page": 15,
    "prev_page_url": "text",
    "to": 1,
    "total": 1
  }
}

Assign wallet to an entity (workspace or organization user)

post

Assigns the specified wallet to either a workspace or organization user

Authorizations

bearerAuth

Path parameters

organizationstring · uuidRequired

Organization UUID

walletstring · uuidRequired

Wallet UUID

Body

application/json

assignable_typestring · enumRequired

Type of entity to assign the wallet to

Possible values:

assignable_idstring · uuidRequired

ID of the entity to assign the wallet to

Responses

200

Wallet assigned successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Wallet assigned successfully

403

Unauthorized access

application/json

404

Organization or Wallet not found

application/json

422

Validation error or invalid argument

application/json

post

/api/organizations/{organization}/wallets/{wallet}/assignment

HTTPcURLJavaScriptPython

POST /api/organizations/{organization}/wallets/{wallet}/assignment HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "assignable_type": "organization_user",
  "assignable_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "success": true,
  "message": "Wallet assigned successfully",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "wallet_id": "123e4567-e89b-12d3-a456-426614174000",
    "assignable_type": "text",
    "assignable_id": "123e4567-e89b-12d3-a456-426614174000",
    "is_active": true,
    "created_at": "2026-03-22T11:35:38.559Z",
    "updated_at": "2026-03-22T11:35:38.559Z"
  }
}

Get all possible assignments for a wallet

get

Retrieves all workspaces and organization users with their wallet assignment status

Authorizations

bearerAuth

Path parameters

organizationstring · uuidRequired

Organization UUID

walletstring · uuidRequired

Wallet UUID

Responses

200

Successfully retrieved assignments

application/json

messagestringOptionalExample: Assignments retrieved successfully

403

Wallet does not belong to this organization

application/json

404

Organization or Wallet not found

application/json

500

Server error

application/json

get

/api/organizations/{organization}/wallets/{wallet}/assignments

HTTPcURLJavaScriptPython

GET /api/organizations/{organization}/wallets/{wallet}/assignments HTTP/1.1
Accept: */*

{
  "message": "Assignments retrieved successfully",
  "data": {
    "workspaces": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "workspace",
        "is_assigned": true,
        "assignment": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "wallet_id": "123e4567-e89b-12d3-a456-426614174000",
          "is_active": true
        }
      }
    ],
    "organization_users": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "type": "organization_user",
        "is_assigned": true,
        "has_special_wallet": true,
        "assignment": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "wallet_id": "123e4567-e89b-12d3-a456-426614174000",
          "is_active": true
        }
      }
    ]
  }
}

Remove a wallet assignment

delete

Removes the assignment of a wallet from a workspace or organization user

Authorizations

bearerAuth

Path parameters

organizationstring · uuidRequired

Organization UUID

walletstring · uuidRequired

Wallet UUID

Body

application/json

assignable_typestring · enumRequired

Type of entity to remove the wallet assignment from

Possible values:

assignable_idstring · uuidRequired

ID of the entity to remove the wallet assignment from

Responses

200

Assignment removed successfully

application/json

messagestringOptionalExample: Wallet assignment removed successfully

404

Assignment not found

application/json

422

Validation error

application/json

delete

/api/organizations/{organization}/wallets/{wallet}/assignments

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organization}/wallets/{wallet}/assignments HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "assignable_type": "organization_user",
  "assignable_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "message": "Wallet assignment removed successfully"
}