API Documentation

Get mandate information

get
https://apim.demo01.my.fivedegrees.cloud/publicapi-sbx/direct-debits/v1/mandates

API endpoint to get a selection of direct debit mandates.

Query Params
string

Identifier of the mandate.

string

Identifier of the processor that will process the payments of the mandate. This identifier has to be the same one that is known by the connector that is attached to the processor.

string

Identifier of the product.

boolean

If set to true, only active mandates will be returned.

int32

The number of the results that will be included in the response. This number must be greater than 0.

int32

The page number for the request. This number must be greater than 0.

Headers
string
required
Defaults to v1

API version

uuid
required
Defaults to 9f22c552-fb93-4b78-b9b1-f73d108d976f

Correlates HTTP requests between a client and server

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

500

Internal Server Error

503

Service Unavailable

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json

Updated about 2 months ago

Did this page help you?