fundingActivity

List funding balances

Changed on

Use this method to return a paginated 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.
get/funding-balance

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/funding-balance
  • Auth
    HTTP bearer

Query parameters

beforestring

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.

afterstring

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.

limitinteger

Limit the maximum number of results that we return for each page.

merchantIdstring

Filter results by the unique identifier that the processor assigned to the merchant.

Response

Successful request. Returns the funding balance available for each merchant.

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

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

hasMoreboolean

Indicates whether there is another page of results available.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id retrieveBalance removed and replaced with fundingActivity_retrieveBalance