EntityPayment Method

Get available balance

Deprecated
GET
Get the available balance of a payment method. Only bank accounts added with Plaid are supported. This endpoint will return a cached value and will refresh the balance when called.

Path parameters

entityIdstringRequired
paymentMethodIdstringRequired

Response

This endpoint returns an object
availableBalance
double
currency
enum
status
enum
If the status is UNAVAILABLE, the account does not support this operation. If the status is ERROR, the account may need to be re-linked with Plaid.
Allowed values: AVAILABLEUNAVAILABLEERROR
updatedAt
datetimeOptional
The time the balance was last updated. Will be null if the balance has never been updated.
GET
1curl https://api.mercoa.com/entity/:entityId/paymentMethod/:paymentMethodId/balance \
2 -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "availableBalance": 1,
3 "currency": "AED",
4 "status": "AVAILABLE",
5 "updatedAt": "2023-01-01T00:00:00Z"
6}