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.

entityIdstringRequired

Entity ID or Entity ForeignID

paymentMethodIdstringRequired

Payment Method ID or Payment Method ForeignID

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.

1	{
2	"paymentMethodId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
3	"entityId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
4	"availableBalance": {
5	"amount": 100,
6	"currency": "USD"
7	},
8	"pendingBalance": {
9	"amount": 5,
10	"currency": "USD"
11	}
12	}

1	import { MercoaClient } from "@mercoa/javascript";
2
3	const client = new MercoaClient({ token: "YOUR_TOKEN" });
4	await client.entity.paymentMethod.wallet.getWalletBalance("ent_8545a84e-a45f-41bf-bdf1-33b42a55812c", "pm_4794d597-70dc-4fec-b6ec-c5988e759769");