Get wallet balance

Get the available and pending balance of this entity's wallet. The specified payment method ID must refer to the entity's wallet.

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID
paymentMethodIdstringRequired
Payment Method ID or Payment Method ForeignID

Response

This endpoint returns an object.
paymentMethodIdstring
The ID of the wallet payment method.
entityIdstring
The ID of the entity that this wallet belongs to.
availableBalanceobject
The available balance in this wallet.
pendingBalanceobject
The pending balance in this wallet.

Errors