Skip to main content

​
Wallets (External Dedicated Wallet)

Use the External Dedicated Wallet API to manage wallets for your users: create wallets, check balances, list wallets, and retrieve transaction statements. This supports payout flows and wallet-based operations.

Create wallet

API reference: create wallet

Wallet balance

API reference: wallet balance

Get wallets

API reference: get wallets

Wallet statement

API reference: wallet statement

​
API reference (Swagger)

All External Dedicated Wallet endpoints, request/response schemas, and try-it-out requests are in the Payvessel PMS Swagger: External Dedicated Wallet — Swagger Use the Swagger UI to:
  • See the exact path, method, and parameters for each operation
  • View request and response body schemas
  • Test calls with your sandbox credentials

​
Base URL and authentication

EnvironmentBase URL
Productionhttps://api.payvessel.com
Sandboxhttps://sandbox.payvessel.com
Authenticate with:
  • api-key — Your Payvessel public API key
  • api-secret — Bearer YOUR_SECRET_KEY
See API Basics — Authentication for details.

​
Common operations

OperationPurpose
Create walletRegister a new external dedicated wallet for a user or entity
Wallet balanceGet the current balance of a wallet
Get walletsList or fetch one or more wallets (e.g. by customer or business)
Wallet statementRetrieve transaction history or statement for a wallet
Details and example usage for each are in the linked pages above; for exact fields and responses, use the Swagger documentation.

​
Payouts and wallets

Wallet APIs are used together with Payouts (External Dedicated Wallet) to send money to wallets and to manage recipient wallets. For payout-specific flows (e.g. initiating a payout to a wallet), see the Payouts section and the same Swagger tag.

​
Next steps

Create wallet (API)

Endpoint, payload, code samples

Payouts

Payout guide

API reference

All endpoints and code samples