> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payvessel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Wallets

> List or retrieve managed wallets for your business

**Get an existing wallet or create one automatically** for the authenticated business. No request body is required.

## Endpoint

<Badge variant="success">**GET**</Badge> `/pms/api/external/request/wallet/get-or-create/`

## Response

<ResponseField name="status" type="boolean">
  Request status.
</ResponseField>

<ResponseField name="message" type="string">
  Description of the result.
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="Wallet Object">
    <ResponseField name="id" type="string">
      Unique wallet ID.
    </ResponseField>

    <ResponseField name="business_id" type="string">
      Business identifier.
    </ResponseField>

    <ResponseField name="wallet_name" type="string">
      Wallet name.
    </ResponseField>

    <ResponseField name="account_number" type="string">
      Wallet account number.
    </ResponseField>

    <ResponseField name="account_name" type="string">
      Wallet account name.
    </ResponseField>

    <ResponseField name="bank_name" type="string">
      Settlement bank name.
    </ResponseField>

    <ResponseField name="bank_code" type="string">
      Settlement bank code.
    </ResponseField>

    <ResponseField name="currency" type="string">
      Wallet currency.
    </ResponseField>

    <ResponseField name="status" type="string">
      Wallet status.
    </ResponseField>

    <ResponseField name="created_datetime" type="string">
      Wallet creation timestamp.
    </ResponseField>

    <ResponseField name="balance.available_balance" type="string">
      Available balance.
    </ResponseField>

    <ResponseField name="balance.ledger_balance" type="string">
      Ledger balance.
    </ResponseField>
  </Expandable>
</ResponseField>

## Example Request

```bash theme={null}
curl -X GET "https://api.payvessel.com/pms/api/external/request/wallet/get-or-create/" \
  -H "api-key: YOUR_API_KEY" \
  -H "api-secret: YOUR_SECRET"
```

## Example Response

```json theme={null}
{
  "status": true,
  "message": "string",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "wallet_name": "string",
    "account_number": "string",
    "account_name": "string",
    "bank_name": "string",
    "bank_code": "string",
    "currency": "string",
    "status": "string",
    "created_datetime": "2026-05-07T12:06:43.830Z",
    "balance": {
      "available_balance": "806856696425.66",
      "ledger_balance": ""
    }
  }
}
```


## OpenAPI

````yaml GET /pms/api/external/request/wallet/get-or-create/
openapi: 3.1.0
info:
  title: PayVessel API
  description: >-
    PayVessel API for accepting payments, sending money, verifying identities,
    and managing wallets
  version: 1.0.0
servers:
  - url: https://api.payvessel.com
  - url: https://sandbox.payvessel.com
security:
  - {}
paths:
  /pms/api/external/request/wallet/get-or-create/:
    get:
      tags:
        - Wallets
      summary: Get Wallets
      description: Get existing wallet or create a new one for the authenticated business
      parameters:
        - name: api-key
          in: header
          description: Your Payvessel public API key
          required: true
          schema:
            type: string
        - name: api-secret
          in: header
          description: Your Payvessel secret
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Wallets retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWalletsResponse'
components:
  schemas:
    GetWalletsResponse:
      type: object
      properties:
        status:
          type: boolean
          description: Request status
        message:
          type: string
          description: Response message
        data:
          type: object
          properties:
            id:
              type: string
              description: Unique wallet ID
            business_id:
              type: string
              description: Business identifier
            wallet_name:
              type: string
              description: Wallet display name
            account_number:
              type: string
              description: Wallet account number
            account_name:
              type: string
              description: Wallet account name
            bank_name:
              type: string
              description: Settlement bank name
            bank_code:
              type: string
              description: Settlement bank code
            currency:
              type: string
              description: Wallet currency
            status:
              type: string
              description: Wallet status
            created_datetime:
              type: string
              format: date-time
              description: Wallet creation timestamp
            balance:
              type: object
              properties:
                available_balance:
                  type: string
                  description: Available balance
                ledger_balance:
                  type: string
                  description: Ledger balance

````