Create a new site payment mandate

post/site-payment-mandates
SecuritybearerAuth
Request
Request Body schema: application/json

New site payment mandate

redirectURL
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

URL to the site payment provider to give to end users

siteId
required
integer <int64>

Site identifier

returnURL
required
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

URL the payment provider will redirect the browser to at the end of their data collection process

exitURL
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

URL to an alternative payment page when payment provider unavailable

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

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