Get available balance (deprecated)

Deprecated
GET

Deprecated. 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

Entity ID or Entity ForeignID

paymentMethodIdstringRequired

Payment Method ID or Payment Method ForeignID

Response

This endpoint returns an object.
availableBalancedouble
currencyenum
statusenum
Allowed values: AVAILABLEUNAVAILABLEERROR

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.

updatedAtdatetimeOptional

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

Get All
Built with