Mandates

List mandates

Returns a paginated list of direct debit mandates for the user specified by their ID.

get/users/{user_id}/payments/mandates

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/users/{user_id}/payments/mandates
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: mandates:admin, mandates:read)

Query parameters

sort'id' | 'created_at'

Field of resource to sort by

order'ASC' | 'DESC'

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

limitinteger

Use the limit argument to specify the maximum number of items returned.

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Response

Mandates list

Changes

No recorded changes to this operation across all 25 revisions of this API.