Get a list of site payment mandates

get/site-payment-mandates
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
siteId
integer <int64> (IdParam) >= 1

Filter by site id

Example: siteId=1
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "redirectURL": "string",
    • "flowToken": "string",
    • "siteId": 1,
    • "returnURL": "string",
    • "mandateReference": "string",
    • "exitURL": "string"
    }
]