VUZDevelopers

List mandates for a business

GET
/mandates

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

status?string

Filter by status

Value in

  • "draft"
  • "active"
  • "paused"
  • "completed"
  • "cancelled"
clientId?string

Filter by client ID

search?string

Case-insensitive client name search

minAmount?number

Minimum recurring amount

maxAmount?number

Maximum recurring amount

frequency?string

Filter by billing frequency

Value in

  • "weekly"
  • "monthly"
  • "yearly"
  • "custom_days"
cardBrand?string

Filter by card brand (e.g. Visa, Mastercard)

nextChargeFrom?string

Filter mandates with next charge on or after this date

nextChargeTo?string

Filter mandates with next charge on or before this date

nextChargeBefore?string

Filter mandates with next charge before this date (deprecated)

page?number

Page number

Range1 <= value
Default1
limit?number

Items per page

Range1 <= value <= 100
Default20

Response Body

curl -X GET "https://example.com/mandates"
Empty