EntityPayment Method

Get available balance

GET
https://api.mercoa.com/entity/:entityId/paymentMethod/:paymentMethodId/balance

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

entityId
string
paymentMethodId
string

Response

This endpoint return an object.
availableBalance
double
currency
enum
updatedAt
optional datetime

The time the balance was last updated. Will be null if the balance has never been updated.

GET
/entity/:entityId/paymentMethod/:paymentMethodId/balance
curl https://api.mercoa.com/entity/:entityId/paymentMethod/:paymentMethodId/balance \
-H "Authorization: Bearer <token>"
Response
{
"availableBalance": 1,
"currency": "AED",
"updatedAt": "2023-01-01T00:00:00Z"
}