List funding balances

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of funding balances available for each merchant linked to your account. Use query parameters to filter the list of results we return, for example, to search for the funding balance for a specific merchant. Our gateway returns the following information about each merchant in the list: - Total funds for the merchant. - Available funds that you can use for funding instructions. - Pending funds that we have not yet sent to funding accounts.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query Parameters

beforestringOptional

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstringOptional

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.
merchantIdstringOptional
Filter results by the unique identifier that the processor assigned to the merchant.

Response

Successful request. Returns the funding balance available for each merchant.
datalist of objects
Array of merchantBalance objects.
countdouble or null

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean or null
Indicates whether there is another page of results available.
limitdouble or null
Maximum number of results that we return for each page.

Errors