Sign in
Payment Methods

Retrieve the balance of a bank account

Zuora supports Plaid's Auth and Balance products for ACH transactions. Auth authenticates account details before sending requests to the gateway, while Balance checks the real-time account balance before transactions. Use this API operation to implement the integration with Plaid Balance manually.

Before you use this API operation, ensure that the support for Plaid Auth and Balance is enabled. For more information, see <a href="https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/define-and-set-up-payment-methods" target="_blank">Enable the support for Plaid account validation solution</a>.

get/v1/payment-methods/{payment-method-id}/balance

Path parameters

payment-method-idstring uuid required

The unique ID of the payment method, such as 40289f3291d2587b0191d280fa20012g.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

successboolean

Indicates whether this call succeeds.

currencystring

The currency of the account balance.

availableBalancenumber double

The amount of funds available to be withdrawn from the account. For more information, see <a href="https://plaid.com/docs/api/products/balance/#accounts-balance-get-response-accounts-balances" target="_blank">Plaid's documentation</a>.

currentBalancenumber double

The total amount of funds in the account, which does not take pending transactions into account. For more information, see <a href="https://plaid.com/docs/api/products/balance/#accounts-balance-get-response-accounts-balances" target="_blank">Plaid's documentation</a>.

Changes