Skip to main content
GET
/
pms
/
api
/
external
/
request
/
wallet
/
get-or-create
Get Wallets
curl --request GET \
  --url https://api.payvessel.com/pms/api/external/request/wallet/get-or-create/ \
  --header 'api-key: <api-key>' \
  --header 'api-secret: <api-secret>'
{
  "status": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "business_id": "<string>",
    "wallet_name": "<string>",
    "account_number": "<string>",
    "account_name": "<string>",
    "bank_name": "<string>",
    "bank_code": "<string>",
    "currency": "<string>",
    "status": "<string>",
    "created_datetime": "2023-11-07T05:31:56Z",
    "balance": {
      "available_balance": "<string>",
      "ledger_balance": "<string>"
    }
  }
}

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 an existing wallet or create one automatically for the authenticated business. No request body is required.

​
Endpoint

GET /pms/api/external/request/wallet/get-or-create/

​
Headers

NameTypeRequiredDescription
api-keystringRequiredYour API key
api-secretstringRequiredYour API secret

​
Response

​
status
boolean
Request status.
​
message
string
Description of the result.
​
data
object

​
Example Request

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

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

Headers

​
api-key
string
required

Your Payvessel public API key

​
api-secret
string
required

Your Payvessel secret

Response

200 - application/json

Wallets retrieved successfully

​
status
boolean

Request status

​
message
string

Response message

​
data
object