GOgocardless
Balance

List balances

Returns a cursor-paginated list of balances for a given creditor. This endpoint is rate limited to 60 requests per minute.

get/balances

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

creditorstring required
Example:CR123

ID of a creditor.

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "balances": [
    {
      "balance_type": "confirmed_funds",
      "currency": "EUR",
      "last_updated_at": "2014-01-01T12:00:00.000Z",
      "links": {
        "creditor": "CR123"
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.