PEpennylane
Mandates

Send a GoCardless mandate email request

Changed on

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

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/gocardless_mandates/mail_requests
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: customer_mandates:all

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

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

Changes