Get Wallet

Returns one wallet with its live balances.

Use it before you act on a balance, for example before Charge Wallet. The balances are read at the moment of the request.

  • balance is what the holder can spend: depositUnsettled + depositSettled + customerCredited.
  • withdrawable is what the holder can withdraw to a payout method. It equals customerCredited.
  • Money a holder has asked to withdraw is not in any of these balances.

Requires the Wallet Management permission (see Invite Wallet Holder).

Errors

  • 404 NOT_FOUND: the wallet does not exist, or holderId is not its holder
  • 423 NOT_EDITABLE: the wallet's balances cannot be read. Do not treat the wallet as empty; contact Payment Labs support
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The holder's user ID, as returned by Search Wallets or Invite Wallet Holder.

string
required

The wallet ID, starting with W-, as returned by Search Wallets or Invite Wallet Holder.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json