v1

latestOpenAPI 3.0.12026-07-141671231.8 MB
Mandates

Send a GoCardless mandate email request

This endpoint allows you to send an email request for a GoCardless mandate to a recipient.

ℹ️ This endpoint requires the following scope: customer_mandates:all

post/api/external/v2/gocardless_mandates/mail_requests

Request body

customer_idinteger required

Customer identifier

Example request

{
  "customer_id": 42,
  "email": {
    "subject": "Please authorize your direct debit mandate",
    "body": "Please click the link to authorize your direct debit mandate.",
    "recipients": [
      "customer@example.com"
    ]
  }
}

Response

Mail request successfully created