Skip to main content
GET
/
wallets
/
{id}
Wallet details
curl --request GET \
  --url https://api.cartevo.co/api/v1/wallets/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "statusCode": 200,
  "message": "Data retrieved successfully",
  "data": {
    "id": "422541f3-80e2-41e0-b7a2-24017586b374",
    "balance": "0.24",
    "payin_balance": "306",
    "payout_balance": "1646",
    "payin_amount": "982.6",
    "payout_amount": "1994",
    "amount_to_recover": "0",
    "is_active": true,
    "currency": "XAF",
    "country": "Cameroon",
    "country_iso_code": "CM",
    "company_id": "eca5e982-00b5-4aa2-b709-7d5cd673e95c",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "country_phone_code": "237",
    "phoneNumbers": [
      {
        "id": "32e525ac-a4a3-47fa-896e-4ef89f64d2d0",
        "wallet_id": "422541f3-80e2-41e0-b7a2-24017586b374",
        "country_iso_code": "CM",
        "country_phone_code": "+237",
        "currency": "XAF",
        "phone_number": "650695112",
        "operator": "MTN",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "operators": [
      {
        "id": "f079c4db-4897-4ae7-9371-87950ad2429c",
        "country_iso_code": "CM",
        "country_phone_code": "237",
        "currency": "XAF",
        "operator_code": "mtn",
        "operator_name": "MTN Money",
        "otp_required": false,
        "ussd_code": "*126#",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "company": {
      "id": "eca5e982-00b5-4aa2-b709-7d5cd673e95c",
      "name": "Stark Industry",
      "email": "example@gmail.com",
      "country": "TD",
      "business_name": "<string>",
      "is_active": true
    },
    "payInAmount": 0,
    "payOutAmount": 0
  }
}

​
Overview

GET /wallets/{id} returns full details of one wallet, including its current pay-in / pay-out sub-balances and a summary of activity.

​
When to use it

  • Display a single wallet’s details in your dashboard.
  • Verify a wallet’s balance before initiating a payout (also covered by GET /payment/balance).
  • Reconcile lifetime volumes (payin_amount, payout_amount) against your accounting.

​
Prerequisites

  • The wallet must belong to your company.

​
Request

​
Headers

NameRequiredDescription
AuthorizationYesBearer <access_token>

​
Path parameters

NameTypeDescription
idstringWallet ID (UUID).

​
Response

​
200 — Success

{
  "success": true,
  "statusCode": 200,
  "message": "Data retrieved successfully",
  "data": {
    "id": "w1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "company_id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "currency": "XAF",
    "country": "Cameroon",
    "country_iso_code": "CM",
    "country_phone_code": "+237",
    "balance": 175000,
    "payin_balance": 125000,
    "payout_balance": 50000,
    "payInAmount": 200000,
    "payOutAmount": 75000,
    "amount_to_recover": 0,
    "is_active": true,
    "created_at": "2026-04-01T08:00:00.000Z",
    "updated_at": "2026-05-09T10:15:00.000Z",
    "company": {
      "id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "name": "Acme Inc.",
      "country": "Cameroon"
    }
  }
}
The shape mirrors the per-wallet entry in GET /wallets, with the addition of an embedded company summary. Note that lifetime volumes are exposed here as payInAmount / payOutAmount (camelCase, legacy) — they are the same numbers as payin_amount / payout_amount in the list view. See API Conventions → Field naming.

​
Error responses

StatusTrigger
404Wallet does not exist or belongs to another company.

​
Code examples

cURL
curl https://api.cartevo.co/api/v1/wallets/w1a2b3c4-d5e6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer $TOKEN"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Response

Detailed information for a single wallet.

​
success
boolean
Example:

true

​
statusCode
integer
Example:

200

​
message
string
Example:

"Data retrieved successfully"

​
data
object