Negative Balance Limit
List negative balance limits
Returns a cursor-paginated list of negative balance limits.
<p class="restricted-notice"><strong>Restricted</strong>: This endpoint is restricted to GoCardless Embed customers. Please [contact us](https://forms.gocardless.com/l/305971/2023-01-25/535t8n){:target="_blank"} if you are interested in using this product.</p>get/negative_balance_limits
Request
- Base URLhttps://api.gocardless.com
- AuthHTTP 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.
Number of records to return.
currency'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD'
ISO 4217 currency code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
Example:EUR
creditorstring
Unique identifier, beginning with "CR".
Example:CR123
Headers
GoCardless-Versionstring required
Response
Successful response
Example response
{
"negative_balance_limits": [
{
"id": "NBL123",
"created_at": "2014-01-01T12:00:00.000Z",
"balance_limit": 10000,
"currency": "EUR",
"links": {
"creator_user": "US123",
"creditor": "CR123"
}
}
],
"meta": {
"limit": 50
}
}Changes
No recorded changes to this operation across all 1 revision of this API.